WithContainerID: Document ECS limitation. (#3639)

* WithContainerID: Document ECS limitation. WithContainerID is not able to extract the correct container id in an ECS environment. The ECS resource detector should be used instead (https://pkg.go.dev/go.opentelemetry.io/contrib/detectors/aws/ecs). See #3633. * fix lint * Update sdk/resource/config.go --------- Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
open-telemetry · Feb 9, 2023 · e9bdda0 · e9bdda0
1 parent d5fca83
commit e9bdda0
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/sdk/resource/config.go b/sdk/resource/config.go
@@ -194,6 +194,8 @@ func WithContainer() Option {
 }
 
 // WithContainerID adds an attribute with the id of the container to the configured Resource.
+// Note: WithContainerID will not extract the correct container ID in an ECS environment.
+// Please use the ECS resource detector instead (https://pkg.go.dev/go.opentelemetry.io/contrib/detectors/aws/ecs).
 func WithContainerID() Option {
 	return WithDetectors(cgroupContainerIDDetector{})
 }