imdocker: Add image name to metadata fields #5268
Open
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
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.
What
Exposes the image name and tag of the source container (what the Docker API simply calls
Image) as an additional metadata value alongside the existing ones.Why
While the ImageID is available today, a SHA hash is not a particularly user-friendly way to identify what is actually generating the logs.
The image name provides a simple, easy-to-read identifier for the common scenario where an unmodified application image is used.
Testing
A test for this additional property has been written, however the
devtools/devcontainer.shenvironment does not include Docker, so attempting to run the test locally crashes withdocker: command not found.Modifying this development environment to add Docker is probably beyond the scope of this PR, so I hope that the CI tests will suffice.
Reference
Docker API documentation reference.