class SdkBuilder
Hierarchy
- class \OpenTelemetry\SDK\SdkBuilder
Expanded class hierarchy of SdkBuilder
File
-
vendor/
open-telemetry/ sdk/ SdkBuilder.php, line 22
Namespace
OpenTelemetry\SDKView source
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);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
SdkBuilder::$autoShutdown | private | property | |
SdkBuilder::$eventLoggerProvider | private | property | |
SdkBuilder::$loggerProvider | private | property | |
SdkBuilder::$meterProvider | private | property | |
SdkBuilder::$propagator | private | property | |
SdkBuilder::$tracerProvider | private | property | |
SdkBuilder::build | public | function | |
SdkBuilder::buildAndRegisterGlobal | public | function | |
SdkBuilder::setAutoShutdown | public | function | Automatically shut down providers on process completion. If not set, the user is responsible for calling `shutdown`. |
SdkBuilder::setEventLoggerProvider | public | function | |
SdkBuilder::setLoggerProvider | public | function | |
SdkBuilder::setMeterProvider | public | function | |
SdkBuilder::setPropagator | public | function | |
SdkBuilder::setTracerProvider | public | function |