cLog

Documentation

Index

• Constants
• Variables
• func Level(level logrus.Level)
• func SetCallerSkip(skip int)
• func WithContext(ctx *gin.Context, params map[string]any) *logrus.Entry
• type EmptyWriter
  • func NewEmptyWriter() *EmptyWriter
  • func (e EmptyWriter) Write(p []byte) (n int, err error)
• type FileHook
  • func NewFileHook() *FileHook
  • func (i *FileHook) Fire(entry *logrus.Entry) error
  • func (i *FileHook) Levels() []logrus.Level
• type LogComponent
  • func (i *LogComponent) Inject(instance any) bool
  • func (i *LogComponent) InjectConf(config cComponents.ConfigInterface) bool
  • func (i *LogComponent) Listen() []*cComponents.ConfigListener
  • func (i *LogComponent) Load()
• type LogConf
  • func (i *LogConf) ConfigName() string
• type LogConf_Clients
• type LogConf_FileClient
• type LogConf_FileClient_Rotation
• type LogConf_LokiClient
• type LogDriver
• type LokiHook
  • func NewLokiHook() *LokiHook
  • func (i *LokiHook) Fire(entry *logrus.Entry) error
  • func (i *LokiHook) Levels() []logrus.Level
• type LokiReq
• type LokiReq_Stream
• type RotationType
• type StdoutHook
  • func NewStdoutHook() *StdoutHook
  • func (i *StdoutHook) Fire(entry *logrus.Entry) error
  • func (i *StdoutHook) Levels() []logrus.Level

Constants

const (
	LogConfigName = "LogConf"

	LOG_DRIVER_STDOUT LogDriver = "stdout"
	LOG_DRIVER_FILE   LogDriver = "file"
	LOG_DRIVER_LOKI   LogDriver = "loki"

	ROTATION_TYPE_MINUTE RotationType = "minute"
	ROTATION_TYPE_HOUR   RotationType = "hour"
	ROTATION_TYPE_DAY    RotationType = "day"
	ROTATION_TYPE_MONTH  RotationType = "month"
	ROTATION_TYPE_YEAR   RotationType = "year"

	LOG_FIELD_LEVEL    string = "level"
	LOG_FIELD_PARAMS   string = "params"
	LOG_FIELD_MESSAGE  string = "message"
	LOG_FIELD_DATETIME string = "datetime"
	LOG_FIELD_REPORTER string = "reporter"
)

const (
	PanicLevel logrus.Level = iota
	FatalLevel
	ErrorLevel
	WarnLevel
	InfoLevel
	DebugLevel
	TraceLevel
)

Variables

var Component = &LogComponent{}

Functions

func Level

func Level(level logrus.Level)

func SetCallerSkip

func SetCallerSkip(skip int)

func WithContext

func WithContext(ctx *gin.Context, params map[string]any) *logrus.Entry

Types

type EmptyWriter

type EmptyWriter struct{}

func NewEmptyWriter

func NewEmptyWriter() *EmptyWriter

func (EmptyWriter) Write

func (e EmptyWriter) Write(p []byte) (n int, err error)

type FileHook

type FileHook struct{}

func NewFileHook

func NewFileHook() *FileHook

func (*FileHook) Fire

func (i *FileHook) Fire(entry *logrus.Entry) error

func (*FileHook) Levels

func (i *FileHook) Levels() []logrus.Level

type LogComponent

type LogComponent struct{}

func (*LogComponent) Inject

func (i *LogComponent) Inject(instance any) bool

func (*LogComponent) InjectConf

func (i *LogComponent) InjectConf(config cComponents.ConfigInterface) bool

func (*LogComponent) Listen

func (i *LogComponent) Listen() []*cComponents.ConfigListener

func (*LogComponent) Load

func (i *LogComponent) Load()

type LogConf

type LogConf struct {
	Level      logrus.Level     `json:"level"`
	Drivers    []LogDriver      `json:"drivers"`
	WithFields map[string]any   `json:"with_fields"`
	Excludes   []string         `json:"excludes"`
	Clients    *LogConf_Clients `json:"clients"`
}

func (*LogConf) ConfigName

func (i *LogConf) ConfigName() string

type LogConf_Clients

type LogConf_Clients struct {
	File *LogConf_FileClient `json:"file"`
	Loki *LogConf_LokiClient `json:"loki"`
}

type LogConf_FileClient

type LogConf_FileClient struct {
	Path     string                       `json:"path"`
	Rotation *LogConf_FileClient_Rotation `json:"rotation"`
}

type LogConf_FileClient_Rotation

type LogConf_FileClient_Rotation struct {
	Enable  bool         `json:"enable"`
	Type    RotationType `json:"type"`
	MaxFile int64        `json:"max_file"`
	MaxSize int64        `json:"max_size"`
}

type LogConf_LokiClient

type LogConf_LokiClient struct {
	Host         string `json:"host"`
	Uri          string `json:"uri"`
	QueueMaxSize int    `json:"queue_max_size"`
	QueueSpeed   int    `json:"queue_speed"`
	Timeout      int    `json:"timeout"`
	Interval     int    `json:"interval"`
}

type LogDriver

type LogDriver string

type LokiHook

type LokiHook struct {
	Host     string
	Uri      string
	Queue    []*logrus.Entry
	MaxSize  int
	Speed    int
	Timeout  int64
	Interval int64
}

func NewLokiHook

func NewLokiHook() *LokiHook

func (*LokiHook) Fire

func (i *LokiHook) Fire(entry *logrus.Entry) error

func (*LokiHook) Levels

func (i *LokiHook) Levels() []logrus.Level

type LokiReq

type LokiReq struct {
	Streams []*LokiReq_Stream `json:"streams"`
}

type LokiReq_Stream

type LokiReq_Stream struct {
	Stream map[string]string `json:"stream"`
	Values [][2]string       `json:"values"`
}

type RotationType

type RotationType string

type StdoutHook

type StdoutHook struct{}

func NewStdoutHook

func NewStdoutHook() *StdoutHook

func (*StdoutHook) Fire

func (i *StdoutHook) Fire(entry *logrus.Entry) error

func (*StdoutHook) Levels

func (i *StdoutHook) Levels() []logrus.Level