NewOptions is an alias for NewLoggingConfiguration.
var NewOptions = logsapi.NewLoggingConfiguration
func AddFlags(fs *pflag.FlagSet, opts ...Option)
AddFlags registers this package's flags on arbitrary FlagSets. This includes the klog flags, with the original underscore as separator between. If commands want hyphens as separators, they can set k8s.io/component-base/cli/flag/WordSepNormalizeFunc as normalization function on the flag set before calling AddFlags.
May be called more than once.
func AddGoFlags(fs *flag.FlagSet, opts ...Option)
AddGoFlags is a variant of AddFlags for traditional Go flag.FlagSet. Commands should use pflag whenever possible for the sake of consistency. Cases where this function is needed include tests (they have to set up flags in flag.CommandLine) and commands that for historic reasons use Go flag.Parse and cannot change to pflag because it would break their command line interface.
func FlushLogs()
FlushLogs flushes logs immediately. This should be called at the end of the main function via defer to ensure that all pending log messages are printed before exiting the program.
func GlogSetter(val string) (string, error)
GlogSetter modifies the verbosity threshold for the entire program. Some components have HTTP-based APIs for invoking this at runtime.
func InitLogs()
InitLogs initializes logs the way we want for Kubernetes. It should be called after parsing flags. If called before that, it will use the default log settings.
InitLogs disables support for contextual logging in klog while that Kubernetes feature is not considered stable yet. Commands which want to support contextual logging can:
func NewLogger(prefix string) *log.Logger
NewLogger creates a new log.Logger which sends logs to klog.Info.
KlogWriter serves as a bridge between the standard log package and the glog package.
type KlogWriter struct{}
func (writer KlogWriter) Write(data []byte) (n int, err error)
Write implements the io.Writer interface.
type Option func(*addFlagsOptions)
func SkipLoggingConfigurationFlags() Option
SkipLoggingConfigurationFlags must be used as option for AddFlags when the program also uses a LoggingConfiguration struct for configuring logging. Then only flags not covered by that get added.
Options is an alias for LoggingConfiguration to comply with component-base conventions.
type Options = logsapi.LoggingConfiguration
| Name | Synopsis |
|---|---|
| .. | |
| api | |
| v1 | The LoggingAlphaOptions and LoggingBetaOptions feature gates control whether these unstable features can get enabled. |
| datapol | Package datapol contains functions to determine if objects contain sensitive data to e.g. |
| example | Package example shows how a library uses contextual logging. |
| cmd | |
| stdlib | |
| json | |
| register | |
| klogflags | |
| kube-log-runner | |
| logreduction | |
| testinit | Package testinit adds logging flags to a Ginkgo or Go test program during initialization, something that the logs package itself no longer does. |