logger

package

v0.9.0 Latest Latest Go to latest Published: Mar 16, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/intel/pmem-csi

Links

Open Source Insights

Documentation ¶

Overview ¶

Package logger defines an interface for adding a structured logger to a context and retrieving it again. The fallback when a context doesn't have a logger is the global klog logger.

This uses the same context key as logr and thus is compatible with code that uses that interface. The difference is that the Get function here never returns nil.

Also contains an extension of klog.KObj which includes the type of the object in the log output.

Index ¶

func Get(ctx context.Context) logr.Logger
func Set(ctx context.Context, logger logr.Logger) context.Context
type ObjectRefWithType
- func KObjWithType(obj klog.KMetadata) ObjectRefWithType
- func (ref ObjectRefWithType) String() string
type Options
- func NewFlag() *Options
- func (f *Options) Set(value string) error
- func (f *Options) String() string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Get ¶

func Get(ctx context.Context) logr.Logger

Get returns the structured logger stored in the context or (if not set) a klog based logger.

func Set ¶

func Set(ctx context.Context, logger logr.Logger) context.Context

Set returns a context with the given structured logger added to the given context.

Types ¶

type ObjectRefWithType ¶

type ObjectRefWithType struct {
	klog.ObjectRef
	Type string `json:"type,omitempty"`
}

ObjectRef references a kubernetes object

func KObjWithType ¶

func KObjWithType(obj klog.KMetadata) ObjectRefWithType

KObj returns ObjectRefWithType from ObjectMeta

func (ObjectRefWithType) String ¶

func (ref ObjectRefWithType) String() string

type Options ¶

type Options struct {
	logs.Options
}

Options is a wrapper around Options which makes it usable with flags.Var.

func NewFlag ¶

func NewFlag() *Options

func (*Options) Set ¶

func (f *Options) Set(value string) error

func (*Options) String ¶

func (f *Options) String() string

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
testinglogger Package testinglogger contains an implementation of the logr interface which is logging through a function like testing.TB.Log function.	Package testinglogger contains an implementation of the logr interface which is logging through a function like testing.TB.Log function.

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