encoders

package

v0.0.0-...-431bcb6 Latest Latest Go to latest Published: Apr 25, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sourcegraph/log

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

View Source

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,
}

View Source

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL