WithContainerID: Extracts incorrect container ID in ECS.

[mackjmr]

Description

WithContainerID (link) extracts the container ID from /proc/self/cgroup using the following regex. The container ID in ECS does not does not match the expected format of the regex.

• Example working cgroup:

14:name=systemd:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
13:rdma:/
12:pids:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
11:hugetlb:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
10:net_prio:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
9:perf_event:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
8:net_cls:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
7:freezer:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
6:devices:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
5:memory:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
4:blkio:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
3:cpuacct:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
2:cpu:/docker/8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8
1:cpuset:/docker/c

Extracted container ID => 8c1e75bb325eb9c64571326952a6507132f1fc7eba7cd5b694422abe39fc7ed8 ✅

• Example cgroup in ECS (docker container deployed with fargate):

11:freezer:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
10:devices:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
9:blkio:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
8:perf_event:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
7:pids:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
6:memory:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
5:cpuset:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
4:cpu,cpuacct:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
3:net_cls,net_prio:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
2:hugetlb:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121
1:name=systemd:/ecs/121c14dc9fd841a5a995bdfb82dd4e32/121c14dc9fd841a5a995bdfb82dd4e32-2232344121	

Extracted container ID => 2232344121 ❌
Expected container ID => 121c14dc9fd841a5a995bdfb82dd4e32-2232344121

Environment

• Operating system/Architecture: Linux/X86_64
• Platform version: 1.4.0
• Lauch type: FARGATE

Steps To Reproduce

Deploy a docker container with Fargate and use WithContainerID().

Expected behavior

The valid container ID to be added as a resource attribute in ECS.

One way to do this would be to adapt the regex if it is detected to be a Fargate environment.

Another way to do this is by leveraging ECS_CONTAINER_METADATA_URI (link). This endpoint returns a json containing the DockerId (and other metadata about the container itself). opentelemetry-java uses this method to detect resource attributes on ECS (PR).

[MrAlias]

cc @Aneurysm9

[Aneurysm9]

The ECS resource detector can correctly determine the continer ID. I don't know that WithContainerID() should be modified to special-case for ECS when a separate detector is already available.

[mackjmr]

Thanks for the response @Aneurysm9, the approach you mentioned makes sense to me. I think it would still be helpful to document this limitation in WithContainerID() and suggest using the ECS resource detector instead. Does that make sense? If so, happy to put up the PR to document this.

[Aneurysm9]

I think it would still be helpful to document this limitation in WithContainerID() and suggest using the ECS resource detector instead. Does that make sense? If so, happy to put up the PR to document this.

That sounds good to me.