Categoryk8s.io/klog/v2klogr
package
2.130.1
Repository: https://github.com/kubernetes/klog.git
Documentation: pkg.go.dev
Overview
Versions
3
Dependencies
8
Dependents
252
Files
171 SLOC

# README

Minimal Go logging using klog

This package implements the logr interface in terms of Kubernetes' klog. This provides a relatively minimalist API to logging in Go, backed by a well-proven implementation.

Because klogr was implemented before klog itself added supported for structured logging, the default in klogr is to serialize key/value pairs with JSON and log the result as text messages via klog. This does not work well when klog itself forwards output to a structured logger.

Therefore the recommended approach is to let klogr pass all log messages through to klog and deal with structured logging there. Just beware that the output of klog without a structured logger is meant to be human-readable, in contrast to the JSON-based traditional format.

This is a BETA grade implementation.

# Packages

No description provided by the author

# Functions

New returns a logr.Logger which serializes output itself and writes it via klog.
NewWithOptions returns a logr.Logger which serializes as determined by the WithFormat option and writes via klog.
WithFormat selects the output format.

# Constants

FormatKlog tells klogr to pass all text messages and key/value pairs directly to klog.
FormatSerialize tells klogr to turn key/value pairs into text itself before invoking klog.

# Type aliases

Format defines how log output is produced.
Option is a functional option that reconfigures the logger created with New.