logging

Documentation

Index

• Constants
• Variables
• func IsDebugOrHigher() bool
• func LogLevel() string
• func LogOutput() (logOutput io.Writer, err error)
• func NewTransport(name string, t http.RoundTripper) *transport
• func SetOutput()
• func SetTestOutput(t testing.T)

Constants

const (
	EnvLog     = "TF_LOG"      // Set to True
	EnvLogFile = "TF_LOG_PATH" // Set to a file
)

These are the environmental variables that determine if we log, and if we log whether or not the log should go to a file.

Variables

var ValidLevels = []logutils.LogLevel{"TRACE", "DEBUG", "INFO", "WARN", "ERROR"}

Functions

func IsDebugOrHigher

func IsDebugOrHigher() bool

IsDebugOrHigher returns whether or not the current log level is debug or trace

func LogLevel

func LogLevel() string

LogLevel returns the current log level string based the environment vars

func LogOutput

func LogOutput() (logOutput io.Writer, err error)

LogOutput determines where we should send logs (if anywhere) and the log level.

func NewTransport

func NewTransport(name string, t http.RoundTripper) *transport

func SetOutput

func SetOutput()

SetOutput checks for a log destination with LogOutput, and calls log.SetOutput with the result. If LogOutput returns nil, SetOutput uses ioutil.Discard. Any error from LogOutout is fatal.

func SetTestOutput

func SetTestOutput(t testing.T)

SetTestOutput is equivalent to SetOutput, but declares itself a test helper so it doesn't show up as the source of errors when testing.