Skip to content

Commit

Permalink
Merge pull request #1203 from vincepri/more-doc-loggerfrom
Browse files Browse the repository at this point in the history
📖 Add more details for what's included in a logger
  • Loading branch information
k8s-ci-robot committed Oct 2, 2020
2 parents d057d46 + 07bd3b9 commit d3f3595
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions alias.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,10 @@ var (
Log = log.Log

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

0 comments on commit d3f3595

Please sign in to comment.