Configuration Data Model

Status: Stable

• Overview
  • Versioning policy and stability guarantees
  • File-based configuration model
    • YAML file format
    • Environment variable substitution

Overview

The OpenTelemetry configuration data model is part of the declarative configuration interface.

The data model defines data structures which allow users to specify an intended configuration of OpenTelemetry SDK components and instrumentation.

The data model is defined in opentelemetry-configuration using JSON Schema.

The data model itself is an abstraction with multiple built-in representations:

• File-based configuration model
• SDK in-memory configuration model

Versioning policy and stability guarantees

See opentelemetry-configuration versioning policy.

File-based configuration model

A configuration file is a serialized file-based representation of the configuration data model.

Configuration files SHOULD use one the following serialization formats:

• YAML file format

YAML file format

YAML configuration files SHOULD follow YAML spec revision >= 1.2.

YAML configuration files SHOULD be parsed using v1.2 YAML core schema.

YAML configuration files MUST use file extensions .yaml or .yml.

Environment variable substitution

Configuration files support environment variables substitution for references, defined using the Augmented Backus-Naur Form:

SUBSTITUTION-REF = "${" [PREFIX ":"] GENERIC-SUBSTITUTION "}"; generic substitution reference