logger

Documentation

Index

• Constants
• Variables
• func ApplyOptionsToLoggers(options *Options) error
• func NewContext(ctx context.Context, logger Logger) context.Context
• type LogLevel
• type Logger
  • func FromContextOrDefault(ctx context.Context) Logger
  • func NewLogger(name string) Logger
• type Options
  • func DefaultOptions() Options
  • func (o *Options) AttachCmdFlags(stringVar func(p *string, name string, value string, usage string), ...)
  • func (o *Options) SetAppID(id string)
  • func (o *Options) SetOutputLevel(outputLevel string) error

Constants

const (
	// LogTypeLog is normal log type.
	LogTypeLog = "log"
	// LogTypeRequest is Request log type.
	LogTypeRequest = "request"
)

Variables

var DaprVersion = "unknown"

Functions

func ApplyOptionsToLoggers

func ApplyOptionsToLoggers(options *Options) error

ApplyOptionsToLoggers applys options to all registered loggers.

func NewContext

func NewContext(ctx context.Context, logger Logger) context.Context

NewContext returns a new Context, derived from ctx, which carries the provided Logger.

Types

type LogLevel

type LogLevel string

LogLevel is Dapr Logger Level type.

const (
	// DebugLevel has verbose message.
	DebugLevel LogLevel = "debug"
	// InfoLevel is default log level.
	InfoLevel LogLevel = "info"
	// WarnLevel is for logging messages about possible issues.
	WarnLevel LogLevel = "warn"
	// ErrorLevel is for logging errors.
	ErrorLevel LogLevel = "error"
	// FatalLevel is for logging fatal messages. The system shuts down after logging the message.
	FatalLevel LogLevel = "fatal"

	// UndefinedLevel is for undefined log level.
	UndefinedLevel LogLevel = "undefined"
)

type Logger

type Logger interface {
	// EnableJSONOutput enables JSON formatted output log
	EnableJSONOutput(enabled bool)

	// SetAppID sets dapr_id field in the log. Default value is empty string
	SetAppID(id string)

	// SetOutputLevel sets the log output level
	SetOutputLevel(outputLevel LogLevel)
	// SetOutput sets the destination for the logs
	SetOutput(dst io.Writer)

	// IsOutputLevelEnabled returns true if the logger will output this LogLevel.
	IsOutputLevelEnabled(level LogLevel) bool

	// WithLogType specifies the log_type field in log. Default value is LogTypeLog
	WithLogType(logType string) Logger

	// WithFields returns a logger with the added structured fields.
	WithFields(fields map[string]any) Logger

	// Info logs a message at level Info.
	Info(args ...interface{})
	// Infof logs a message at level Info.
	Infof(format string, args ...interface{})
	// Debug logs a message at level Debug.
	Debug(args ...interface{})
	// Debugf logs a message at level Debug.
	Debugf(format string, args ...interface{})
	// Warn logs a message at level Warn.
	Warn(args ...interface{})
	// Warnf logs a message at level Warn.
	Warnf(format string, args ...interface{})
	// Error logs a message at level Error.
	Error(args ...interface{})
	// Errorf logs a message at level Error.
	Errorf(format string, args ...interface{})
	// Fatal logs a message at level Fatal then the process will exit with status set to 1.
	Fatal(args ...interface{})
	// Fatalf logs a message at level Fatal then the process will exit with status set to 1.
	Fatalf(format string, args ...interface{})
}

Logger includes the logging api sets.

func FromContextOrDefault

func FromContextOrDefault(ctx context.Context) Logger

FromContextOrDiscard returns a Logger from ctx. If no Logger is found, this returns a Logger that discards all log messages.

func NewLogger

func NewLogger(name string) Logger

NewLogger creates new Logger instance.

type Options

type Options struct {

	// JSONFormatEnabled is the flag to enable JSON formatted log
	JSONFormatEnabled bool

	// OutputLevel is the level of logging
	OutputLevel string
	// contains filtered or unexported fields
}

Options defines the sets of options for Dapr logging.

func DefaultOptions

func DefaultOptions() Options

DefaultOptions returns default values of Options.

func (*Options) AttachCmdFlags

func (o *Options) AttachCmdFlags(
	stringVar func(p *string, name string, value string, usage string),
	boolVar func(p *bool, name string, value bool, usage string),
)

AttachCmdFlags attaches log options to command flags.

func (*Options) SetAppID

func (o *Options) SetAppID(id string)

SetAppID sets Application ID.

func (*Options) SetOutputLevel

func (o *Options) SetOutputLevel(outputLevel string) error

SetOutputLevel sets the log output level.