chore: Consistent/Improved logging #152
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Removes the use of logrus in all external-dns code in favour of setting a `logr.Logger` on all structs. Constructors are used throughout to create new instances of components (plan, registry and providers), with each requiring the current context and a logger instance retrieved from it with an appropriate logger name added where required.
philbrookes
reviewed
Jun 4, 2024
| @@ -156,7 +157,7 @@ func (r *ManagedZoneReconciler) Reconcile(ctx context.Context, req ctrl.Request) | |||
| if err != nil { | |||
| return ctrl.Result{}, err | |||
| } | |||
| log.Log.Info("Reconciled ManagedZone", "managedZone", managedZone.Name) | |||
| logger.Info("Reconciled ManagedZone") | |||
There was a problem hiding this comment.
why don't we need the managedzone name here, but we do need it in some of the others?
There was a problem hiding this comment.
There was a problem hiding this comment.
We don't, will update those to remove the duplicate key/values
There was a problem hiding this comment.
Should all be updated now to remove adding the details of the current resource at individual log statements. That is already being done as part of the logger setup in Reconcile. Further improvements to the logging and what metadata is included and where will be done as part of #118
Construct logger in Reconcile function (DNSRecord and ManagedZone), naming each appropriately, and ensure it is used by all logging statements throughout the call stack for the request. Initialise external-dns components (registry, plan and providers) using correct context to ensure the appropriate logger is used internally. Removes all references to logrus logger.
mikenairn
force-pushed
the
logging_updates
branch
from
c4d27a9 to
3dbf24f
Compare
mikenairn
commented
Jun 4, 2024
| return false, nil | ||
| } | ||
| return false, err | ||
| } | ||
| logger.Info("Deleted DNSRecord in manage zone", "dnsRecord", dnsRecord.Name, "managedZone", managedZone.Name) | ||
| logger.Info("Deleted DNSRecord in manage zone", "managedZone", managedZone.Name) |
There was a problem hiding this comment.
Example:
{
"level": "info",
"ts": "2024-06-04T16:32:37+01:00",
"logger": "dnsrecord_controller",
"msg": "Deleted DNSRecord in manage zone",
"controller": "dnsrecord",
"controllerGroup": "kuadrant.io",
"controllerKind": "DNSRecord",
"DNSRecord": {
"name": "t-single-lively-waterfall",
"namespace": "dnstest"
},
"namespace": "dnstest",
"name": "t-single-lively-waterfall",
"reconcileID": "81a1838b-c782-4323-8baf-58486cadbcec",
"managedZone": "dev-mz-aws"
}Left managedZone here for now although i expect that will be moved and set on the context higher up the stack as part of #117
philbrookes
approved these changes
Jun 5, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #124
external-dns: Remove logrus logger
Removes the use of logrus in all external-dns code in favour of setting a
logr.Loggeron all objects.Constructors are used throughout to create new instances of components (plan, registry and providers), with each requiring the current context, retrieving a logger instance from it with an appropriate logger name added where required.
chore: Consistent/Improved logging
Construct logger in
Reconcilefunctions (DNSRecord and ManagedZone), naming each appropriately, and ensure it is used by all logging statements throughout the call stack for the request.Initialise external-dns components (registry, plan and providers) using correct context to ensure the appropriate logger is used internally. Removes all references to logrus logger.