log

Documentation

Index

• Constants
• Variables
• func AdaptAdoptedResource(log logr.Logger, res *v1alpha1.AdoptedResource, ...) logr.Logger
• func AdaptFieldExport(log logr.Logger, res *v1alpha1.FieldExport, additionalValues ...interface{}) logr.Logger
• func AdaptResource(log logr.Logger, res acktypes.AWSResource, additionalValues ...interface{}) logr.Logger
• func DebugAdoptedResource(log logr.Logger, res *v1alpha1.AdoptedResource, msg string, ...)
• func DebugFieldExport(log logr.Logger, res *v1alpha1.FieldExport, msg string, ...)
• func DebugResource(log logr.Logger, res acktypes.AWSResource, msg string, ...)
• func FromContext(ctx context.Context) acktypes.Logger
• func InfoAdoptedResource(log logr.Logger, res *v1alpha1.AdoptedResource, msg string, ...)
• func InfoFieldExport(log logr.Logger, res *v1alpha1.FieldExport, msg string, ...)
• func InfoResource(log logr.Logger, res acktypes.AWSResource, msg string, ...)
• type ResourceLogger
  • func NewResourceLogger(log logr.Logger, res acktypes.AWSResource, additionalValues ...interface{}) *ResourceLogger
  • func (rl *ResourceLogger) Debug(msg string, additionalValues ...interface{})
  • func (rl *ResourceLogger) Enter(name string, additionalValues ...interface{})
  • func (rl *ResourceLogger) Exit(name string, err error, additionalValues ...interface{})
  • func (rl *ResourceLogger) Info(msg string, additionalValues ...interface{})
  • func (rl *ResourceLogger) IsDebugEnabled() bool
  • func (rl *ResourceLogger) Trace(name string, additionalValues ...interface{}) acktypes.TraceExiter
  • func (rl *ResourceLogger) WithValues(values ...interface{})

Constants

const (
	// ContextKey is the string key used to store a logger in a Context
	ContextKey = "ack.logger"
)

Variables

var (
	// NoopLogger is useful for testing/mocking
	NoopLogger acktypes.Logger = &voidLogger{}
)

Functions

func AdaptAdoptedResource

func AdaptAdoptedResource(
	log logr.Logger,
	res *v1alpha1.AdoptedResource,
	additionalValues ...interface{},
) logr.Logger

AdaptAdoptedResource returns a logger with log values set for the adopted resource's kind, namespace, name, etc

func AdaptFieldExport

func AdaptFieldExport(
	log logr.Logger,
	res *v1alpha1.FieldExport,
	additionalValues ...interface{},
) logr.Logger

AdaptFieldExport returns a logger with log values set for the adopted resource's kind, namespace, name, etc

func AdaptResource

func AdaptResource(
	log logr.Logger,
	res acktypes.AWSResource,
	additionalValues ...interface{},
) logr.Logger

AdaptResource returns a logger with log values set for the resource's kind, namespace, name, etc

func DebugAdoptedResource

func DebugAdoptedResource(
	log logr.Logger,
	res *v1alpha1.AdoptedResource,
	msg string,
	additionalValues ...interface{},
)

DebugAdoptedResource writes a supplied log message about a adopted resource that includes a set of standard log values for the resource's kind, namespace, name, etc

func DebugFieldExport

func DebugFieldExport(
	log logr.Logger,
	res *v1alpha1.FieldExport,
	msg string,
	additionalValues ...interface{},
)

DebugFieldExport writes a supplied log message about a field export that includes a set of standard log values for the resource's kind, namespace, name, etc

func DebugResource

func DebugResource(
	log logr.Logger,
	res acktypes.AWSResource,
	msg string,
	additionalValues ...interface{},
)

DebugResource writes a supplied log message about a resource that includes a set of standard log values for the resource's kind, namespace, name, etc

func FromContext

func FromContext(ctx context.Context) acktypes.Logger

FromContext returns a `pkg/types.Logger` from a saved key in the request context

func InfoAdoptedResource

func InfoAdoptedResource(
	log logr.Logger,
	res *v1alpha1.AdoptedResource,
	msg string,
	additionalValues ...interface{},
)

InfoAdoptedResource writes a supplied log message about a adopted resource that includes a set of standard log values for the resource's kind, namespace, name, etc

func InfoFieldExport

func InfoFieldExport(
	log logr.Logger,
	res *v1alpha1.FieldExport,
	msg string,
	additionalValues ...interface{},
)

InfoFieldExport writes a supplied log message about a field export that includes a set of standard log values for the resource's kind, namespace, name, etc

func InfoResource

func InfoResource(
	log logr.Logger,
	res acktypes.AWSResource,
	msg string,
	additionalValues ...interface{},
)

InfoResource writes a supplied log message about a resource that includes a set of standard log values for the resource's kind, namespace, name, etc

Types

type ResourceLogger

type ResourceLogger struct {
	// contains filtered or unexported fields
}

ResourceLogger is a wrapper around a logr.Logger that writes log messages about resources involved in a controller loop. It implements `pkg/types.Logger`

func NewResourceLogger

func NewResourceLogger(
	log logr.Logger,
	res acktypes.AWSResource,
	additionalValues ...interface{},
) *ResourceLogger

NewResourceLogger returns a resourceLogger that can write log messages about a resource.

func (*ResourceLogger) Debug

func (rl *ResourceLogger) Debug(
	msg string,
	additionalValues ...interface{},
)

Debug writes a supplied log message about a resource that includes a set of standard log values for the resource's kind, namespace, name, etc

func (*ResourceLogger) Enter

func (rl *ResourceLogger) Enter(
	name string,
	additionalValues ...interface{},
)

Enter logs an entry to a function or code block

func (*ResourceLogger) Exit

func (rl *ResourceLogger) Exit(
	name string,
	err error,
	additionalValues ...interface{},
)

Exit logs an exit from a function or code block

func (*ResourceLogger) Info

func (rl *ResourceLogger) Info(
	msg string,
	additionalValues ...interface{},
)

Info writes a supplied log message about a resource that includes a set of standard log values for the resource's kind, namespace, name, etc

func (*ResourceLogger) IsDebugEnabled

func (rl *ResourceLogger) IsDebugEnabled() bool

IsDebugEnabled returns true when the underlying logger is configured to write debug messages, false otherwise.

func (*ResourceLogger) Trace

func (rl *ResourceLogger) Trace(
	name string,
	additionalValues ...interface{},
) acktypes.TraceExiter

Trace logs an entry to a function or code block and returns a functor that can be called to log the exit of the function or code block

func (*ResourceLogger) WithValues

func (rl *ResourceLogger) WithValues(
	values ...interface{},
)

WithValues adapts the internal logger with a set of additional values