Skip to content

Commit 07bd3b9

Browse files
committed
📖 Add more details for what's included in a logger
Signed-off-by: Vince Prignano <vincepri@vmware.com>
1 parent e50bc83 commit 07bd3b9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

alias.go

+4
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,10 @@ var (
126126
Log = log.Log
127127

128128
// LoggerFrom returns a logger with predefined values from a context.Context.
129+
// The logger, when used with controllers, can be expected to contain basic information about the object
130+
// that's being reconciled like:
131+
// - `reconcilerGroup` and `reconcilerKind` coming from the For(...) object passed in when building a controller.
132+
// - `name` and `namespace` injected from the reconciliation request.
129133
//
130134
// This is meant to be used with the context supplied in a struct that satisfies the Reconciler interface.
131135
LoggerFrom = log.FromContext

0 commit comments

Comments
 (0)