Add missing attributes to otel semantic conventions mapping docs #20967
Conversation
The otel semantic conventions mapping docs are missing a variety of attributes. I've added some of them here. More are missing; see https://github.com/DataDog/opentelemetry-mapping-go/blob/5432be02915e24c7e8a294cd4a17877016f9b73d/pkg/otlp/attributes/attributes.go#L56 DD should really make sure this doc matches the implementation.
|
Thanks for creating this PR, @ringerc! I created an editorial review card and a writer will review + add onto your PR. |
|
Please see also DataDog/opentelemetry-mapping-go#156 |
| @@ -60,10 +65,22 @@ For more information, see [Unified Service Tagging][2]. | |||
| | `k8s.cronjob.name` | `kube_cronjob` | | |||
| | `k8s.namespace.name` | `kube_namespace` | | |||
| | `k8s.pod.name` | `pod_name` | | |||
| | `app.kubernetes.io/name` | `kube_app_name` | | |||
There was a problem hiding this comment.
Although I agree we need to document this somewhere, I don't think this is the right place. This table is for the mapping from OTel Conventions to DD conventions, but the additions here are not OTel conventions.
Perhaps we can create a new table at the bottom where the left column name is "Kubernetes Labels" or "Kubernetes Conventions" instead of "OpenTelemetry convention".
What do you think ?
There was a problem hiding this comment.
Sounds good. Feel free to take this as the basis for a docs fix.
|
Thank you for putting up the PR! Just a small nit. |
| * [Datadog: OpenTelemetry metric types][3] | ||
| * [Datadog: OpenTelemetry Metric mappings][4] | ||
| * [Implementation of these mappings in the exporter](https://github.com/DataDog/opentelemetry-mapping-go/blob/main/pkg/otlp/attributes/attributes.go) |
There was a problem hiding this comment.
Further reading links go in the yaml frontmatter (see lines 4-7 above)
Co-authored-by: Kari Halsted <[email protected]>
|
I can't do more to update DD's docs right now. Feel free to close this PR and make another. |
No problem! Thanks for the start, we'll get this in. |
|
Moved to #21434 |
|
Thanks very much |
What does this PR do? What is the motivation?
Fix incomplete documentation on otel semantic conventions mappings.
The otel semantic conventions mapping docs are missing a variety of attributes.
I've added some of them here. More are missing; see https://github.com/DataDog/opentelemetry-mapping-go/blob/5432be02915e24c7e8a294cd4a17877016f9b73d/pkg/otlp/attributes/attributes.go#L56
DD should really make sure this doc matches the implementation.
Merge instructions
Additional notes
It'd be best if you added the rest of the missing attributes on top of my PR.