log

package
v0.26.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 14, 2026 License: MIT Imports: 17 Imported by: 31

Documentation

Index

Constants

View Source 
const (
	// NumKey - generic number attribute
	NumKey = "num"
	// NameKey - generic name attribute
	NameKey = "name"
	// ValueKey - generic value attribute
	ValueKey = "value"
	// JSONKey - generic json attribute
	JSONKey = "json"
)
View Source 
const (
	// Deprecated: use semconv messaging attributes instead.
	CodeInstanceKey = "code_instance"
	// Deprecated: use semconv messaging attributes instead.
	CodePackageKey = "code_package"
	// Deprecated: use semconv messaging attributes instead.
	CodeMethodKey = "code_method"
	// Deprecated: use semconv messaging attributes instead.
	CodeLineKey = "code_line"
)
View Source 
const (
	// DurationKey - generic duration attribute
	DurationKey = "duration"
	// DurationSecKey - duration in seconds
	DurationSecKey = "duration_sec"
	// DurationMinKey - duration in minutes
	DurationMinKey = "duration_min"
	// DurationHourKey - duration in hours
	DurationHourKey = "duration_hour"
)
View Source 
const (
	ErrorTypeKey       = "error_type"
	ErrorMessageKey    = "error_message"
	ErrorStacktraceKey = "error_stacktrace"
)
View Source 
const (
	// Deprecated: use semconv messaging attributes instead.
	HTTPServerNameKey = "http_server_name"
	// Deprecated: use semconv messaging attributes instead.
	HTTPMethodKey = "http_method"
	// Deprecated: use semconv messaging attributes instead.
	HTTPTargetKey = "http_target"
	// Deprecated: use semconv messaging attributes instead.
	HTTPHostKey = "http_host"
	// Deprecated: use semconv messaging attributes instead.
	HTTPStatusCodeKey = "http_status_code"
	// Deprecated: use semconv messaging attributes instead.
	HTTPUserAgentKey = "http_user_agent"
	// Deprecated: use semconv messaging attributes instead.
	HTTPClientIPKey = "http_client_ip"
	// Deprecated: use semconv messaging attributes instead.
	HTTPRequestContentLengthKey = "http_read_bytes"
	// Deprecated: use semconv messaging attributes instead.
	HTTPWroteBytesKey = "http_wrote_bytes" // #nosec
	// Deprecated: use semconv messaging attributes instead.
	HTTPSchemeKey = "http_scheme"
	// Deprecated: use semconv messaging attributes instead.
	HTTPFlavorKey = "http_flavor"
	// Deprecated: use semconv messaging attributes instead.
	HTTPRequestIDKey = "http_request_id"
	// Deprecated: use semconv messaging attributes instead.
	HTTPSessionIDKey = "http_session_id"
	// Deprecated: use semconv messaging attributes instead.
	HTTPTrackingIDKey = "http_tracking_id"
	// Deprecated: use semconv messaging attributes instead.
	HTTPRefererKey = "http_referer"
)
View Source 
const (
	// Deprecated: use semconv messaging attributes instead.
	MessagingSystemKey = "messaging_system"
	// Deprecated: use semconv messaging attributes instead.
	MessagingDestinationKey = "messaging_destination"
	// Deprecated: use semconv messaging attributes instead.
	MessagingDestinationKindKey = "messaging_destination_kind"
	// Deprecated: use semconv messaging attributes instead.
	MessagingProtocolKey = "messaging_protocol"
	// Deprecated: use semconv messaging attributes instead.
	MessagingProtocolVersionKey = "messaging_protocol_version"
	// Deprecated: use semconv messaging attributes instead.
	MessagingURLKey = "messaging_url"
	// Deprecated: use semconv messaging attributes instead.
	MessagingMessageIDKey = "messaging_message_id"
	// Deprecated: use semconv messaging attributes instead.
	MessagingConversationIDKey = "messaging_conversation_id"
	// Deprecated: use semconv messaging attributes instead.
	MessagingMessagePayloadSizeBytesKey = "messaging_message_payload_size_bytes"
	// Deprecated: use semconv messaging attributes instead.
	MessagingMessagePayloadCompressedSizeBytesKey = "messaging_message_payload_compressed_size_bytes"
)
View Source 
const (
	// Deprecated: use semconv messaging attributes instead.
	NetHostIPKey = "net_host_ip"
	// Deprecated: use semconv messaging attributes instead.
	NetHostPortKey = "net_host_port"
)
View Source 
const (
	// Deprecated: use semconv messaging attributes instead.
	PeerServiceKey = "peer_service"
	// Deprecated: use semconv messaging attributes instead.
	ServiceTypeKey = "service_type"
	// Deprecated: use semconv messaging attributes instead.
	ServiceNameKey = "service_name"
	// Deprecated: use semconv messaging attributes instead.
	ServiceMethodKey = "service_method"
	// Deprecated: use semconv messaging attributes instead.
	ServiceNamespaceKey = "service_namespace"
	// Deprecated: use semconv messaging attributes instead.
	ServiceInstanceIDKey = "service_instance.id"
	// Deprecated: use semconv messaging attributes instead.
	ServiceVersionKey = "service_version"
)
View Source 
const (
	// Deprecated: use semconv messaging attributes instead.
	StreamQueueKey = "queue"
	// Deprecated: use semconv messaging attributes instead.
	StreamSubjectKey = "subject"
)
View Source 
const (
	SpanID  = "span_id"
	TraceID = "trace_id"
)

