klog

package module
v0.3.1-0...-77124af Latest Latest
Warning

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

Go to latest
Published: Nov 5, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

README

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.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ClampLevel

func ClampLevel(l Level)

ClampLevel clamps the leveled logging at the specified value. It must be called prior any call to klog.

func Error

func Error(args ...interface{})

func ErrorDepth

func ErrorDepth(depth int, args ...interface{})

func Errorf

func Errorf(format string, args ...interface{})

func Errorln

func Errorln(args ...interface{})

func Exit

func Exit(args ...interface{})

func ExitDepth

func ExitDepth(depth int, args ...interface{})

func Exitf

func Exitf(format string, args ...interface{})

func Exitln

func Exitln(args ...interface{})

func Fatal

func Fatal(args ...interface{})

func FatalDepth

func FatalDepth(depth int, args ...interface{})

func Fatalf

func Fatalf(format string, args ...interface{})

func Fatalln

func Fatalln(args ...interface{})

func Info

func Info(args ...interface{})

func InfoDepth

func InfoDepth(depth int, args ...interface{})

func Infof

func Infof(format string, args ...interface{})

func Infoln

func Infoln(args ...interface{})

func SetLogger

func SetLogger(l log.Logger)

SetLogger redirects klog logging to the given logger. It must be called prior any call to klog.

func Warning

func Warning(args ...interface{})

func WarningDepth

func WarningDepth(depth int, args ...interface{})

func Warningf

func Warningf(format string, args ...interface{})

func Warningln

func Warningln(args ...interface{})

Types

type Level

type Level int32

type Verbose

type Verbose bool

func V

func V(level Level) Verbose

func (Verbose) Info

func (v Verbose) Info(args ...interface{})

func (Verbose) Infof

func (v Verbose) Infof(format string, args ...interface{})

func (Verbose) Infoln

func (v Verbose) Infoln(args ...interface{})

Jump to

Keyboard shortcuts

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