@@ -199,5 +199,24 @@ to merge**.
199
199
- Send staging tag as PR for review.
200
200
- Create a tag ` v{version} ` on the merged PR and push remote.
201
201
202
+ ## Merging existing ECS conventions
203
+
204
+ The Elastic Common Schema (ECS) is being merged into OpenTelemetry Semantic
205
+ Conventions per [ OTEP 222] [ otep222 ] . When adding a semantic convention that
206
+ exists in some form in ECS, consider the following guidelines:
207
+
208
+ - Prefer using the existing ECS name when possible. In particular:
209
+ - If proposing a name that differs from the ECS convention, provide usage
210
+ data, user issue reports, feature requests, examples of prior work on a
211
+ different standard or comparable evidence about the alternatives.
212
+ - When no suitable alternatives are provided, altering an ECS name solely
213
+ for the purpose of complying with [ Name Pluralization guidelines] ( docs/general/attribute-naming.md#name-pluralization-guidelines )
214
+ MAY BE avoided.
215
+ - Do not use an existing ECS name as a namespace. If the name must differ, use a
216
+ different namespace name to avoid clashes or avoid using the namespace
217
+ entirely. See the [ ECS field reference] for existing namespaces.
218
+
202
219
[ nvm ] : https://github.com/nvm-sh/nvm/blob/master/README.md#installing-and-updating
203
220
[ stability guarantees ] : https://github.com/open-telemetry/opentelemetry-specification/blob/v1.26.0/specification/versioning-and-stability.md#semantic-conventions-stability
221
+ [ otep222 ] : https://github.com/open-telemetry/oteps/pull/222
222
+ [ ECS field reference ] : https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html
0 commit comments