Skip to content

Commit 8ec1b51

Browse files
authored
[processor/resourcedetection] Add EKS cluster name subsection in README (#34140)
Fixes #34139
1 parent d85958a commit 8ec1b51

File tree

1 file changed

+20
-3
lines changed
  • processor/resourcedetectionprocessor

1 file changed

+20
-3
lines changed

processor/resourcedetectionprocessor/README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -318,9 +318,6 @@ processors:
318318
* cloud.platform ("aws_eks")
319319
* k8s.cluster.name
320320

321-
Note: The kubernetes cluster name is only available when running on EC2 instances, and requires permission to run the `EC2:DescribeInstances` [action](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html).
322-
If you see an error with the message `context deadline exceeded`, please increase the timeout setting in your config.
323-
324321
Example:
325322

326323
```yaml
@@ -331,6 +328,26 @@ processors:
331328
override: false
332329
```
333330

331+
#### Cluster Name
332+
333+
Cluster name detection is disabled by default, and can be enabled with the
334+
following configuration:
335+
336+
```yaml
337+
processors:
338+
resourcedetection/eks:
339+
detectors: [env, eks]
340+
timeout: 15s
341+
override: false
342+
eks:
343+
resource_attributes:
344+
k8s.cluster.name:
345+
enabled: true
346+
```
347+
348+
Note: The kubernetes cluster name is only available when running on EC2 instances, and requires permission to run the `EC2:DescribeInstances` [action](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html).
349+
If you see an error with the message `context deadline exceeded`, please increase the timeout setting in your config.
350+
334351
### AWS Lambda
335352

336353
Uses the AWS Lambda [runtime environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime)

0 commit comments

Comments
 (0)