Skip to content

Commit bbe083f

Browse files
authored
Merge branch 'main' into LambdReleasev35
2 parents aaec8ef + 0e87582 commit bbe083f

File tree

2 files changed

+22
-0
lines changed

2 files changed

+22
-0
lines changed

src/docs/getting-started/container-insights.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,26 @@ CloudWatch Container Insights collects metrics for many resources such as CPU, m
3232
It also provides diagnostic information such as container restart failures.
3333
The metrics are aggregated at the cluster, node, pod, task, and service level as CloudWatch metrics.
3434

35+
Note: Collecting infrastructure metrics through `awscontainerinsightreceiver` requires running ADOT Collector with privileged root access as it also collects container-related data from `cadvisor`.
36+
For EKS deployments, use the [Security Context](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1) to specify the root user as owner of the Collector process:
37+
```
38+
containers:
39+
- name: aws-otel-collector
40+
image: public.ecr.aws/aws-observability/aws-otel-collector:latest
41+
securityContext:
42+
runAsUser: 0
43+
runAsGroup: 0
44+
```
45+
For ECS deployments, use the [Task Definition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-containerdefinition.html#cfn-ecs-taskdefinition-containerdefinition-user) to specify the user owner of the collector process:
46+
```
47+
{
48+
"name": "aoc-collector",
49+
"image": "public.ecr.aws/aws-observability/aws-otel-collector:latest",
50+
"user": "root",
51+
...
52+
}
53+
```
54+
3555
The following platforms are supported:
3656

3757
- <Link to="/docs/getting-started/container-insights/eks-infra">Amazon EKS and Kubernetes platforms on Amazon EC2</Link>

src/docs/getting-started/container-insights/ecs-prometheus.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@ NOTE: You need to replace placeholder values with actual value
321321

322322
- The account id in the example is `123456` and is used in ARN for taskRole and executionRole, replace it with your own AWS account id.
323323
- `amazon/aws-otel-collector:v0.11.0` is using dockerhub (potential throttle) and you can use `latest` tag if you don't want to lock version.
324+
- Collecting infrastructure metrics requires running ADOT Collector with root access and this can be configured through `user` in the container definition.
324325
- `/aoc/ecs-prometheus` is the name of <Link to="/docs/setup/ecs/config-through-ssm">SSM parameter</Link>.
325326
- `networkMode` can be `bridge`, `host`, `awsvpc`. For fargate, it has to be `awsvpc`.
326327
- `logConfiguration` is for log from ADOT Collector itself. Log groups for metrics/log collected by collector is configured using `AOT_CONFIG_CONTENT`.
@@ -338,6 +339,7 @@ e.g. `cpu 255 memory 511` is invalid pair.
338339
{
339340
"name": "adot",
340341
"image": "amazon/aws-otel-collector:v0.11.0",
342+
"user": "root",
341343
"secrets": [
342344
{
343345
"name": "AOT_CONFIG_CONTENT",

0 commit comments

Comments
 (0)