Skip to content
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

Jump to bottom

[chore] Add warning to the awscontainerinsightsreceiver #23817

Merged
merged 1 commit into from
Jun 28, 2023
Merged

[chore] Add warning to the awscontainerinsightsreceiver #23817

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions receiver/awscontainerinsightreceiver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| ------------- |-----------|
| Stability | [beta]: metrics |
| Distributions | [contrib], [aws], [observiq], [sumo] |
| Warnings | [Other](#warnings) |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
Expand Down Expand Up @@ -875,3 +876,17 @@ To deploy to an ECS cluster check this [doc](https://aws-otel.github.io/docs/set
| EBSVolumeId |
<br/><br/>
<br/><br/>

# Warnings

## Root permissions

When using this component, the collector process needs root permission to be able to read the content of the files located in the following locations:
* `/`
* `/var/run/docker.sock`
* `/var/lib/docker`
* `/run/containerd/containerd.sock`
* `/sys`
* `/dev/disk`

This requirement comes from the fact that this component is based on [cAdvisor](https://github.com/google/cadvisor).
1 change: 1 addition & 0 deletions receiver/awscontainerinsightreceiver/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ status:
stability:
beta: [metrics]
distributions: [contrib, aws, observiq, sumo]
warnings: [Other]
Loading