use structured logger #4046
Open
use structured logger #4046
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
|
should this go straight to dev branch instead of the feature branch? |
|
chienhanlin
reviewed
Dec 1, 2023
|
|
||
| if utils.ZeroOrNil(credentials.ARN) && utils.ZeroOrNil(credentials.IAMRoleCredentials) { | ||
| // This can happen when the agent is restarted and is reconciling its state. | ||
| errText := errPrefix + "Credentials uninitialized for ID" | ||
| seelog.Errorf("Error processing credential request credentialType=%s taskARN=%s credentialScope=%s: %s", | ||
| credentials.IAMRoleCredentials.RoleType, credentials.ARN, credentials.IAMRoleCredentials.CredentialScope, errText) | ||
| logger.Error(fmt.Sprintf("Error processing credential request credentialType=%s taskARN=%s credentialScope=%s: %s", |
There was a problem hiding this comment.
Thanks for making these changes!
In addition to replacing seelog with logger in this PR, we should refactor the message with fields defined here to make it easier to read.
For example,
logger.Error("Error processing credential request", logger.Fields{
"credentialType": credentials.IAMRoleCredentials.RoleType,
field.TaskARN: credentials.ARN,
"credentialScope": credentials.IAMRoleCredentials.CredentialScope,
field.Error: errText,
})
There was a problem hiding this comment.
Also, we should think of if any cx application has dependency on the exact log message as these changes are made in TMDEv1.
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.
Summary
This PR use the structured logger for logging in this file to follow the convention and help make the logs more readable and traceable
Testing
New tests cover the changes: no
Description for the changelog
NA
Licensing
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.