logger

package
v0.0.0-...-3aeadc2 Latest Latest
Warning

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

Go to latest
Published: Apr 28, 2026 License: Apache-2.0 Imports: 21 Imported by: 60

Documentation

Index

Constants

View Source
const HealthCheckRoute = "/grpc.health.v1.Health/Check"

Variables

This section is empty.

Functions

func ContextWithEdgeTraceID

func ContextWithEdgeTraceID(ctx context.Context, edgeTraceID string) context.Context

func GRPCLogger

func GRPCLogger(l Logger) logging.Logger

func GetConsoleEncoderConfig

func GetConsoleEncoderConfig() zapcore.EncoderConfig

func GetEdgeTraceID

func GetEdgeTraceID(ctx context.Context) (string, bool)

func GetOTELCore

func GetOTELCore(provider log.LoggerProvider, serviceName string) zapcore.Core

func NewHTTPWriter

func NewHTTPWriter(ctx context.Context, endpoint string) zapcore.WriteSyncer

func ProxyRequestFields

func ProxyRequestFields(r *http.Request, sandboxID string, sandboxPort uint64) []zap.Field

ProxyRequestFields returns the common logger fields for a proxied HTTP request.

func ReplaceGlobals

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

func Time

func Time(key string, val time.Time) zap.Field

Time returns a zap.Field that logs the given time as both an RFC3339Nano string (key) and a unix epoch in nanoseconds (key_unix).

func WithBuildID

func WithBuildID(buildID string) zap.Field

func WithClientIP

func WithClientIP(clientIP string) zap.Field

func WithClusterID

func WithClusterID(clusterID uuid.UUID) zap.Field

func WithEdgeTraceID

func WithEdgeTraceID(traceID string) zap.Field

func WithEnvdVersion

func WithEnvdVersion(envdVersion string) zap.Field

func WithExecutionID

func WithExecutionID(executionID string) zap.Field

func WithFirecrackerVersion

func WithFirecrackerVersion(firecrackerVersion string) zap.Field

func WithKernelVersion

func WithKernelVersion(kernelVersion string) zap.Field

func WithLifecycleID

func WithLifecycleID(lifecycleID string) zap.Field

func WithMaskedAPIKey

func WithMaskedAPIKey(maskedAPIKey string) zap.Field

func WithMaskedAccessToken

func WithMaskedAccessToken(maskedAccessToken string) zap.Field

func WithNodeID

func WithNodeID(nodeID string) zap.Field

func WithSandboxID

func WithSandboxID(sandboxID string) zap.Field

func WithSandboxIP

func WithSandboxIP(sandboxIP string) zap.Field

func WithServiceInstanceID

func WithServiceInstanceID(instanceID string) zap.Field

func WithTeamID

func WithTeamID(teamID string) zap.Field

func WithTemplateID

func WithTemplateID(templateID string) zap.Field

func WithUserID

func WithUserID(userID string) zap.Field

func WithoutHealthCheck

func WithoutHealthCheck() selector.Matcher

func WithoutRoutes

func WithoutRoutes(routes ...string) selector.Matcher

Types

type HTTPWriter

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

func (*HTTPWriter) Sync

func (h *HTTPWriter) Sync() error

func (*HTTPWriter) Write

func (h *HTTPWriter) Write(source []byte) (n int, err error)

type Logger

type Logger = *TracedLogger

func NewDevelopmentLogger

func NewDevelopmentLogger() (Logger, error)

func NewLogger

func NewLogger(loggerConfig LoggerConfig) (Logger, error)

func NewTracedLogger

func NewTracedLogger(innerLogger *zap.Logger) Logger

func NewTracedLoggerFromCore

func NewTracedLoggerFromCore(core zapcore.Core) Logger

type LoggerConfig

type LoggerConfig struct {
	// ServiceName is the name of the service that the logger is being created for.
	// The service name is added to every log entry.
	ServiceName string
	// IsInternal differentiates between our (internal) logs, and user accessible (external) logs.
	IsInternal bool
	// IsDebug enables debug level logging, otherwise zap.InfoLevel level is used.
	IsDebug bool
	// DisableStacktrace disables stacktraces for the logger.
	DisableStacktrace bool

	// InitialFields fields that are added to every log entry.
	InitialFields []zap.Field
	// Cores additional processing cores for the logger.
	Cores []zapcore.Core
	// EnableConsole enables console logging.
	EnableConsole bool

	// Encoding sets the logger's encoding. If empty, defaults to "console".
	Encoding string
	// EncoderConfig optionally overrides the default encoder config.
	// If the encoding is set to "console," it defaults to GetConsoleEncoderConfig(); otherwise, it needs to be specified.
	EncoderConfig *zapcore.EncoderConfig
}

type TracedLogger

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

func L

func L() *TracedLogger

func NewNopLogger

func NewNopLogger() *TracedLogger

func (*TracedLogger) Debug

func (t *TracedLogger) Debug(ctx context.Context, msg string, fields ...zap.Field)

func (*TracedLogger) Detach

func (t *TracedLogger) Detach(ctx context.Context) *zap.Logger

func (*TracedLogger) Error

func (t *TracedLogger) Error(ctx context.Context, msg string, fields ...zap.Field)

func (*TracedLogger) Fatal

func (t *TracedLogger) Fatal(ctx context.Context, msg string, fields ...zap.Field)

func (*TracedLogger) Info

func (t *TracedLogger) Info(ctx context.Context, msg string, fields ...zap.Field)

func (*TracedLogger) Log

func (t *TracedLogger) Log(ctx context.Context, lvl zapcore.Level, msg string, fields ...zap.Field)

func (*TracedLogger) Panic

func (t *TracedLogger) Panic(ctx context.Context, msg string, fields ...zap.Field)

func (*TracedLogger) Sync

func (t *TracedLogger) Sync() error

func (*TracedLogger) Warn

func (t *TracedLogger) Warn(ctx context.Context, msg string, fields ...zap.Field)

func (*TracedLogger) With

func (t *TracedLogger) With(fields ...zap.Field) Logger

func (*TracedLogger) WithOptions

func (t *TracedLogger) WithOptions(opts ...zap.Option) Logger

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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