diff --git a/receiver/awscontainerinsightreceiver/README.md b/receiver/awscontainerinsightreceiver/README.md index 1d837c37b633..f9257e7ff2f3 100644 --- a/receiver/awscontainerinsightreceiver/README.md +++ b/receiver/awscontainerinsightreceiver/README.md @@ -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 @@ -875,3 +876,17 @@ To deploy to an ECS cluster check this [doc](https://aws-otel.github.io/docs/set | EBSVolumeId |



+ +# 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). diff --git a/receiver/awscontainerinsightreceiver/metadata.yaml b/receiver/awscontainerinsightreceiver/metadata.yaml index 7d39c0554ba1..7298a706cbc8 100644 --- a/receiver/awscontainerinsightreceiver/metadata.yaml +++ b/receiver/awscontainerinsightreceiver/metadata.yaml @@ -5,3 +5,4 @@ status: stability: beta: [metrics] distributions: [contrib, aws, observiq, sumo] + warnings: [Other]