Using OpenTelemetry schemas and tools

It does not really matter how we document custom semantic conventions. The goal is to have a consistent and specific convention that’s easy to read and follow. Let’s see how the OpenTelemetry semantic conventions schema may help with this.

Semantic conventions schema

So far, when we have talked about semantic conventions, we have referred to Markdown files such as https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md. These files are the source of truth, but here, we’re going to take a look at the implementation details behind them.

The tables describing the attributes in these files are usually auto-generated. Attributes are defined in YAML files that follow OpenTelemetry’s semantic convention schema.

YAML files could be shared across different semantic conventions and signals and then consistently written to all Markdown files with a script...