Variables

This section is empty.

Functions

func AtomicLevel added in v0.1.15 

func AtomicLevel() zap.AtomicLevel

AtomicLevel return the configured atomic level

func Attribute added in v0.22.0 

func Attribute(attr attribute.KeyValue) zap.Field

func AttributeKey added in v0.22.0 

func AttributeKey(key attribute.Key) string

func Attributes added in v0.22.0 

func Attributes(attrs ...attribute.KeyValue) []zap.Field

func FCodeInstance deprecated added in v0.10.0 

func FCodeInstance(v string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FCodeLine deprecated added in v0.10.0 

func FCodeLine(v int) zap.Field

Deprecated: use semconv messaging attributes instead.

func FCodeMethod deprecated added in v0.10.0 

func FCodeMethod(v string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FCodePackage deprecated added in v0.10.20 

func FCodePackage(v string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FDuration 

func FDuration(duration time.Duration) zap.Field

FDuration creates a zap.Field with a given time.Duration converted to milliseconds under the key "duration".

func FDurationFn added in v0.10.0 

func FDurationFn() func() zap.Field

FDurationFn returns a function that returns a zap.Field with a given time.Duration converted to milliseconds under the key "duration".

func FDurationHour added in v0.10.0 

func FDurationHour(duration time.Duration) zap.Field

FDurationHour creates a zap.Field with a given time.Duration converted to hours under the key "duration_hour".

func FDurationMin added in v0.10.0 

func FDurationMin(duration time.Duration) zap.Field

FDurationMin creates a zap.Field with a given time.Duration converted to minutes under the key "duration_min".

func FDurationSec added in v0.10.0 

func FDurationSec(duration time.Duration) zap.Field

FDurationSec creates a zap.Field with a given time.Duration converted to seconds under the key "duration_sec".

func FError 

func FError(err error) zap.Field

func FErrorType 

func FErrorType(err error) zap.Field

func FHTTPClientIP deprecated 

func FHTTPClientIP(clientIP string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPFlavor deprecated 

func FHTTPFlavor(flavor string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPHost deprecated 

func FHTTPHost(host string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPMethod deprecated 

func FHTTPMethod(name string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPReferer deprecated added in v0.14.1 

func FHTTPReferer(host string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPRequestContentLength deprecated 

func FHTTPRequestContentLength(bytes int64) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPRequestID deprecated 

func FHTTPRequestID(id string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPScheme deprecated 

func FHTTPScheme(scheme string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPServerName deprecated added in v0.2.0 

func FHTTPServerName(id string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPSessionID deprecated added in v0.2.0 

func FHTTPSessionID(id string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPStatusCode deprecated 

func FHTTPStatusCode(status int) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPTarget deprecated 

func FHTTPTarget(target string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPTrackingID deprecated added in v0.11.3 

func FHTTPTrackingID(id string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPUserAgent deprecated 

func FHTTPUserAgent(userAgent string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FHTTPWroteBytes deprecated 

func FHTTPWroteBytes(bytes int64) zap.Field

Deprecated: use semconv messaging attributes instead.

func FJSON added in v0.12.0 

func FJSON(v any) zap.Field

FJSON creates a zap.Field with a given value under the key "json".

func FMessagingConversationID deprecated added in v0.2.0 

func FMessagingConversationID(value string) zap.Field

Deprecated: use semconv.MessagingMessageConversationID instead.

func FMessagingDestination deprecated added in v0.2.0 

func FMessagingDestination(value string) zap.Field

Deprecated: use semconv.MessagingDestinationName instead.

func FMessagingDestinationKind deprecated added in v0.2.0 

func FMessagingDestinationKind(value MessagingDestinationKind) zap.Field

Deprecated: use semconv messaging attributes instead.

func FMessagingMessageID deprecated added in v0.2.0 

func FMessagingMessageID(value string) zap.Field

Deprecated: use semconv.MessagingMessageID instead.

func FMessagingMessagePayloadCompressedSizeBytes deprecated added in v0.2.0 

func FMessagingMessagePayloadCompressedSizeBytes(value string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FMessagingMessagePayloadSizeBytes deprecated added in v0.2.0 

func FMessagingMessagePayloadSizeBytes(value string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FMessagingProtocol deprecated added in v0.2.0 

func FMessagingProtocol(value string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FMessagingProtocolVersion deprecated added in v0.2.0 

func FMessagingProtocolVersion(value string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FMessagingSystem deprecated added in v0.2.0 

func FMessagingSystem(value string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FMessagingURL deprecated added in v0.2.0 

func FMessagingURL(value string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FName 

func FName(name string) zap.Field

FName creates a zap.Field with a given string under the key "name".

func FNetHostIP deprecated 

func FNetHostIP(ip string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FNetHostPort deprecated 

func FNetHostPort(port string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FNum 

func FNum(num int) zap.Field

FNum creates a zap.Field with a given number under the key "num".

func FPeerService deprecated 

func FPeerService(name string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FServiceInstanceID deprecated 

func FServiceInstanceID(id string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FServiceMethod deprecated 

func FServiceMethod(method string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FServiceName deprecated 

func FServiceName(name string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FServiceNamespace deprecated 

func FServiceNamespace(namespace string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FServiceType deprecated added in v0.17.0 

func FServiceType(name string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FServiceVersion deprecated 

func FServiceVersion(version string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FSpanID added in v0.16.1 

func FSpanID(traceID string) zap.Field

func FStackSkip 

func FStackSkip(skip int) zap.Field

func FStreamQueue deprecated added in v0.5.0 

func FStreamQueue(queue string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FStreamSubject deprecated added in v0.5.0 

func FStreamSubject(name string) zap.Field

Deprecated: use semconv messaging attributes instead.

func FTraceID 

func FTraceID(traceID string) zap.Field

func FValue 

func FValue(value any) zap.Field

FValue creates a zap.Field with a given value under the key "value".

func IsDisableCaller added in v0.1.15 

func IsDisableCaller() bool

IsDisableCaller returns the configured disabled caller value

func IsDisableStacktrace added in v0.1.15 

func IsDisableStacktrace() bool

IsDisableStacktrace returns the configured disabled stacktrace value

func Logger 

func Logger() *zap.Logger

Logger return the logger instance

func Must 

func Must(l *zap.Logger, err error, msgAndArgs ...any)

Must logs a fatal error if given

func NewLogger added in v0.18.0 

func NewLogger(level, encoding string) *zap.Logger

NewLogger return a new logger instance

func SetDisableCaller added in v0.1.15 

func SetDisableCaller(value bool) error

SetDisableCaller sets the given value and re-configures the logger

func SetDisableStacktrace added in v0.1.15 

func SetDisableStacktrace(value bool) error

SetDisableStacktrace sets the given value and re-configures the logger

func With added in v0.2.4 

func With(l *zap.Logger, fields ...zap.Field) *zap.Logger

func WithAttributes added in v0.17.0 

func WithAttributes(l *zap.Logger, attrs ...attribute.KeyValue) *zap.Logger

func WithError 

func WithError(l *zap.Logger, err error) *zap.Logger

func WithHTTPClientIP added in v0.11.6 

func WithHTTPClientIP(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPFlavor added in v0.11.6 

func WithHTTPFlavor(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPHost added in v0.11.6 

func WithHTTPHost(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPReferer added in v0.14.1 

func WithHTTPReferer(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPRequest 

func WithHTTPRequest(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPRequestID added in v0.11.6 

func WithHTTPRequestID(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPRequestOut added in v0.6.0 

func WithHTTPRequestOut(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPScheme added in v0.11.6 

func WithHTTPScheme(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPServerName added in v0.2.0 

func WithHTTPServerName(l *zap.Logger, name string) *zap.Logger

func WithHTTPSessionID added in v0.11.6 

func WithHTTPSessionID(l *zap.Logger, r *http.Request) *zap.Logger

func WithHTTPTrackingID added in v0.11.6 

func WithHTTPTrackingID(l *zap.Logger, r *http.Request) *zap.Logger

func WithServiceName 

func WithServiceName(l *zap.Logger, name string) *zap.Logger

func WithTraceID 

func WithTraceID(l *zap.Logger, ctx context.Context) *zap.Logger

Types

type Config 

type Config struct {
	// contains filtered or unexported fields
}

func Configure 

func Configure(l *zap.Logger) *Config

func (*Config) Error 

func (c *Config) Error(err error) *Config

func (*Config) HTTPRequest 

func (c *Config) HTTPRequest(r *http.Request) *Config

func (*Config) Logger 

func (c *Config) Logger() *zap.Logger

func (*Config) With 

func (c *Config) With(fields ...zap.Field) *Config

type Labeler added in v0.14.0 

type Labeler struct {
	// contains filtered or unexported fields
}

func InjectLabeler added in v0.14.0 

func InjectLabeler(ctx context.Context, key LabelerContextKey) (context.Context, *Labeler)

func LabelerFromContext added in v0.14.0 

func LabelerFromContext(ctx context.Context, key LabelerContextKey) (*Labeler, bool)

func (*Labeler) Add added in v0.14.0 

func (l *Labeler) Add(fields ...zap.Field)

Add attributes to a Labeler.

func (*Labeler) Get added in v0.14.0 

func (l *Labeler) Get() []zap.Field

Get returns a copy of the attributes added to the Labeler.

type LabelerContextKey added in v0.14.0 

type LabelerContextKey string

type MessagingDestinationKind deprecated added in v0.2.0 

type MessagingDestinationKind string

Deprecated: use semconv messaging attributes instead. 

const (
	// Deprecated: use semconv messaging attributes instead.
	MessagingDestinationKindQueue MessagingDestinationKind = "queue"
	// Deprecated: use semconv messaging attributes instead.
	MessagingDestinationKindTopic MessagingDestinationKind = "topic"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.