Skip to content

Latest commit

 

History

History
76 lines (47 loc) · 1.84 KB

semantic-conventions.md

File metadata and controls

76 lines (47 loc) · 1.84 KB
Raw

Semantic Conventions

Tooling

The following files

are generated automatically.

The source data is in YAML format, located in the specification.

A code generator parses the YAML data from the specs, and generate code for various languages using a template engine.

For opentelemetry-cpp, the templates are located in buildscripts.

A generate.sh script downloads the specs, invokes the generator using Docker, and generates code for opentelemetry-cpp.

Instructions

Find latest specifications

Check for the latest specification release, and note the release tag number.

For example, tag v1.12.0

Use latest specifications

Set the SEMCONV_VERSION number in the generate.sh script.

For example,

SEMCONV_VERSION=1.12.0

Generate code

Run the generate.sh script.

Inspect the generated files, to verify they were updated (check the version number in SCHEMA_URL).

For example,

static constexpr const char *SCHEMA_URL = "https://opentelemetry.io/schemas/1.12.0";

Format code

Apply clang-format.

Update CHANGELOG

Add a CHANGELOG entry for the semantic conventions.

For example,

* [SEMANTIC CONVENTIONS] Upgrade to version 1.12.0

Commit

Commit and file a pull request.