[chore] Add warning to the awscontainerinsightsreceiver (#23817)

**Description:** Add warning section to the awscontainerinsightsreceiver **Link to tracking Issue:** #19172 Signed-off-by: Raphael Silva <[email protected]>
open-telemetry · Jun 28, 2023 · 7e74bd3 · 7e74bd3
1 parent 0ab552c
commit 7e74bd3
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git 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          |
 <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).
diff --git 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]