prometheus/vendor/k8s.io/klog
Simon Pasquier 9bb3555fe4 cmd/prometheus: support k8s.io/klog/v2
Signed-off-by: Simon Pasquier <spasquie@redhat.com>
2020-10-06 14:56:14 +02:00
..
v2 cmd/prometheus: support k8s.io/klog/v2 2020-10-06 14:56:14 +02:00
.errcheck_excludes cmd/prometheus: support k8s.io/klog/v2 2020-10-06 14:56:14 +02:00
.golangci.yml cmd/prometheus: support k8s.io/klog/v2 2020-10-06 14:56:14 +02:00
LICENSE use klog dependency 2019-01-03 13:57:20 -08:00
README.md cmd/prometheus: support k8s.io/klog/v2 2020-10-06 14:56:14 +02:00
go.mod cmd/prometheus: support k8s.io/klog/v2 2020-10-06 14:56:14 +02:00
go.sum cmd/prometheus: support k8s.io/klog/v2 2020-10-06 14:56:14 +02:00
klog.go use klog dependency 2019-01-03 13:57:20 -08:00
renovate.json cmd/prometheus: support k8s.io/klog/v2 2020-10-06 14:56:14 +02:00

README.md

klog-gokit CircleCI

This package is a replacement for k8s.io/klog in projects that use the go-kit logger.

It also supports k8s.io/klog/v2.

It is heavily inspired by the github.com/kubermatic/glog-gokit package.

Usage

Override the official klog package with this one. This simply replaces the code in vendor/k8s.io/klog with the code of this package.

With dep

In your Gopkg.toml:

[[override]]
  name = "k8s.io/klog"
  source = "github.com/simonpasquier/klog-gokit"

With Go modules

Add this line to your go.mod file:

replace k8s.io/klog => github.com/simonpasquier/klog-gokit master

In your main.go:

// Import the package like it is original klog
import "k8s.io/klog"


// Create go-kit logger in your main.go
logger := log.NewLogfmtLogger(log.NewSyncWriter(os.Stdout))
logger = log.With(logger, "ts", log.DefaultTimestampUTC)
logger = log.With(logger, "caller", log.DefaultCaller)
logger = level.NewFilter(logger, level.AllowAll())

// Overriding the default klog with our go-kit klog implementation.
// Thus we need to pass it our go-kit logger object.
klog.SetLogger(logger)

Setting the logger to the klog package MUST happen before using klog in any package.

Function Levels

klog gokit
Info Debug
InfoDepth Debug
Infof Debug
Infoln Debug
Warning Warn
WarningDepth Warn
Warningf Warn
Warningln Warn
Error Error
ErrorDepth Error
Errorf Error
Errorln Error
Exit Error
ExitDepth Error
Exitf Error
Exitln Error
Fatal Error
FatalDepth Error
Fatalf Error
Fatalln Error

This table is rather opinionated and build for use with the Kubernetes' Go client.

Disclaimer

This project doesn't aim at covering the complete klog API. That being said, it should work ok for projects that use k8s.io/client-go (like Prometheus for instance).

License

Apache License 2.0, see LICENSE.