log

Documentation

Overview

Package log provides logging utilities for the tracer.

Index

• Constants
• func Debug(fmt string, a ...interface{})
• func DebugEnabled() bool
• func Error(format string, a ...interface{})
• func Flush()
• func Info(fmt string, a ...interface{})
• func SetLevel(lvl Level)
• func UseLogger(l Logger) (undo func())
• func Warn(fmt string, a ...interface{})
• type DiscardLogger
  • func (d DiscardLogger) Log(_ string)
• type Level
• type Logger
• type ManagedFile
  • func OpenFileAtPath(dirPath string) (*ManagedFile, error)
  • func (m *ManagedFile) Close() error
  • func (m *ManagedFile) Name() string
• type RecordLogger
  • func (r *RecordLogger) Ignore(substrings ...string)
  • func (r *RecordLogger) Log(msg string)
  • func (r *RecordLogger) Logs() []string
  • func (r *RecordLogger) Reset()

Constants

const LoggerFile = "ddtrace.log"

File name for writing tracer logs, if DD_TRACE_LOG_DIRECTORY has been configured

Functions

func Debug

func Debug(fmt string, a ...interface{})

Debug prints the given message if the level is LevelDebug.

func DebugEnabled

func DebugEnabled() bool

DebugEnabled returns true if debug log messages are enabled. This can be used in extremely hot code paths to avoid allocating the ...interface{} argument.

func Error

func Error(format string, a ...interface{})

Error reports an error. Errors get aggregated and logged periodically. The default is once per minute or once every DD_LOGGING_RATE number of seconds.

func Flush

func Flush()

Flush flushes and resets all aggregated errors to the logger.

func Info

func Info(fmt string, a ...interface{})

Info prints an informational message.

func SetLevel

func SetLevel(lvl Level)

SetLevel sets the given lvl for logging.

func UseLogger

func UseLogger(l Logger) (undo func())

UseLogger sets l as the active logger and returns a function to restore the previous logger. The return value is mostly useful when testing.

func Warn

func Warn(fmt string, a ...interface{})

Warn prints a warning message.

Types

type DiscardLogger

type DiscardLogger struct{}

DiscardLogger discards every call to Log().

func (DiscardLogger) Log

func (d DiscardLogger) Log(_ string)

Log implements Logger.

type Level

type Level int

Level specifies the logging level that the log package prints at.

const (
	// LevelDebug represents debug level messages.
	LevelDebug Level = iota
	// LevelWarn represents warning and errors.
	LevelWarn
)

type Logger

type Logger interface {
	// Log prints the given message.
	Log(msg string)
}

Logger implementations are able to log given messages that the tracer might output. This interface is duplicated here to avoid a cyclic dependency between this package and ddtrace

type ManagedFile

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

ManagedFile functions like a *os.File but is safe for concurrent use

func OpenFileAtPath

func OpenFileAtPath(dirPath string) (*ManagedFile, error)

OpenFileAtPath creates a new file at the specified dirPath and configures the logger to write to this file. The dirPath must already exist on the underlying os. It returns the file that was created, or nil and an error if the file creation was unsuccessful. The caller of OpenFileAtPath is responsible for calling Close() on the ManagedFile

func (*ManagedFile) Close

func (m *ManagedFile) Close() error

Close closes the ManagedFile's *os.File in a concurrent-safe manner, ensuring the file is closed only once

func (*ManagedFile) Name

func (m *ManagedFile) Name() string

type RecordLogger

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

RecordLogger records every call to Log() and makes it available via Logs().

func (*RecordLogger) Ignore

func (r *RecordLogger) Ignore(substrings ...string)

Ignore adds substrings to the ignore field of RecordLogger, allowing the RecordLogger to ignore attempts to log strings with certain substrings.

func (*RecordLogger) Log

func (r *RecordLogger) Log(msg string)

Log implements Logger.

func (*RecordLogger) Logs

func (r *RecordLogger) Logs() []string

Logs returns the ordered list of logs recorded by the logger.

func (*RecordLogger) Reset

func (r *RecordLogger) Reset()

Reset resets the logger's internal logs