This is a small library that you can add to your Go project to generate a ShiViz-compatible vector-clock timestamped log of events in your distributed system.

PLEASE NOTE: GoVec is compatible with Go 1.4 +

• govec/: Contains the Library and all its dependencies
• test.go: A small program to test the library
• example-Log.txt: An example log generated by the library

type GoLog

• func Initialize(string ProcessName, string LogName) *GoLog
• func InitializeMutipleExecutions(string ProcessName, string LogName) *GoLog
• func PrepareSend(string LogMessage, byte[] b) (byte[] output)
• func UnpackReceive(string LogMessage, byte[] b) (byte[] output)
• func LogLocalEvent(string LogMessage)
• func DisableLogging()

Add the govec folder to your project and import it with:

"import ./govec"

type GoLog struct{
	// contains filtered or unexported fields
}

The GoLog struct provides an interface to creating and maintaining vector timestamp entries in the generated log file

func Initialize(string ProcessName, string LogName) *GoLog

Returns a Go Log Struct taking in two arguments and truncates previous logs:

• MyProcessName (string): local process name; must be unique in your distributed system.
• LogFileName (string) : name of the log file that will store info. Any old log with the same name will be truncated

func Initialize(string ProcessName, string LogName) *GoLog

Returns a Go Log Struct taking in two arguments without truncating previous log entry:

• MyProcessName (string): local process name; must be unique in your distributed system.
• LogFileName (string) : name of the log file that will store info. Each run will append to log file seperated by "=== Execution # ==="

func PrepareSend(string LogMessage, byte[] b) (byte[] output)

Logs LogMessage and vector timestamp into log file, and packs incoming byte[] b and vector timestamp as a GOB. Returns a byte[] output that can be sent on wire.

func UnpackReceive(string LogMessage, byte[] b) (byte[] output)

Unpacks incoming byte[] b from GOB and logs LogMessage with received vector timestamp. Returns byte[] output which can be used for further processing by the program.

func LogLocalEvent(string LogMessage)

Increments current vector timestamp and logs it into Log File.

func DisableLogging()

Disables Logging. Log messages will not appear in Log file any longer. Note: For the moment, the vector clocks are going to continue being updated.

The following is a basic example of how this library can be used

package main

import "./govec"

func main() {
	Logger := govec.Initialize("MyProcess", "LogFile")
	
	//In Sending Process
	
	//Prepare a Message
	messagepayload := []byte("samplepayload")
	finalsend := Logger.PrepareSend("Sending Message", messagepayload)
	
	//send message
	//connection.Write(finalsend)

	//In Receiving Process
	
	//receive message
	recbuf := Logger.UnpackReceive("Receiving Message", finalsend)

	//Can be called at any point 
	Logger.LogLocalEvent("Example Complete")
	
	Logger.DisableLogging()
	//No further events will be written to log file
}

This produces the log "LogFile.txt" :

MyProcess {"MyProcess":1}
Initialization Complete
MyProcess {"MyProcess":2}
Sending Message
MyProcess {"MyProcess":3}
Receiving Message
MyProcess {"MyProcess":4}
Example Complete