log

Documentation

Index

• Variables
• func FormatDuration(d time.Duration) string
• type Blackbox
• type Client
  • func NewClient(out io.Writer, l contract.Level, d Dependencies, opts ClientOptions) (Client, error)
• type ClientOption
  • func WithLevelKey(x Key) ClientOption
  • func WithMaxLen(x uint) ClientOption
  • func WithMessageKey(x Key) ClientOption
  • func WithTimeKey(x Key) ClientOption
• type ClientOptions
  • func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
• type DefaultTool
  • func NewTool(c Client) (*DefaultTool, error)
  • func (d *DefaultTool) GetComponent(skip int, withFullFn, withFile, withFilePath, withLine bool) string
  • func (d *DefaultTool) Log(ctx context.Context, l contract.Level, v any, prefix string, msg ...string)
  • func (d *DefaultTool) Wrap(ctx context.Context, fn func() (any, error)) error
  • func (d *DefaultTool) WrapHandler(h contract.HandlerFunc) contract.HandlerFunc
  • func (d *DefaultTool) WrapMiddleware(m contract.MiddlewareFunc) contract.MiddlewareFunc
• type Dependencies
• type Key
• type Tool

Variables

var (
	ErrComponentFailure  = errors.New("failed to get caller information")
	ErrJSONIndentFailure = errors.New("failed to indent data into JSON")
	ErrJSONUnmarshal     = errors.New("failed to unmarshal JSON")
	ErrFieldTruncation   = errors.New("some fields were truncated")
)

Functions

func FormatDuration

func FormatDuration(d time.Duration) string

FormatDuration dynamically chooses the best unit for logging.

Types

type Blackbox

type Blackbox interface {
	// contains filtered or unexported methods
}

type Client

type Client interface {
	Blackbox
	contract.LogOperator
	contract.ComponentExtractor
}

func NewClient

func NewClient(out io.Writer, l contract.Level, d Dependencies, opts ClientOptions) (Client, error)

type ClientOption

type ClientOption = contract.Opt[ClientOptions]

func WithLevelKey

func WithLevelKey(x Key) ClientOption

func WithMaxLen

func WithMaxLen(x uint) ClientOption

func WithMessageKey

func WithMessageKey(x Key) ClientOption

func WithTimeKey

func WithTimeKey(x Key) ClientOption

type ClientOptions

type ClientOptions struct {
	Keys   map[string]string
	MaxLen uint
}

func ApplyClientOptions

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool

type DefaultTool struct {
	Client Client
}

func NewTool

func NewTool(c Client) (*DefaultTool, error)

func (*DefaultTool) GetComponent

func (d *DefaultTool) GetComponent(skip int, withFullFn, withFile, withFilePath, withLine bool) string

GetComponent returns a component string.

func (*DefaultTool) Log

func (d *DefaultTool) Log(ctx context.Context, l contract.Level, v any, prefix string, msg ...string)

Log writes a log entry, but does nothing if Client is nil.

func (*DefaultTool) Wrap

func (d *DefaultTool) Wrap(ctx context.Context, fn func() (any, error)) error

Wrap wraps a function with logging, but skips logging if Client is nil.

func (*DefaultTool) WrapHandler

func (d *DefaultTool) WrapHandler(h contract.HandlerFunc) contract.HandlerFunc

WrapHandler wraps a handler with logging, but skips logging if Client is nil.

func (*DefaultTool) WrapMiddleware

func (d *DefaultTool) WrapMiddleware(m contract.MiddlewareFunc) contract.MiddlewareFunc

WrapMiddleware araps a middleware with logging, but skips logging if Client is nil.

type Dependencies

type Dependencies struct {
	M contract.Marshaler
	U contract.Unmarshaler
}

type Key

type Key = string

const (
	GoogleMessageKey   Key = "message"
	GoogleSeverityKey  Key = "severity"
	GoogleTimestampKey Key = "timestamp"
	GoogleComponentKey Key = "component"
)

type Tool

type Tool interface {
	contract.LogOperator
	contract.ComponentExtractor
}