Skip to content

docs(resource-detector-container): update readme for container resource detector #2061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trentm merged 4 commits into from
Apr 9, 2024
Merged

docs(resource-detector-container): update readme for container resource detector #2061

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
68a07af
chore: update readme for container resource detector
maryliag Mar 28, 2024
207886f
remove notes colum
maryliag Apr 9, 2024
85fdcd7
Merge branch 'main' into doc-container
trentm Apr 9, 2024
32e9398
Merge branch 'main' into doc-container
trentm Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion detectors/node/opentelemetry-resource-detector-container/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,15 @@ const tracerProvider = new NodeTracerProvider({ resource });

## Available detectors

- `containerDetector`: Populates `container.id` for processes running on containers supporting : docker( cgroup v1 or v2 ) or with containerd
This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)

### ContainerDetector

Populates `container.id` for processes running on containers supporting : docker( cgroup v1 or v2 ) or with containerd

| Resource Attribute | Description |
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------|
| `container.id` | Value parsed from file `/proc/self/cgroup` (cgroup v1). If it doesn't exist, parse the value from file `/proc/self/mountinfo` (cgroup v2)|

## Useful links

Expand Down