semantic-conventions/semantic_conventions
Christian Neumüller 1b0a64202d Lint YAML files (mainly semantic conventions). (#1814)
Co-authored-by: Armin Ruech <armin.ruech@dynatrace.com>
2021-07-15 10:12:05 +02:00
..
resource Lint YAML files (mainly semantic conventions). (#1814) 2021-07-15 10:12:05 +02:00
trace Lint YAML files (mainly semantic conventions). (#1814) 2021-07-15 10:12:05 +02:00
README.md AWS SDK common and dynamodb conventions (#1422) 2021-03-30 18:53:48 +02:00
syntax.md Update to latest semconv table generator to fix int enum issue (#1564) 2021-03-22 13:51:59 +01:00
version.properties YAML Model for Semantic Conventions (#571) 2020-08-27 13:18:51 -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.

Writing semantic conventions

Refer to the syntax for how to write the YAML files for semantic conventions.

Generation

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 semantic convention generator in the OpenTelemetry build tools repository. Using this build tool, it is also possible to generate code for use in OpenTelemetry language projects.

See also:

Description of the model

The fields and their expected values are presented in syntax.md.