log

package
v1.17.0-rc.0 Latest Latest
Warning

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

Go to latest
Published: Apr 25, 2024 License: Apache-2.0 Imports: 15 Imported by: 123

Documentation

Index

Constants

View Source
const (
	HeaderPropagationStringForRequestLogging string = "x-http-header-forwarding-logging"
)

Variables

View Source
var (
	// Logger is a shared go-kit logger.
	// TODO: Change all components to take a non-global logger via their constructors.
	// Prefer accepting a non-global logger as an argument.
	Logger = log.NewNopLogger()
)

Functions

func CheckFatal

func CheckFatal(location string, err error)

CheckFatal prints an error and exits with error code 1 if err is non-nil

func ContextWithHeaderMap added in v1.14.0

func ContextWithHeaderMap(ctx context.Context, headerMap map[string]string) context.Context

func ContextWithHeaderMapFromMetadata added in v1.14.0

func ContextWithHeaderMapFromMetadata(ctx context.Context, md metadata.MD) context.Context

func ExtractSampledTraceID added in v1.17.0

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

ExtractSampledTraceID gets traceID and whether the trace is samples or not.

func HeaderMapFromContext added in v1.14.0

func HeaderMapFromContext(ctx context.Context) map[string]string

func InitLogger

func InitLogger(cfg *server.Config)

InitLogger initialises the global gokit logger (util_log.Logger) and overrides the default logger for the server.

func InjectHeadersIntoHTTPRequest added in v1.14.0

func InjectHeadersIntoHTTPRequest(headerMap map[string]string, request *http.Request)

InjectHeadersIntoHTTPRequest injects the logging header map from the context into the request headers.

func LevelFilter added in v1.11.0

func LevelFilter(l string) level.Option

TODO(dannyk): remove once weaveworks/common updates to go-kit/log

-> we can then revert to using Level.Gokit

func NewPrometheusLogger

func NewPrometheusLogger(l logging.Level, format logging.Format) (log.Logger, error)

NewPrometheusLogger creates a new instance of PrometheusLogger which exposes Prometheus counters for various log levels.

func WarnExperimentalUse

func WarnExperimentalUse(feature string)

WarnExperimentalUse logs a warning and increments the experimental features metric.

func WithContext

func WithContext(ctx context.Context, l log.Logger) log.Logger

WithContext returns a Logger that has information about the current user in its details.

e.g.

log := util.WithContext(ctx)
log.Errorf("Could not chunk chunks: %v", err)

func WithSourceIPs

func WithSourceIPs(sourceIPs string, l log.Logger) log.Logger

WithSourceIPs returns a Logger that has information about the source IPs in its details.

func WithTraceID

func WithTraceID(traceID string, l log.Logger) log.Logger

WithTraceID returns a Logger that has information about the traceID in its details.

func WithUserID

func WithUserID(userID string, l log.Logger) log.Logger

WithUserID returns a Logger that has information about the current user in its details.

Types

type PrometheusLogger

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

PrometheusLogger exposes Prometheus counters for each of go-kit's log levels.

func (*PrometheusLogger) Log

func (pl *PrometheusLogger) Log(kv ...interface{}) error

Log increments the appropriate Prometheus counter depending on the log level.

Jump to

Keyboard shortcuts

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