Document which conventions belong in this repo (#1705)

Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
Co-authored-by: Joao Grassi <5938087+joaopgrassi@users.noreply.github.com>
This commit is contained in:
Liudmila Molkova 2024-12-23 07:37:37 -08:00 committed by GitHub
parent 5a5803258f
commit 07e99ebb78
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions

View File

@ -13,6 +13,7 @@ requirements and recommendations.
- [Sign the CLA](#sign-the-cla) - [Sign the CLA](#sign-the-cla)
- [How to Contribute](#how-to-contribute) - [How to Contribute](#how-to-contribute)
- [Which semantic conventions belong in this repo](#which-semantic-conventions-belong-in-this-repo)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [1. Modify the YAML model](#1-modify-the-yaml-model) - [1. Modify the YAML model](#1-modify-the-yaml-model)
- [Code structure](#code-structure) - [Code structure](#code-structure)
@ -62,6 +63,25 @@ key, but non-obvious, aspects:
Please make sure all Pull Requests are compliant with these rules! Please make sure all Pull Requests are compliant with these rules!
### Which semantic conventions belong in this repo
This repo contains semantic conventions supported by the OpenTelemetry ecosystem
including, but not limited to, components hosted in OpenTelemetry.
Instrumentations hosted in OpenTelemetry SHOULD contribute their semantic
conventions to this repo with the following exceptions:
- Instrumentations that follow external schema not fully compatible with OpenTelemetry such as
[Kafka client JMX metrics](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/v2.10.0/instrumentation/kafka/kafka-clients/kafka-clients-2.6/library/README.md)
or [RabbitMQ Collector Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.116.0/receiver/rabbitmqreceiver)
SHOULD document such conventions in their own repository.
Having all OTel conventions in this repo allows to reuse common attributes, enforce naming and compatibility policies,
and helps to keep conventions consistent and backward compatible.
Want to define your own conventions outside this repo while building on OTels?
Come help us [decentralize semantic conventions](https://github.com/open-telemetry/weaver/issues/215).
### Prerequisites ### Prerequisites
The Specification uses several tools to check things like style, The Specification uses several tools to check things like style,