[processor/resourcedetection] Produce docs based on metadata.yaml

open-telemetry / opentelemetry-collector-contrib

Contrib repository for the OpenTelemetry Collector

https://opentelemetry.io

Apache License 2.0

2.9k stars 2.27k forks source link

[processor/resourcedetection] Produce docs based on metadata.yaml #34210

Open ChrsMark opened 1 month ago

ChrsMark commented 1 month ago

Component(s)

processor/resourcedetection

Describe the issue you're reporting

Based on the discussion at https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/34140, it would be nice and more straightforward to produce docs files for this processor based on the metadata.yaml files.

We can follow what the hostmetricsreceiver does and from the main readme link to the various sub-components.

/cc @codeboten

github-actions[bot] commented 1 month ago

Pinging code owners:

processor/resourcedetection: @Aneurysm9 @dashpole

See Adding Labels via Comments if you do not have permissions to add labels yourself.

crobert-1 commented 1 month ago

Thanks for filing @ChrsMark!

I ended up filing https://github.com/open-telemetry/opentelemetry-collector/issues/10705 because I was a bit confused as to why there isn't a documentation.md file for the EKS detector's resource attributes. Once we have one we'll be able to link to it from the top-level README.