config-reference.md

Configuration reference

As output by bin/console config:dump-reference instrumentation.

# Default configuration for extension with alias: "instrumentation"
instrumentation:

    # Use semantic tags defined in the OpenTelemetry specification (https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md)
    resource:

        # Default:
        service.name:        app

        # Examples:
        service.name:        my-instrumented-app
        service.version:     1.2.3
    baggage:
        enabled:              true
    health:
        enabled:              true
        path:                 /_healthz
    logging:
        enabled:              true

        # Handlers to which the trace context processor should be bound
        handlers:

            # Defaults:
            - main
            - console
        keys:
            trace:                context.trace
            span:                 context.span
            sampled:              context.sampled
            operation:            context.operation
    tracing:
        enabled:              true

        # Allows you to have links to your traces generated in error messages and twig.
        trace_url:            ~ # Example: 'http://localhost:16682/trace/{traceId}'
        logs:

            # One of the Monolog\Logger levels.
            level:                200 # One of 100; 200; 250; 300; 400; 500; 550; 600
            channels:             []
        request:
            enabled:              true
            attributes:

                # Use the primary server name of the matched virtual host
                server_name:          null # Example: example.com
                headers:

                    # Examples:
                    - accept
                    - accept-encoding
            incoming_header:
                name:                 ~
                regex:                ~
            blacklist:

                # Defaults:
                - ^/_fragment
                - ^/_profiler
                - ^/_wdt
            methods:

                # Defaults:
                - GET
                - POST
                - PUT
                - DELETE
                - PATCH
        command:
            enabled:              true
            blacklist:

                # Defaults:
                - ^cache:clear$
                - ^assets:install$
        message:
            enabled:              true
            blacklist:            []
        doctrine:
            instrumentation:      true
            propagation:          true
            log_queries:          true
            connections:          []
    metrics:
        enabled:              true
        path:                 /metrics

        # Prefix added to all metrics.
        namespace:            ''
        storage:
            adapter:              apcu # One of "apc"; "apcu"; "redis"; "in_memory"

            # When using the redis adapter, set "instance" to a service id that is an instance of \Redis
            instance:             null

            # Set a prefix for Redis keys to avoid collisions, defaults to "metrics:<hostname>"
            prefix:               null
        metrics:

            # Prototype
            -
                name:                 ~ # Required
                help:                 ~ # Required
                type:                 ~ # One of "gauge"; "counter"; "histogram", Required
                labels:               []
                buckets:              []