History

rubyist 5c63da0b76 update tracerx to add timestamps		2017-09-27 12:35:46 -04:00
..
LICENSE	vendor: vendor dependencies in vendor/ using Glide	2016-05-23 12:10:35 -06:00
README.md	vendor: vendor dependencies in vendor/ using Glide	2016-05-23 12:10:35 -06:00
tracerx.go	update tracerx to add timestamps	2017-09-27 12:35:46 -04:00

README.md

tracerx

Tracerx is a simple tracing package that logs messages depending on environment variables. It is very much inspired by git's GIT_TRACE mechanism.

Installation

  go get github.com/rubyist/tracerx

Example

tracerx.DefaultKey = "FOO"
tracerx.Printf("send message")

tracerx.PrintfKey("BAR", "do a thing")

t := time.Now()
// Do some stuff
tracerx.PerformanceSince("BAR", "command x", t)

This example will send tracing output based on the environment variables FOO_TRACE and BAR_TRACE.

The values control where the tracing is output as follows:

unset, 0, or "false":   no output
1, 2:                   stderr
absolute path:          output will be written to the file
3 - 10:                 output will be written to that file descriptor

If an associated BAR_TRACE_PERFORMANCE is set to 1 or "true", the PerformanceSince line will output timing information.

Keys can also be disabled. See the GoDoc for full API documentation.

Bugs, Issues, Feedback

Right here on GitHub: https://github.com/rubyist/tracerx