open-telemetry / opentelemetry-collector-contrib

Contrib repository for the OpenTelemetry Collector
https://opentelemetry.io
Apache License 2.0
2.92k stars 2.28k forks source link

Document/refine all k8sattributes config fields and their functionality #26110

Open rmfitzpatrick opened 1 year ago

rmfitzpatrick commented 1 year ago

Component(s)

processor/k8sattributes

Is your feature request related to a problem? Please describe.

Currently the k8sattributes readme doesn't describe all available config fields and their purpose or functionality. It's currently missing all filter items that aren't node and node_from_env_var (namespace, fields, and labels with associated functionality). It's also not clear that the metadata, annotations, and labels examples/descriptions are part of extract configuration and a complete example isn't provided. exclude isn't documented or demonstrated either.

Describe the solution you'd like

The existing readme is a great improvement of the previous godoc link but could be reorganized and made more complete to reflect its capabilities.

zzadxz commented 8 months ago

Hey! I can help with this. May I be assigned?

Frapschen commented 7 months ago

Thank you, @zzadxz

github-actions[bot] commented 5 months ago

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

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

fatsheep9146 commented 5 months ago

nicely ping @zzadxz

github-actions[bot] commented 3 months ago

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

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

github-actions[bot] commented 1 month ago

This issue has been inactive for 60 days. It will be closed in 60 days if there is no activity. To ping code owners by adding a component label, see Adding Labels via Comments, or if you are unsure of which component this issue relates to, please ping @open-telemetry/collector-contrib-triagers. If this issue is still relevant, please ping the code owners or leave a comment explaining why it is still relevant. Otherwise, please close it.

Pinging code owners:

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