History

Liudmila Molkova a3cf57fcc3 Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 ) Co-authored-by: Alexandra Konrad <alexandra.konrad@elastic.co>		2024-08-01 08:47:32 -07:00
..
logs	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
metrics	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
registry	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
resource	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
scope/exporter	Move otel.scope attributes to registry (#889 )	2024-04-05 14:56:30 +02:00
trace	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
README.md	Update build-tools version to 0.25.0 and add `display_name` to all registry attribute groups (#985 )	2024-07-15 11:58:37 +02:00
db-common.yaml	Mention how to capture collection and operation names from query text in the registry (#1070 )	2024-05-28 11:14:47 -07:00
faas-common.yaml	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
general.yaml	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
http-common.yaml	Added url.template to HTTP client attributes (#675 )	2024-05-07 09:40:30 -07:00
messaging-common.yaml	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
network.yaml	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
session.yaml	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
url.yaml	Remove prefix in yaml, add policy check to block future usages (and minor cleanups) (#1293 )	2024-08-01 08:47:32 -07:00
version.properties	Renamed `specification` and `semantic_conventions` to `model` and `docs` (#166 )	2023-07-06 11:43:47 -07:00

README.md

YAML Model for Semantic Conventions

The YAML descriptions of semantic convention contained in this directory are intended to be used by the various OpenTelemetry language implementations to aid in automatic generation of semantics-related code.

⚠ If you want to read the semantic conventions and not edit them, please see the generated markdown output in the docs folder.

Writing semantic conventions

Semantic conventions for the spec MUST adhere to the attribute naming, attribute requirement level, and metric requirement level conventions.

Refer to the syntax for how to write the YAML files for semantic conventions and what the YAML properties mean.

A schema file for VS code is configured in the /.vscode/settings.json of this repository, enabling auto-completion and additional checks. Refer to the generator README for what extension you need.

Generating markdown

These YAML files are used by the make target table-generation to generate consistently formatted Markdown tables for all semantic conventions in the specification. Run it from the root of this repository using the command

make table-generation

For more information, see the Weaver as our code generations tool. Using Weaver, it is also possible to generate code for use in OpenTelemetry language projects, in addition to build-tools.