Configuration

To get a full list of configuration options, run the following command:

bin/console config:dump-reference open_telemetry

Full configuration reference

# Default configuration for extension with alias: "open_telemetry"
open_telemetry:
    service:
        namespace:            ~ # Required, Example: MyOrganization
        name:                 ~ # Required, Example: MyApp
        version:              ~ # Required, Example: 1.0.0
        environment:          ~ # Required, Example: '%kernel.environment%'
    instrumentation:
        cache:
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
        console:
            type:                 auto # One of "auto"; "attribute"
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
        doctrine:
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
        http_client:
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
        http_kernel:
            type:                 auto # One of "auto"; "attribute"
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
        mailer:
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
        messenger:
            type:                 auto # One of "auto"; "attribute"
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
        twig:
            tracing:
                enabled:              false

                # The tracer to use, defaults to `traces.default_tracer` or first tracer in `traces.tracers`
                tracer:               ~
            metering:
                enabled:              false

                # The meter to use, defaults to `metrics.default_meter` or first meter in `metrics.meters`
                meter:                ~
    traces:
        tracers:

            # Prototype
            tracer:
                name:                 ~
                version:              ~
                provider:             ~ # Required
        providers:

            # Prototype
            provider:
                type:                 default # One of "default"; "noop", Required
                sampler:
                    type:                 always_on # One of "always_off"; "always_on"; "parent_based_always_off"; "parent_based_always_on"; "parent_based_trace_id_ratio"; "trace_id_ratio"; "attribute_based", Required
                    options:              []
                processors:           []
        processors:

            # Prototype
            processor:
                type:                 simple # One of "multi"; "simple"; "noop", Required

                # Required if processor type is multi
                processors:           []

                # Required if processor type is simple or batch
                exporter:             ~
        exporters:

            # Prototype
            exporter:
                dsn:                  ~ # Required
                options:
                    format:               json # One of "json"; "ndjson"; "gprc"; "protobuf"
                    compression:          none # One of "gzip"; "none"
                    headers:

                        # Prototype
                        -
                            name:                 ~ # Required
                            value:                ~ # Required
                    timeout:              0.1
                    retry:                100
                    max:                  3
                    ca:                   ~
                    cert:                 ~
                    key:                  ~
    metrics:
        meters:

            # Prototype
            meter:
                name:                 ~
                provider:             ~ # Required
        providers:

            # Prototype
            provider:
                type:                 default # One of "noop"; "default", Required
                exporter:             ~
                filter:               none # One of "all"; "none"; "with_sampled_trace"
        exporters:

            # Prototype
            exporter:
                dsn:                  ~ # Required
                temporality:          delta # One of "delta"; "cumulative"; "low_memory"
                options:
                    format:               json # One of "json"; "ndjson"; "gprc"; "protobuf"
                    compression:          none # One of "gzip"; "none"
                    headers:

                        # Prototype
                        -
                            name:                 ~ # Required
                            value:                ~ # Required
                    timeout:              0.1
                    retry:                100
                    max:                  3
                    ca:                   ~
                    cert:                 ~
                    key:                  ~
    logs:
        monolog:
            enabled:              false
            handlers:

                # Prototype
                handler:
                    provider:             ~ # Required
                    level:                debug # One of "debug"; "info"; "notice"; "warning"; "error"; "critical"; "alert"; "emergency"
                    bubble:               true
        loggers:

            # Prototype
            logger:
                name:                 ~
                version:              ~
                provider:             ~ # Required
        providers:

            # Prototype
            provider:
                type:                 default # One of "default"; "noop", Required
                processor:            ~
        processors:

            # Prototype
            processor:
                type:                 simple # One of "multi"; "noop"; "simple", Required

                # Required if processor type is multi
                processors:           []

                # Required if processor type is simple
                exporter:             ~
        exporters:

            # Prototype
            exporter:
                dsn:                  ~ # Required
                options:
                    format:               json # One of "json"; "ndjson"; "gprc"; "protobuf"
                    compression:          none # One of "gzip"; "none"
                    headers:

                        # Prototype
                        -
                            name:                 ~ # Required
                            value:                ~ # Required
                    timeout:              0.1
                    retry:                100
                    max:                  3
                    ca:                   ~
                    cert:                 ~
                    key:                  ~

Note: The configuration reference is generated from the bundle's source code. It is always up-to-date with the latest version of the bundle.