log

README

Log

Usage

package main

import (
	"context"
	"errors"
	"fmt"

	"github.com/infiniteloopcloud/log"
)

const (
	CorrelationID log.ContextField = "correlation_id"
)

func main() {
	// Set this globally
	log.SetLevel(log.LevelToUint())
	log.SetLoggableFields([]fmt.Stringer{CorrelationID})
	 
	ctx := context.Background()
	ctx = context.WithValue(ctx, CorrelationID, "123456")
	log.Error(ctx, errors.New(""), "")
	log.Errorf(ctx, errors.New(""), "test: %s", "test")
	log.Warn(ctx, "")
	log.Info(ctx, "")
	log.Debug(ctx, "")
	// etc...
}

Documentation

Index

• Constants
• Variables
• func AppendLoggableFields(l fmt.Stringer)
• func Debug(ctx context.Context, msg string)
• func Debugf(ctx context.Context, format string, args ...interface{})
• func Error(ctx context.Context, err error, msg string)
• func Errorf(ctx context.Context, err error, format string, args ...interface{})
• func GetLoggableFields() []fmt.Stringer
• func Info(ctx context.Context, msg string)
• func Infof(ctx context.Context, format string, args ...interface{})
• func LevelToUint() uint8
• func Parse(ctx context.Context, scopeLevel string, msg string, err error, fields ...Field) string
• func PreHookSetLogLevel(_ context.Context)
• func SetLevel(l uint8)
• func SetLevelEnvironmentVariable(l string)
• func SetLoggableFields(custom []fmt.Stringer)
• func Trace(ctx context.Context, msg string)
• func Warn(ctx context.Context, msg string)
• func Warnf(ctx context.Context, format string, args ...interface{})
• type ContextField
  • func (c ContextField) String() string
• type Field

Constants

const (
	ErrorLevelString = "error"
	WarnLevelString  = "warn"
	InfoLevelString  = "info"
	DebugLevelString = "debug"
)

const (
	ErrorLevel uint8 = iota
	WarnLevel
	InfoLevel
	TraceLevel
	DebugLevel
)

Variables

var LevelEnvironmentVariable = "LOG_LEVEL"

LevelEnvironmentVariable get the level of logging

Functions

func AppendLoggableFields

func AppendLoggableFields(l fmt.Stringer)

func Debug

func Debug(ctx context.Context, msg string)

func Debugf

func Debugf(ctx context.Context, format string, args ...interface{})

func Error

func Error(ctx context.Context, err error, msg string)

func Errorf

func Errorf(ctx context.Context, err error, format string, args ...interface{})

func GetLoggableFields

func GetLoggableFields() []fmt.Stringer

func Info

func Info(ctx context.Context, msg string)

func Infof

func Infof(ctx context.Context, format string, args ...interface{})

func LevelToUint

func LevelToUint() uint8

func Parse

func Parse(ctx context.Context, scopeLevel string, msg string, err error, fields ...Field) string

func PreHookSetLogLevel

func PreHookSetLogLevel(_ context.Context)

func SetLevel

func SetLevel(l uint8)

func SetLevelEnvironmentVariable

func SetLevelEnvironmentVariable(l string)

func SetLoggableFields

func SetLoggableFields(custom []fmt.Stringer)

func Trace

func Trace(ctx context.Context, msg string)

func Warn

func Warn(ctx context.Context, msg string)

func Warnf

func Warnf(ctx context.Context, format string, args ...interface{})

Types

type ContextField

type ContextField string

const (
	TracingTime   ContextField = "tracing_time"
	UserID        ContextField = "user_id"
	ClientHost    ContextField = "client_host"
	CorrelationID ContextField = "correlation_id"
	HTTPPath      ContextField = "http_path"
)

func (ContextField) String

func (c ContextField) String() string

type Field

type Field struct {
	Key   string
	Value string
}