encoders

Documentation

Index

• Variables
• func BuildEncoder(format output.Format, development bool) (enc zapcore.Encoder)
• type ErrorEncoder
  • func (l *ErrorEncoder) Error() string
• type FieldsObjectEncoder
  • func (fields FieldsObjectEncoder) MarshalLogObject(enc zapcore.ObjectEncoder) error
• type ResourceEncoder
  • func (r *ResourceEncoder) MarshalLogObject(enc zapcore.ObjectEncoder) error
• type TraceContextEncoder
  • func (t *TraceContextEncoder) MarshalLogObject(enc zapcore.ObjectEncoder) error

Variables

var GCPConfig = zapcore.EncoderConfig{
	NameKey: "InstrumentationScope",

	TimeKey:    "timestampNanos",
	EncodeTime: zapcore.EpochNanosTimeEncoder,

	LevelKey:    "severity",
	EncodeLevel: zapcore.CapitalLevelEncoder,

	MessageKey: "message",

	CallerKey:     "Caller",
	FunctionKey:   "Function",
	StacktraceKey: "Stacktrace",

	LineEnding:     zapcore.DefaultLineEnding,
	EncodeDuration: zapcore.SecondsDurationEncoder,
	EncodeCaller:   zapcore.ShortCallerEncoder,
}

var OpenTelemetryConfig = zapcore.EncoderConfig{

	NameKey: "InstrumentationScope",

	TimeKey:    "Timestamp",
	EncodeTime: zapcore.EpochNanosTimeEncoder,

	LevelKey:    "SeverityText",
	EncodeLevel: zapcore.CapitalLevelEncoder,

	MessageKey: "Body",

	CallerKey:     "Caller",
	FunctionKey:   "Function",
	StacktraceKey: "Stacktrace",

	LineEnding:     zapcore.DefaultLineEnding,
	EncodeDuration: zapcore.SecondsDurationEncoder,
	EncodeCaller:   zapcore.ShortCallerEncoder,
}

OpenTelemetryConfig configures Zap to comply with the OT logs spec: https://opentelemetry.io/docs/reference/specification/logs/data-model/

For what we want output to look like in production, see: https://opentelemetry.io/docs/reference/specification/logs/data-model/#example-log-records

Functions

func BuildEncoder

func BuildEncoder(format output.Format, development bool) (enc zapcore.Encoder)

Types

type ErrorEncoder

type ErrorEncoder struct {
	Source error
}

func (*ErrorEncoder) Error

func (l *ErrorEncoder) Error() string

type FieldsObjectEncoder

type FieldsObjectEncoder []zapcore.Field

func (FieldsObjectEncoder) MarshalLogObject

func (fields FieldsObjectEncoder) MarshalLogObject(enc zapcore.ObjectEncoder) error

type ResourceEncoder

type ResourceEncoder struct {
	otelfields.Resource
}

func (*ResourceEncoder) MarshalLogObject

func (r *ResourceEncoder) MarshalLogObject(enc zapcore.ObjectEncoder) error

type TraceContextEncoder

type TraceContextEncoder struct{ otelfields.TraceContext }

func (*TraceContextEncoder) MarshalLogObject

func (t *TraceContextEncoder) MarshalLogObject(enc zapcore.ObjectEncoder) error