common

Documentation

Index

• Constants
• func ModuleLogEntry(log *logrus.Logger, moduleName string) *logrus.Entry
• func ModuleLogEntryWithID(log *logrus.Logger, moduleName string) *logrus.Entry
• func NextGlobalID() string

Constants

const (
	FieldNameModule = "module"
	FieldNameID     = "id"
)

Field name constants for the field names used on the logger entry.

Functions

func ModuleLogEntry

func ModuleLogEntry(log *logrus.Logger, moduleName string) *logrus.Entry

ModuleLogEntry creates a new logrus entry that includes the module name as a field.

func ModuleLogEntryWithID

func ModuleLogEntryWithID(log *logrus.Logger, moduleName string) *logrus.Entry

ModuleLogEntryWithID creates a new logrus entry that includes both the module name and a global id as keys. This is useful when multiple instances of the same module will be running as the id can then be used to keep track of each module instance.

func NextGlobalID

func NextGlobalID() string

NextGlobalID returns the next value of a global id counter, shared between any caller to this method. The returned id is returned as a base36 string.