Added documentation and explicit mapping between ECS and OpenTelemetry #2415
Conversation
|
Documentation changes preview: https://ecs_bk_2415.docs-preview.app.elstc.co/diff |
5bb0816 to
f8abef4
Compare
… ECS Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
e68c023 to
3f2ba64
Compare
Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
Signed-off-by: Alexander Wert <alexander.wert@elastic.co>
| @@ -41,6 +42,9 @@ | |||
| def main() -> None: | |||
| args = argument_parser() | |||
|
|
|||
| if not args.semconv_version: | |||
| raise KeyError("OTel Semantic Conventions version has not been provided as a config option '--semconv-version'") | |||
There was a problem hiding this comment.
should the default be the last one? we can detect it through git and skip manually selecting it
I think for this purpose we need always to adhere to the last available version
There was a problem hiding this comment.
I'd rather keep that a manual step, or use something like dependabot to update it but not updating it automatically, that has some risks.
There was a problem hiding this comment.
we are using there only schema, what risks do you have in mind?
we are adding a lot of new fields into each release but most probably we would need to update mapping anyway and can update the version, so this comment is not blocking.
| [[ecs-opentelemetry-relation]] | ||
| === Relation between ECS and Semantic Conventions | ||
|
|
||
| The https://github.com/elastic/ecs/tree/main/schemas[ECS schema files] contain an explicit mapping between ECS fields and corresponding OTel semnatic convention attributes. |
There was a problem hiding this comment.
There's a typo here: semnatic
|
|
||
| [%header] | ||
| |==== | ||
| | ECS Field | Relation | OTel Semantic Conventions Attribute | Stability |
There was a problem hiding this comment.
What Stability means could be confusing. Is it stability in ECS or otel?
| This file is automatically generated. Don't edit it manually! | ||
| //// | ||
| The following table gives an overview of mappings between individual ECS fields (in ECS version `9.0.0-dev`) | ||
| and corresponding OTel semantic convention attributes (in SemConv version `1.29.0`). |
There was a problem hiding this comment.
I think it would be good to state somewhere why all fields are not mapped yet, or given the conflict or n/a catagory. If someone looks for an ECS field, and doesn't find it, there's nowhere in these docs that states why some are missing, or what someone should do with that info.
|
|
||
| ^| image:https://img.shields.io/badge/related-efc20d?style=flat[relation,title=related,link=ecs-opentelemetry.html#ecs-opentelemetry-relation] | ||
|
|
||
| <| https://opentelemetry.io/docs/specs/semconv/attributes-registry/k8s/#k8s-pod-label[k8s.pod.label] + |
There was a problem hiding this comment.
Is there any way to link to a specific semconv version in the otel docs? I couldn't find a way. But if there is, it would be nice to link to the same SEMCONV_VERSION this is generated from.
Goal
Have a single source of truth of the relation between ECs fields and OpenTelemetry attributes and metrics
What this PR adds: