Skip to content

Commit 07e99eb

Browse files
Liudmila Molkovatraskjoaopgrassi
authored
Document which conventions belong in this repo (#1705)
Co-authored-by: Trask Stalnaker <[email protected]> Co-authored-by: Joao Grassi <[email protected]>
1 parent 5a58032 commit 07e99eb

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ requirements and recommendations.
1313

1414
- [Sign the CLA](#sign-the-cla)
1515
- [How to Contribute](#how-to-contribute)
16+
- [Which semantic conventions belong in this repo](#which-semantic-conventions-belong-in-this-repo)
1617
- [Prerequisites](#prerequisites)
1718
- [1. Modify the YAML model](#1-modify-the-yaml-model)
1819
- [Code structure](#code-structure)
@@ -62,6 +63,25 @@ key, but non-obvious, aspects:
6263

6364
Please make sure all Pull Requests are compliant with these rules!
6465

66+
### Which semantic conventions belong in this repo
67+
68+
This repo contains semantic conventions supported by the OpenTelemetry ecosystem
69+
including, but not limited to, components hosted in OpenTelemetry.
70+
71+
Instrumentations hosted in OpenTelemetry SHOULD contribute their semantic
72+
conventions to this repo with the following exceptions:
73+
74+
- Instrumentations that follow external schema not fully compatible with OpenTelemetry such as
75+
[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)
76+
or [RabbitMQ Collector Receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.116.0/receiver/rabbitmqreceiver)
77+
SHOULD document such conventions in their own repository.
78+
79+
Having all OTel conventions in this repo allows to reuse common attributes, enforce naming and compatibility policies,
80+
and helps to keep conventions consistent and backward compatible.
81+
82+
Want to define your own conventions outside this repo while building on OTel’s?
83+
Come help us [decentralize semantic conventions](https://github.com/open-telemetry/weaver/issues/215).
84+
6585
### Prerequisites
6686

6787
The Specification uses several tools to check things like style,

0 commit comments

Comments
 (0)