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

Documentation regarding the newly added k8s.cluster.name attribute is not correct #32258

Closed
mzanrosso-ikea opened this issue Apr 9, 2024 · 2 comments · Fixed by #32270
Closed

Documentation regarding the newly added k8s.cluster.name attribute is not correct #32258

mzanrosso-ikea opened this issue Apr 9, 2024 · 2 comments · Fixed by #32270
Labels
bug Something isn't working documentation Improvements or additions to documentation processor/resourcedetection Resource detection processor

Comments

@mzanrosso-ikea
Copy link

Component(s)

processor/resourcedetection/internal/azure

What happened?

Description

Documentation regarding the newly added k8s.cluster.name attribute it's not correct:
https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourcedetectionprocessor#cluster-name

Wrong:

processors:
  resourcedetection/aks:
    detectors: [aks]
    timeout: 2s
    override: false
    aks:
      resource_attributes:
        k8s.cluster.name: true

Correct

processors:
  resourcedetection/aks:
    detectors: [aks]
    timeout: 2s
    override: false
    aks:
      resource_attributes:
        k8s.cluster.name:
            enabled: true

Collector version

latest

Environment information

Not relevant

OpenTelemetry Collector configuration

Not relevant

Log output

Not relevant

Additional context

No response
@mzanrosso-ikea mzanrosso-ikea added bug Something isn't working needs triage New item requiring triage labels Apr 9, 2024
@crobert-1 crobert-1 added processor/resourcedetection Resource detection processor documentation Improvements or additions to documentation labels Apr 9, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 9, 2024

Pinging code owners for processor/resourcedetection: @Aneurysm9 @dashpole. See Adding Labels via Comments if you do not have permissions to add labels yourself.

@crobert-1 crobert-1 mentioned this issue Apr 9, 2024
Merged
@crobert-1
Copy link
Member

Thanks for filing @mzanrosso-ikea, I agree that it's the wrong format. I've submitted #32270 to fix it. 👍

@crobert-1 crobert-1 removed the needs triage New item requiring triage label Apr 9, 2024
@crobert-1 crobert-1 changed the title Documentation regarding the newly added k8s.cluster.name attribute it's not correct Documentation regarding the newly added k8s.cluster.name attribute is not correct Apr 9, 2024
codeboten pushed a commit that referenced this issue Apr 9, 2024
@crobert-1
[chore][processor/resourcedetection] Fix README's config example (#32270
0250e2e 
)

The example config for enabling AKS's `k8s.cluster.name` metric was
incorrect. This fixes it to be the correct format.

Resolves #32258
@github-actions github-actions bot mentioned this issue Apr 16, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation processor/resourcedetection Resource detection processor
Projects
None yet
Milestone
No milestone
2 participants
@crobert-1 @mzanrosso-ikea