log

Documentation

Index

• Constants
• Variables
• type Component
  • func NewComponent() *Component
  • func (*Component) New(_ context.Context, conf *Config) (Logger, error)
  • func (*Component) Settings() *Config
• type Config
  • func (*Config) Name() string
• type LogFn
• type Logger
  • func Load(ctx context.Context, source settings.Source, c *Component) (Logger, error)
  • func New(ctx context.Context, source settings.Source) (Logger, error)

Constants

const (
	// OutputStdout sends logs to stdout.
	OutputStdout = "STDOUT"
	// OutputNull sends logs to /dev/null.
	OutputNull = "NULL"
)

Variables

var LoggerFromContext = logevent.FromContext

LoggerFromContext is the concrete implementation of LogFn that should be used at runtime.

Types

type Component

type Component struct{}

Component enables creating configured loggers.

func NewComponent

func NewComponent() *Component

NewComponent populates all the defaults.

func (*Component) New

func (*Component) New(_ context.Context, conf *Config) (Logger, error)

New creates a configured logger instance.

func (*Component) Settings

func (*Component) Settings() *Config

Settings generates a LoggerConfig with default values applied.

type Config

type Config struct {
	Level  string `description:"The minimum level of logs to emit. One of DEBUG, INFO, WARN, ERROR."`
	Output string `description:"Destination stream of the logs. One of STDOUT, NULL."`
}

Config contains all configuration values for creating a system logger.

func (*Config) Name

func (*Config) Name() string

Name of the configuration as it might appear in config files.

type LogFn

type LogFn func(context.Context) Logger

LogFn is the type that should be accepted by components that intend to log content using the context logger.

type Logger

type Logger = logevent.Logger

Logger is the project logging client interface. It is currently an alias to the logevent project.

func Load

func Load(ctx context.Context, source settings.Source, c *Component) (Logger, error)

Load is a convenience method for binding the source to the component.

func New

func New(ctx context.Context, source settings.Source) (Logger, error)

New is the top-level entry point for creating a new log client.