sdk-migration-config.yaml

# sdk-migration-config.yaml is a typical starting point for configuring the SDK when migrating
# from environment variable based configuration.
#
# This template includes env var substitution references (i.e. ${MY_ENV}) for all spec defined
# env vars (https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/)
# which map cleanly to declarative configuration. For example, OTEL_SDK_DISABLED is referenced
# below, but OTEL_TRACES_EXPORTER is not since it does not map well to the hierarchical
# structure of declarative configuration.
#
# NOTE: With the exception of env var substitution syntax, SDKs ignore environment variables
# when interpreting config files. For example, if "disabled: ${OTEL_SDK_DISABLED:-false}"
# is replaced with "disabled: false", then setting the env var OTEL_SDK_DISABLED will have
# no effect. See https://opentelemetry.io/docs/specs/otel/configuration/data-model/
# for more information. The following spec defined env vars are NOT referenced and are thus
# ignored:
#
# - OTEL_TRACES_SAMPLER
# - OTEL_TRACES_SAMPLER_ARG
# - OTEL_EXPORTER_ZIPKIN_ENDPOINT
# - OTEL_EXPORTER_ZIPKIN_TIMEOUT
# - OTEL_EXPORTER_PROMETHEUS_HOST
# - OTEL_EXPORTER_PROMETHEUS_PORT
# - OTEL_TRACES_EXPORTER
# - OTEL_METRICS_EXPORTER
# - OTEL_LOGS_EXPORTER
# - OTEL_EXPORTER_OTLP_PROTOCOL, OTEL_EXPORTER_OTLP_{SIGNAL}_PROTOCOL
# - OTEL_EXPORTER_OTLP_ENDPOINT
# - OTEL_EXPORTER_OTLP_INSECURE, OTEL_EXPORTER_OTLP_{SIGNAL}_INSECURE
# - OTEL_EXPORTER_OTLP_CERTIFICATE
# - OTEL_EXPORTER_OTLP_CLIENT_KEY
# - OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE
# - OTEL_EXPORTER_OTLP_COMPRESSION
# - OTEL_EXPORTER_OTLP_TIMEOUT

# The file format version.
# The yaml format is documented at
# https://github.com/open-telemetry/opentelemetry-configuration/tree/main/schema
file_format: "0.4"
# Configure if the SDK is disabled or not.
# If omitted or null, false is used.
disabled: ${OTEL_SDK_DISABLED:-false}
# Configure the log level of the internal logger used by the SDK.
# If omitted, info is used.
log_level: ${OTEL_LOG_LEVEL:-info}
# Configure resource for all signals.
# If omitted, the default resource is used.
resource:
  # Configure resource attributes. Entries have higher priority than entries from .resource.attributes_list.
  # Entries must contain .name and .value, and may optionally include .type. If an entry's .type omitted or null, string is used.
  # The .value's type must match the .type. Values for .type include: string, bool, int, double, string_array, bool_array, int_array, double_array.
  attributes:
    - name: service.name
      value: ${OTEL_SERVICE_NAME:-unknown_service}
  # Configure resource attributes. Entries have lower priority than entries from .resource.attributes.
  # The value is a list of comma separated key-value pairs matching the format of OTEL_RESOURCE_ATTRIBUTES. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
  # If omitted or null, no resource attributes are added.
  attributes_list: ${OTEL_RESOURCE_ATTRIBUTES}
# Configure general attribute limits. See also tracer_provider.limits, logger_provider.limits.
attribute_limits:
  # Configure max attribute value size. 
  # Value must be non-negative.
  # If omitted or null, there is no limit.
  attribute_value_length_limit: ${OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT}
  # Configure max attribute count. 
  # Value must be non-negative.
  # If omitted or null, 128 is used.
  attribute_count_limit: ${OTEL_ATTRIBUTE_COUNT_LIMIT:-128}
