Structured logging for docker image manager #3696
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
sparrc
force-pushed
the
image-manager-logging
branch
from
e4f87a5 to
70df265
Compare
sparrc
force-pushed
the
image-manager-logging
branch
from
70df265 to
b64e8bd
Compare
sparrc
commented
May 15, 2023
| @@ -272,7 +273,7 @@ func (imageManager *dockerImageManager) removeImageState(imageStateToBeRemoved * | |||
| for i, imageState := range imageManager.imageStates { | |||
| if imageState.Image.ImageID == imageStateToBeRemoved.Image.ImageID { | |||
| // Image State found; hence remove it | |||
| seelog.Infof("Removing Image State: [%s] from Image Manager", imageState.String()) | |||
| logger.Debug("Image Manager: removing image state", imageState.Fields()) | |||
There was a problem hiding this comment.
this is not removing the image state from the instance, only from the agent's internal tracking object. This seems confusing to have as a public INFO message so making it debug
sparrc
commented
May 15, 2023
| // no image states present in image manager | ||
| return nil | ||
| } | ||
| var imagesForDeletion []*image.ImageState | ||
| for _, imageState := range imageManager.imageStatesConsideredForDeletion { | ||
| if imageManager.isImageOldEnough(imageState) && imageState.HasNoAssociatedContainers() { | ||
| seelog.Infof("Candidate image for deletion: [%s]", imageState.String()) | ||
| logger.Debug("Candidate image for deletion", imageState.Fields()) |
There was a problem hiding this comment.
these messages are logged multiple times when the image is actually removed, and then again on each "removal" loop, so making it debug
danehlim
previously approved these changes
May 15, 2023
chienhanlin
reviewed
May 15, 2023
sparrc
force-pushed
the
image-manager-logging
branch
from
55bdb5f to
b64e8bd
Compare
singholt
reviewed
May 15, 2023
singholt
approved these changes
May 16, 2023
danehlim
approved these changes
May 16, 2023
Realmonia
pushed a commit
to Realmonia/amazon-ecs-agent
that referenced
this pull request
May 16, 2023
* Structured logging for docker image manager * Add some reused fields to logger/field/constants.go * Add missing 'imageTag' field from err message
RichaGangwar
pushed a commit
to RichaGangwar/amazon-ecs-agent
that referenced
this pull request
May 18, 2023
* Structured logging for docker image manager * Add some reused fields to logger/field/constants.go * Add missing 'imageTag' field from err message
Realmonia
pushed a commit
to Realmonia/amazon-ecs-agent
that referenced
this pull request
May 21, 2023
* Structured logging for docker image manager * Add some reused fields to logger/field/constants.go * Add missing 'imageTag' field from err message
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.
Summary
Make the docker image manager logs more readable and traceable by using structured logging and adding fields with consistent metadata about the image in each log line.
Also moved a few redundant log messages from INFO to DEBUG
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.