semantic-conventions/semantic_conventions
Giovanni Liva 9315f21f9d Add telemetry and service yaml (#1026) 2020-09-30 17:16:04 -07:00
..
resource Add telemetry and service yaml (#1026) 2020-09-30 17:16:04 -07:00
trace Add yaml semantic conventions for Messaging (#926) 2020-09-29 14:34:02 +02:00
README.md Add README describing use of semantic convention YAML models (#980) 2020-09-23 16:08:31 +02:00
syntax.md YAML Model for Semantic Conventions (#571) 2020-08-27 13:18:51 -07: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.

Generation

These YAML files are used by the make target table-generation to generate consistently formattted 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.