JSON Schema Definitions for OpenTelemetry Declarative Configuration

This repository contains the JSON schema definitions of the OpenTelemetry declarative configuration data model.

JSON schema was chosen in part because of the large ecosystem of tools for things like code generation, validation, IDE integration, etc.

Project organization

• opentelemetry_configuration.json: the complete compiled JSON schema
• schema-docs.md: generated documentation for the schema and language implementation status, optimized for human consumption
• /schema: the source schema and language implementation status tracking files (see CONTRIBUTING.md for more details)
• /examples: sample configuration files (see starter templates for more details)
• /validator: a tool which performs env var substitution on YAML, validates YAML against the schema, and outputs to JSON or YAML

Starter templates

The examples directory contains a variety of sample configuration files to help get started and illustrate useful patterns. The following are noteworthy:

• getting-started.yaml: A typical default configuration file to get started with declarative configuration. This is a good starting point if you are new to declarative configuration.

• sdk-migration-config.yaml: Includes env var substitution references to all standard env vars which map cleanly to declarative configuration (see notes in the example for the set of env vars that are not referenced). Note, SDKs parsing configuration files ignore all env vars besides those referenced via env var substitution. This is a great starting point for transitioning from env var based configuration to file based configuration.

• sdk-config.yaml: Represents a comprehensive default configuration. This is a good starting point if you wish to have a template with more settings than getting-started.yaml and you are not using env var based configuration or wish to transition fully to file based configuration. Note, SDKs parsing configuration files ignore all env vars besides those referenced via env var substitution.

Versioning policy

See VERSIONING.md

Contributing

See CONTRIBUTING.md

Releases

See RELEASING.MD and releases

Maintainers

• Alex Boten, Honeycomb
• Jack Berg, Grafana Labs
• Tristan Sloughter, MyDecisiveAI
• Tyler Yahn, Splunk

For more information about the maintainer role, see the community repository.

Approvers

• Brett McBride, Deakin University
• Marc Alff, Oracle

For more information about the approver role, see the community repository.