Use consistent container name in docker input plugin #8703
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
![telegraf-tiger[bot]](https://avatars.githubusercontent.com/in/94907?s=60&v=4){kind=small}
pkoenig10
force-pushed
the
containerName
branch
from
a18fe94
to
3cf7c65
Compare
|
@danielnelson I'd really appreciate a review of this if you have the time! |
sjwang90
added
area/docker
feat
|
@jagularr Any other blockers to getting this merged? |
srebhan
added
the
ready for final review
ssoroka
approved these changes
Mar 1, 2021
srebhan
reviewed
Mar 2, 2021
| @@ -434,7 +434,7 @@ func (d *Docker) gatherContainer( | |||
| var cname string | |||
| for _, name := range container.Names { | |||
| trimmedName := strings.TrimPrefix(name, "/") | |||
| if len(strings.Split(trimmedName, "/")) == 1 { | |||
| if !strings.Contains(trimmedName, "/") { | |||
There was a problem hiding this comment.
What about /name/ should that match? Maybe it would be better to trim both leading and trailing slashed?
There was a problem hiding this comment.
I don't think you can get a name like that.
I'd prefer to keep this implementation as similar as possible to the Docker CLI implementation. I imagine that users expect the implementation of the name filter to be consistent with the output of docker ps.
srebhan
approved these changes
Mar 2, 2021
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.
Required for all PRs:
Before this PR
I have noticed that the docker input plugin occasionally gathers metrics for containers with a container name that does not match the configured filter. For example, I have a container named
influxdband have configured the docker input plugin withcontainer_name_include = ["influxdb"], but the docker input plugin sometimes produces metrics with acontainer_nametag of something like689a5b5f3679_influxdb.Upon further investigation, I discovered that this happens when the metrics are gathered while docker-compose is recreating the container. When docker-compose recreates the container, it temporarily renames the original container to
{id}_{name}before removing it.The docker input plugin uses the name from the
ListContainercall when checking the filter, but uses the name from theContainerStatscall when setting thecontainer_nametag. If the container is renamed between these calls, it will result in the confusing behavior described above.After this PR
The docker input plugin uses the name from the
ListContainercall both when checking the filter and when setting thecontainer_nametag.Because we want the
container_nametag to be the canonical container name, this PR removes support for matching based on all container names and now only matches on the default container name. Other container names come from links (see moby/moby#14128), which is a legacy feature that has been deprecated for a while. See https://docs.docker.com/network/links/.This implementation now matches the behavior of
docker ps(when used without--no-trunc). You can see the current implementation here:https://github.com/docker/cli/blob/cde469bf1aad14146d57710205399899e465aadc/cli/command/formatter/container.go#L124-L138
This behavior in the docker CLI was first introduced over 5 years ago in moby/moby#8505.
I can't think of a good reason to allow matching on names from links, especially given that they are deprecated, so it seemed reasonable to make this change.