Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x

SdkBuilder.php

Namespace

OpenTelemetry\SDK

File

vendor/open-telemetry/sdk/SdkBuilder.php

View source
<?php

declare (strict_types=1);
namespace OpenTelemetry\SDK;

use OpenTelemetry\API\Instrumentation\Configurator;
use OpenTelemetry\API\Logs\EventLoggerProviderInterface;
use OpenTelemetry\API\Logs\NoopEventLoggerProvider;
use OpenTelemetry\Context\Context;
use OpenTelemetry\Context\Propagation\NoopTextMapPropagator;
use OpenTelemetry\Context\Propagation\TextMapPropagatorInterface;
use OpenTelemetry\Context\ScopeInterface;
use OpenTelemetry\SDK\Common\Util\ShutdownHandler;
use OpenTelemetry\SDK\Logs\LoggerProviderInterface;
use OpenTelemetry\SDK\Logs\NoopLoggerProvider;
use OpenTelemetry\SDK\Metrics\MeterProviderInterface;
use OpenTelemetry\SDK\Metrics\NoopMeterProvider;
use OpenTelemetry\SDK\Trace\NoopTracerProvider;
use OpenTelemetry\SDK\Trace\TracerProviderInterface;
class SdkBuilder {
    private ?TracerProviderInterface $tracerProvider = null;
    private ?MeterProviderInterface $meterProvider = null;
    private ?LoggerProviderInterface $loggerProvider = null;
    private ?EventLoggerProviderInterface $eventLoggerProvider = null;
    private ?TextMapPropagatorInterface $propagator = null;
    private bool $autoShutdown = false;
    
    /**
     * Automatically shut down providers on process completion. If not set, the user is responsible for calling `shutdown`.
     */
    public function setAutoShutdown(bool $shutdown) : self {
        $this->autoShutdown = $shutdown;
        return $this;
    }
    public function setTracerProvider(TracerProviderInterface $provider) : self {
        $this->tracerProvider = $provider;
        return $this;
    }
    public function setMeterProvider(MeterProviderInterface $meterProvider) : self {
        $this->meterProvider = $meterProvider;
        return $this;
    }
    public function setLoggerProvider(LoggerProviderInterface $loggerProvider) : self {
        $this->loggerProvider = $loggerProvider;
        return $this;
    }
    public function setEventLoggerProvider(EventLoggerProviderInterface $eventLoggerProvider) : self {
        $this->eventLoggerProvider = $eventLoggerProvider;
        return $this;
    }
    public function setPropagator(TextMapPropagatorInterface $propagator) : self {
        $this->propagator = $propagator;
        return $this;
    }
    public function build() : Sdk {
        $tracerProvider = $this->tracerProvider ?? new NoopTracerProvider();
        $meterProvider = $this->meterProvider ?? new NoopMeterProvider();
        $loggerProvider = $this->loggerProvider ?? new NoopLoggerProvider();
        $eventLoggerProvider = $this->eventLoggerProvider ?? new NoopEventLoggerProvider();
        if ($this->autoShutdown) {
            // rector rule disabled in config, because ShutdownHandler::register() does not keep a strong reference to $this
            ShutdownHandler::register($tracerProvider->shutdown(...));
            ShutdownHandler::register($meterProvider->shutdown(...));
            ShutdownHandler::register($loggerProvider->shutdown(...));
        }
        return new Sdk($tracerProvider, $meterProvider, $loggerProvider, $eventLoggerProvider, $this->propagator ?? NoopTextMapPropagator::getInstance());
    }
    public function buildAndRegisterGlobal() : ScopeInterface {
        $sdk = $this->build();
        $context = Configurator::create()->withPropagator($sdk->getPropagator())
            ->withTracerProvider($sdk->getTracerProvider())
            ->withMeterProvider($sdk->getMeterProvider())
            ->withLoggerProvider($sdk->getLoggerProvider())
            ->withEventLoggerProvider($sdk->getEventLoggerProvider())
            ->storeInContext();
        return Context::storage()->attach($context);
    }

}

Classes

Title Deprecated Summary
SdkBuilder

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal