Simple Go event logger that mimics the built in Go Logger. Events can be recorded with prepopulated tags and metadata, or formatted at the time they are written. This package is meant to be extremely basic but offer some handy functionality for event logging, particularly for consumption by Splunk.
go get -u github.com/digicert/digilog
import "github.com/digicert/digilog"
Setting the environment variable LOG_LEVEL will determine what level is written to the log. In your source code, you can use any of the following log levels: DEBUG, INFO, WARN, ERROR, CRITICAL. The default logging level is INFO.
By default, digilog writes logs to both stdout and stderr. This can be overridden by creating a BuffOut struct where Out and Err are set to io.Writer instances where the logs should be written.
In your own application, logs can be written as such:
log := digilog.New()
log.Info("my_event_name", "othervar=123", "yetothervar=234")
// outputs 2020-01-29T14:01:51-07:00 [INFO] event_id=my_event_name othervar=123 yetothervar=234
log.Infof("my_event_name", "othervar=%s yetothervar=%s", "123", "234")
// outputs 2020-01-29T14:01:51-07:00 [INFO] event_id=my_event_name othervar=123 yetothervar=234
To override the writer:
log := digilog.New()
log.SetOutput(&digilog.BuffOut{Out: fileWriter, Err: errFileWriter})
log.Info("my_event_name", "othervar=123", "yetothervar=234")
// outputs 2020-01-29T14:01:51-07:00 [INFO] event_id=my_event_name othervar=123 yetothervar=234 to fileWriter
To prepopulate tags or metadata (tags are permanent fixtures on every future log, metadata is ephemeral data that is flushed once it has been logged):
log := digilog.New()
log.AddTags(map[string]interface{}{
"tag": "value",
})
log.AddTag("tag2", "value")
log.AddMeta("meta_tag", "meta_value")
log.Info("my_event_name")
// outputs 2020-01-29T14:01:51-07:00 [INFO] event_id=my_event_name tag="value" tag2="value" meta_tag="meta_value"
log.Info("my_event_name")
// outputs 2020-01-29T14:01:51-07:00 [INFO] event_id=my_event_name tag="value" tag2="value"
2.0.2: Fixing bugs in the 2.0.0 release, adding more examples, and updating the README to be more accurate to how the library actually works.
2.0.0: Mimic golang standard logger package using a Log struct and an output buffer. Is not a drop in replacement for Go Logger.
1.2.0: Standardized funcs to mimic go's standard. If using Sprintf formatting, use the f suffixed method (Debugf, Infof, etc). Otherwise use the old methods
1.1.0: Updated Critical to behave like log.Panic accepting an err object instead of a string.
1.0.0: Initial release.