loggers

loggers

import "github.com/go-coldbrew/log/loggers"

Package loggers provides loggers implementation for log package

Index

• Constants
• Variables
• func AddToLogContext(ctx context.Context, key string, value interface{}) context.Context
• func FetchCallerInfo(skip int, depth int) (function string, file string, line int)
• type BaseLogger
• type Level
  • func ParseLevel(lvl string) (Level, error)
  • func (level Level) String() string
• type LogFields
  • func FromContext(ctx context.Context) *LogFields
  • func (o *LogFields) Add(key string, value interface{})
  • func (o *LogFields) Del(key string)
• type Option
  • func WithCallerFieldName(name string) Option
  • func WithCallerFileDepth(depth int) Option
  • func WithCallerInfo(callerInfo bool) Option
  • func WithJSONLogs(json bool) Option
  • func WithLevelFieldName(name string) Option
  • func WithReplaceStdLogger(replaceStdLogger bool) Option
  • func WithTimestampFieldName(name string) Option
• type Options
  • func GetDefaultOptions() Options

Constants

These are the different logging levels. You can set the logging level to log on your instance of logger, obtained with `logs.New()`.

const (
    // ErrorLevel level. Logs. Used for errors that should definitely be noted.
    // Commonly used for hooks to send errors to an error tracking service.
    ErrorLevel = iota
    // WarnLevel level. Non-critical entries that deserve eyes.
    WarnLevel
    // InfoLevel level. General operational entries about what's going on inside the
    // application.
    InfoLevel
    // DebugLevel level. Usually only enabled when debugging. Very verbose logging.
    DebugLevel
)

Variables

AllLevels A constant exposing all logging levels

var AllLevels = []Level{
    ErrorLevel,
    WarnLevel,
    InfoLevel,
    DebugLevel,
}

DefaultOptions stores all default options in loggers package These options are used by all loggers

var (
    DefaultOptions = Options{
        ReplaceStdLogger:   false,
        JSONLogs:           true,
        Level:              InfoLevel,
        TimestampFieldName: "@timestamp",
        LevelFieldName:     "level",
        CallerInfo:         true,
        CallerFileDepth:    2,
        CallerFieldName:    "caller",
    }
)

func AddToLogContext

func AddToLogContext(ctx context.Context, key string, value interface{}) context.Context

AddToLogContext adds log fields to context. Any info added here will be added to all logs using this context

func FetchCallerInfo

func FetchCallerInfo(skip int, depth int) (function string, file string, line int)

FetchCallerInfo fetches function name, file name and line number from stack skip is the number of stack frames to ascend, with 0 identifying the caller of FetchCallerInfo. depth is the depth of file to use in caller info

type BaseLogger

BaseLogger is the interface that needs to be implemented by client loggers

type BaseLogger interface {
    // Log logs a message at the given level. The args are key-value pairs.
    // The key must be a string, while the value can be of any type.
    // The message is logged with the given level.
    // Level is the level of the log message.
    // Skip is the number of stack frames to skip before getting the file name and line number.
    // If skip is 0, the file and line of the caller of Log is logged.
    // ctx is the context of the log message. It is used to pass the context fields to the logger
    Log(ctx context.Context, level Level, skip int, args ...interface{})
    // SetLevel sets the level of the logger
    SetLevel(level Level)
    // GetLevel gets the level of the logger
    GetLevel() Level
}

type Level

Level type

type Level uint32

func ParseLevel

func ParseLevel(lvl string) (Level, error)

ParseLevel takes a string level and returns the log level constant.

func (Level) String

func (level Level) String() string

Convert the Level to a string. E.g. ErrorLevel becomes "error".

type LogFields

LogFields contains all fields that have to be added to logs

type LogFields struct {
    sync.Map
}

func FromContext

func FromContext(ctx context.Context) *LogFields

FromContext fetchs log fields from provided context

func (*LogFields) Add

func (o *LogFields) Add(key string, value interface{})

Add or modify log fields

func (*LogFields) Del

func (o *LogFields) Del(key string)

Del deletes a log field entry

type Option

Option defines an option for BaseLogger

type Option func(*Options)

func WithCallerFieldName

func WithCallerFieldName(name string) Option

WithCallerFieldName sets the name of callerinfo field

func WithCallerFileDepth

func WithCallerFileDepth(depth int) Option

WithCallerFileDepth sets the depth of file to use in caller info

func WithCallerInfo

func WithCallerInfo(callerInfo bool) Option

WithCallerInfo enables/disables adding caller info to logs

func WithJSONLogs

func WithJSONLogs(json bool) Option

WithJSONLogs enables/disables json logs

func WithLevelFieldName

func WithLevelFieldName(name string) Option

WithLevelFieldName sets the name of the level field in logs

func WithReplaceStdLogger

func WithReplaceStdLogger(replaceStdLogger bool) Option

WithReplaceStdLogger enables/disables replacing std logger

func WithTimestampFieldName

func WithTimestampFieldName(name string) Option

WithTimestampFieldName sets the name of the time stamp field in logs

type Options

Options contain all common options for BaseLoggers

type Options struct {
    // ReplaceStdLogger replaces std logger with this logger
    ReplaceStdLogger bool
    // JSONLogs enables/disables json logs
    JSONLogs bool
    // Level is the level of the logger
    Level Level
    // TimestampFieldName is the name of the timestamp field in logs
    TimestampFieldName string
    // LevelFieldName is the name of the level field in logs
    LevelFieldName string
    // CallerInfo enables/disables adding caller info to logs
    CallerInfo bool
    // CallerFileDepth is the depth of file to use in caller info
    CallerFileDepth int
    // CallerFieldName is the name of callerinfo field
    CallerFieldName string
}

func GetDefaultOptions

func GetDefaultOptions() Options

GetDefaultOptions fetches loggers default options

Generated by gomarkdoc