History

Alexander Wert 4e7c42ee8e Update build-tools version to 0.25.0 and add `display_name` to all registry attribute groups (#985 ) Signed-off-by: Alexander Wert <alexander.wert@elastic.co>		2024-07-15 11:58:37 +02:00
..
logs	Add 'log.record.original' attribute (#1217 )	2024-07-11 23:10:55 +00:00
metrics	Add v8 js engine runtime metrics semantic conventions (#1066 )	2024-07-08 07:25:55 -07:00
registry	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
resource	remove k8s.container.status.current_waiting_reason resource attribute (#1115 )	2024-06-04 07:01:03 -07:00
scope/exporter	Move otel.scope attributes to registry (#889 )	2024-04-05 14:56:30 +02:00
trace	Define sampling relevant attributes for database client spans (#1166 )	2024-07-11 22:45:52 +00: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	move faas to registry (#525 )	2024-03-07 09:04:52 -08:00
general.yaml	[chore] Add registry prefix to registry namespaces that missing it (#851 )	2024-04-03 13:58:09 +02:00
http-common.yaml	Added url.template to HTTP client attributes (#675 )	2024-05-07 09:40:30 -07:00
messaging-common.yaml	Revamp messaging metrics to support generic operations (#1006 )	2024-06-14 14:39:47 -07:00
network.yaml	Moved network attributes to the registry (#390 )	2023-10-19 14:16:04 +02:00
session.yaml	[chore] Move Session to registry (#843 )	2024-04-03 14:07:31 +02:00
url.yaml	Move url to the registry (#400 )	2023-10-18 12:59:44 +02: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.