open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add README describing use of semantic convention YAML models (#980)

This commit is contained in:
Justin Foote 2020-09-23 07:08:31 -07:00 committed by GitHub
parent cb368a7a64
commit a319ffaf62
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
semantic_conventions/README.md Normal file
View File

@ -0,0 +1,28 @@
# 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](https://github.com/open-telemetry/build-tools/tree/master/semantic-conventions)
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:
* [Markdown Tables](https://github.com/open-telemetry/build-tools/tree/master/semantic-conventions#markdown-tables)
* [Code Generator](https://github.com/open-telemetry/build-tools/tree/master/semantic-conventions#code-generator)
## Description of the model
The fields and their expected values are presented in [syntax.md](./syntax.md).