# Configure text map context propagators.
# If omitted, a noop propagator is used.
propagator:
  # Configure the propagators in the composite text map propagator. Entries from .composite_list are appended to the list here with duplicates filtered out.
  # Built-in propagator keys include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party keys include: xray. 
  # If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.
  composite: []
  # Configure the propagators in the composite text map propagator. Entries are appended to .composite with duplicates filtered out.
  # The value is a comma separated list of propagator identifiers matching the format of OTEL_PROPAGATORS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#general-sdk-configuration for details.
  # Built-in propagator identifiers include: tracecontext, baggage, b3, b3multi, jaeger, ottrace. Known third party identifiers include: xray. 
  # If the resolved list of propagators (from .composite and .composite_list) is empty, a noop propagator is used.
  composite_list: ${OTEL_PROPAGATORS:-tracecontext,baggage}
# Configure tracer provider.
# If omitted, a noop tracer provider is used.
tracer_provider:
  # Configure span processors.
  processors:
    - # Configure a batch span processor.
      batch:
        # Configure delay interval (in milliseconds) between two consecutive exports. 
        # Value must be non-negative.
        # If omitted or null, 5000 is used.
        schedule_delay: ${OTEL_BSP_SCHEDULE_DELAY:-5000}
        # Configure maximum allowed time (in milliseconds) to export data. 
        # Value must be non-negative. A value of 0 indicates no limit (infinity).
        # If omitted or null, 30000 is used.
        export_timeout: ${OTEL_BSP_EXPORT_TIMEOUT:-30000}
        # Configure maximum queue size. Value must be positive.
        # If omitted or null, 2048 is used.
        max_queue_size: ${OTEL_BSP_MAX_QUEUE_SIZE:-2048}
        # Configure maximum batch size. Value must be positive.
        # If omitted or null, 512 is used.
        max_export_batch_size: ${OTEL_BSP_MAX_EXPORT_BATCH_SIZE:-512}
        # Configure exporter.
        exporter:
          # Configure exporter to be OTLP with HTTP transport.
          otlp_http:
            # Configure endpoint, including the trace specific path.
            # If omitted or null, http://localhost:4318/v1/traces is used.
            endpoint: ${OTEL_EXPORTER_OTLP_TRACES_ENDPOINT:-http://localhost:4318/v1/traces}
            # Configure certificate used to verify a server's TLS credentials. 
            # Absolute path to certificate file in PEM format.
            # If omitted or null, system default certificate verification is used for secure connections.
            certificate_file: ${OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE}
            # Configure mTLS private client key. 
            # Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
            # If omitted or null, mTLS is not used.
            client_key_file: ${OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY}
            # Configure mTLS client certificate. 
            # Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
            # If omitted or null, mTLS is not used.
            client_certificate_file: ${OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE}
            # Configure compression.
            # Values include: gzip, none. Implementations may support other compression algorithms.
            # If omitted or null, none is used.
            compression: ${OTEL_EXPORTER_OTLP_TRACES_COMPRESSION:-gzip}
            # Configure max time (in milliseconds) to wait for each export. 
            # Value must be non-negative. A value of 0 indicates no limit (infinity).
            # If omitted or null, 10000 is used.
            timeout: ${OTEL_EXPORTER_OTLP_TRACES_TIMEOUT:-10000}
            # Configure headers. Entries have higher priority than entries from .headers_list.
            # If an entry's .value is null, the entry is ignored.
            headers: []
            # Configure headers. Entries have lower priority than entries from .headers.
            # The value is a list of comma separated key-value pairs matching the format of OTEL_EXPORTER_OTLP_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details.
            # If omitted or null, no headers are added.
            headers_list: ${OTEL_EXPORTER_OTLP_TRACES_HEADERS}
  # Configure span limits. See also attribute_limits.
  limits:
    # Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. 
    # Value must be non-negative.
    # If omitted or null, there is no limit.
    attribute_value_length_limit: ${OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT}
    # Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. 
    # Value must be non-negative.
    # If omitted or null, 128 is used.
    attribute_count_limit: ${OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT:-128}
    # Configure max span event count. 
    # Value must be non-negative.
    # If omitted or null, 128 is used.
    event_count_limit: ${OTEL_SPAN_EVENT_COUNT_LIMIT:-128}
    # Configure max span link count. 
    # Value must be non-negative.
    # If omitted or null, 128 is used.
    link_count_limit: ${OTEL_SPAN_LINK_COUNT_LIMIT:-128}
    # Configure max attributes per span event. 
    # Value must be non-negative.
    # If omitted or null, 128 is used.
    event_attribute_count_limit: ${OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT:-128}
    # Configure max attributes per span link. 
    # Value must be non-negative.
    # If omitted or null, 128 is used.
    link_attribute_count_limit: ${OTEL_LINK_ATTRIBUTE_COUNT_LIMIT:-128}
  # Configure the sampler.
  # If omitted, parent based sampler with a root of always_on is used.
  sampler:
    # Configure sampler to be parent_based.
    parent_based:
      # Configure root sampler.
      # If omitted or null, always_on is used.
      root:
        # Configure sampler to be always_on.
        always_on:
      # Configure remote_parent_sampled sampler.
      # If omitted or null, always_on is used.
      remote_parent_sampled:
        # Configure sampler to be always_on.
        always_on:
      # Configure remote_parent_not_sampled sampler.
      # If omitted or null, always_off is used.
      remote_parent_not_sampled:
        # Configure sampler to be always_off.
        always_off:
      # Configure local_parent_sampled sampler.
      # If omitted or null, always_on is used.
      local_parent_sampled:
        # Configure sampler to be always_on.
        always_on:
      # Configure local_parent_not_sampled sampler.
      # If omitted or null, always_off is used.
      local_parent_not_sampled:
        # Configure sampler to be always_off.
        always_off:


# Configure meter provider.
# If omitted, a noop meter provider is used.
meter_provider:
  # Configure metric readers.
  readers:
    - # Configure a periodic metric reader.
      periodic:
        # Configure delay interval (in milliseconds) between start of two consecutive exports. 
        # Value must be non-negative.
        # If omitted or null, 60000 is used.
        interval: ${OTEL_METRIC_EXPORT_INTERVAL:-60000}
        # Configure maximum allowed time (in milliseconds) to export data. 
        # Value must be non-negative. A value of 0 indicates no limit (infinity).
        # If omitted or null, 30000 is used.
        timeout: ${OTEL_METRIC_EXPORT_TIMEOUT:-30000}
        # Configure exporter.
        exporter:
          # Configure exporter to be OTLP with HTTP transport.
          otlp_http:
            # Configure endpoint, including the metric specific path.
            # If omitted or null, http://localhost:4318/v1/metrics is used.
            endpoint: ${OTEL_EXPORTER_OTLP_METRICS_ENDPOINT:-http://localhost:4318/v1/metrics}
            # Configure certificate used to verify a server's TLS credentials. 
            # Absolute path to certificate file in PEM format.
            # If omitted or null, system default certificate verification is used for secure connections.
            certificate_file: ${OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE}
            # Configure mTLS private client key. 
            # Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
            # If omitted or null, mTLS is not used.
            client_key_file: ${OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY}
            # Configure mTLS client certificate. 
            # Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
            # If omitted or null, mTLS is not used.
            client_certificate_file: ${OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE}
            # Configure compression.
            # Values include: gzip, none. Implementations may support other compression algorithms.
            # If omitted or null, none is used.
            compression: ${OTEL_EXPORTER_OTLP_METRICS_COMPRESSION:-gzip}
            # Configure max time (in milliseconds) to wait for each export. 
            # Value must be non-negative. A value of 0 indicates no limit (infinity).
            # If omitted or null, 10000 is used.
            timeout: ${OTEL_EXPORTER_OTLP_METRICS_TIMEOUT:-10000}
            # Configure headers. Entries have higher priority than entries from .headers_list.
            # If an entry's .value is null, the entry is ignored.
            headers: []
            # Configure headers. Entries have lower priority than entries from .headers.
            # The value is a list of comma separated key-value pairs matching the format of OTEL_EXPORTER_OTLP_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details.
            # If omitted or null, no headers are added.
            headers_list: ${OTEL_EXPORTER_OTLP_METRICS_HEADERS}
            # Configure temporality preference. 
            # Values include: cumulative, delta, low_memory. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
            # If omitted or null, cumulative is used.
            temporality_preference: ${OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE:-cumulative}
            # Configure default histogram aggregation. 
            # Values include: explicit_bucket_histogram, base2_exponential_bucket_histogram. For behavior of values, see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk_exporters/otlp.md.
            # If omitted or null, explicit_bucket_histogram is used.
            default_histogram_aggregation: ${OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION:-explicit_bucket_histogram}
  # Configure the exemplar filter. 
  # Values include: trace_based, always_on, always_off. For behavior of values see https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#metrics-sdk-configuration.
  # If omitted or null, trace_based is used.
  exemplar_filter: ${OTEL_METRICS_EXEMPLAR_FILTER:-trace_based}
# Configure logger provider.
# If omitted, a noop logger provider is used.
logger_provider:
  # Configure log record processors.
  processors:
    - # Configure a batch log record processor.
      batch:
        # Configure delay interval (in milliseconds) between two consecutive exports. 
        # Value must be non-negative.
        # If omitted or null, 1000 is used.
        schedule_delay: ${OTEL_BLRP_SCHEDULE_DELAY:-1000}
        # Configure maximum allowed time (in milliseconds) to export data. 
        # Value must be non-negative. A value of 0 indicates no limit (infinity).
        # If omitted or null, 30000 is used.
        export_timeout: ${OTEL_BLRP_EXPORT_TIMEOUT:-30000}
        # Configure maximum queue size. Value must be positive.
        # If omitted or null, 2048 is used.
        max_queue_size: ${OTEL_BLRP_MAX_QUEUE_SIZE:-2048}
        # Configure maximum batch size. Value must be positive.
        # If omitted or null, 512 is used.
        max_export_batch_size: ${OTEL_BLRP_MAX_EXPORT_BATCH_SIZE:-512}
        # Configure exporter.
        exporter:
          # Configure exporter to be OTLP with HTTP transport.
          otlp_http:
            endpoint: ${OTEL_EXPORTER_OTLP_LOGS_ENDPOINT:-http://localhost:4318/v1/logs}
            # Configure certificate used to verify a server's TLS credentials. 
            # Absolute path to certificate file in PEM format.
            # If omitted or null, system default certificate verification is used for secure connections.
            certificate_file: ${OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE}
            # Configure mTLS private client key. 
            # Absolute path to client key file in PEM format. If set, .client_certificate must also be set.
            # If omitted or null, mTLS is not used.
            client_key_file: ${OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY}
            # Configure mTLS client certificate. 
            # Absolute path to client certificate file in PEM format. If set, .client_key must also be set.
            # If omitted or null, mTLS is not used.
            client_certificate_file: ${OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE}
            # Configure compression.
            # Values include: gzip, none. Implementations may support other compression algorithms.
            # If omitted or null, none is used.
            compression: ${OTEL_EXPORTER_OTLP_LOGS_COMPRESSION:-gzip}
            # Configure max time (in milliseconds) to wait for each export. 
            # Value must be non-negative. A value of 0 indicates no limit (infinity).
            # If omitted or null, 10000 is used.
            timeout: ${OTEL_EXPORTER_OTLP_LOGS_TIMEOUT:-10000}
            # Configure headers. Entries have higher priority than entries from .headers_list.
            # If an entry's .value is null, the entry is ignored.
            headers: []
            # Configure headers. Entries have lower priority than entries from .headers.
            # The value is a list of comma separated key-value pairs matching the format of OTEL_EXPORTER_OTLP_HEADERS. See https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options for details.
            # If omitted or null, no headers are added.
            headers_list: ${OTEL_EXPORTER_OTLP_LOGS_HEADERS}
  # Configure log record limits. See also attribute_limits.
  limits:
    # Configure max attribute value size. Overrides .attribute_limits.attribute_value_length_limit. 
    # Value must be non-negative.
    # If omitted or null, there is no limit.
    attribute_value_length_limit: ${OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT}
    # Configure max attribute count. Overrides .attribute_limits.attribute_count_limit. 
    # Value must be non-negative.
    # If omitted or null, 128 is used.
    attribute_count_limit: ${OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT:-128}