tracecontext.md

TraceContext setup

With the default traceContext setup, tracing will be configured according to the W3C TraceContext specification.
Incoming request data will be taken from the traceparent/tracestate headers, this data will be updated and passed to messenger and httpclient requests.

Configuration

# /config/packages/symfony-trace-bundle.php
<?php
declare(strict_types=1);

use DR\SymfonyTraceBundle\TraceStorage;
use Sentry\State\HubInterface;
use Symfony\Config\SymfonyTraceConfig;

return static function (SymfonyTraceConfig $config): void {
    // Whether to trust the incoming request header. This is turned on by default.
    // If true a value in the `traceparent` header in the request
    // will be used and parsed to get the trace ID for the rest of the request. If false
    // those values are ignored and new trace ID's are generated.
    $config->request()
        ->trustHeader(true)
        ->trustedIps(env('TRUSTED_IPS')); // Only trust the header from these IP's

    // Whether to send the trace details in the response headers. This is turned on by default.
    $config->response()
        ->sendHeader(true)
        ->trustedIps(env('TRUSTED_IPS')); // Only send the header to these IP's

    // The service key of an object that implements
    // DR\SymfonyTraceBundle\TraceStorageInterface
    // Defaults to TraceStorage::class
    $config->storageService(TraceStorage::class);

    // Whether to add the monolog process, defaults to true
    $config->enableMonolog(true);
    
    // Whether to add the request id to console commands, defaults to true
    $config->console()->enabled(true);
    
    // Optional, set console trace id based on env var. defaults to null
    $config->console()->traceId(env('TRACE_ID'));
    
    // Whether to add the request id to message bus events, defaults to false
    $config->enableMessenger(false);
    
    // Whether to add the twig extension, defaults to true
    $config->enableTwig(true);
    
    // Whether to pass traceparent & tracestate to outgoing http requests, defaults to false
    $config->httpClient()
        ->enabled(true)
        ->tagDefaultClient(false);
        
    // Whether to enable passing trace and transaction id to Sentry. Defaults to false.        
    $config->sentry()
        ->enabled(true)
        ->hubService(HubInterface::class);
};