Nexus API Reference

OtelObservability
in package
implements Observability

Read onlyYes
FinalYes
Tags
psalm-api

OpenTelemetry-backed Observability provider. Owns the SDK providers so telemetry can be flushed/shut down (wired into the actor-system lifecycle by a later plan).

Table of Contents

Interfaces

Observability

Methods

__construct()  : mixed
currentContext()  : Context
Returns the ambient active context — the span currently in scope — for injection into outgoing carriers (message metadata / HTTP headers).
forceFlush()  : void
isEnabled()  : bool
Whether a real telemetry backend is wired. When false, instrumentation call sites should skip work entirely (zero overhead).
meter()  : Meter
propagator()  : ContextPropagator
shutdown()  : void
Flush pending telemetry and stop the provider. Called once during application shutdown; a no-op provider does nothing.
tracer()  : Tracer

Methods

__construct()

public __construct(TracerProviderInterface $tracerProvider, MeterProviderInterface $meterProvider, ContextPropagator $propagator[, string $instrumentationScope = 'nexus' ]) : mixed
Parameters
$tracerProvider : TracerProviderInterface
$meterProvider : MeterProviderInterface
$propagator : ContextPropagator
$instrumentationScope : string = 'nexus'

currentContext()

Returns the ambient active context — the span currently in scope — for injection into outgoing carriers (message metadata / HTTP headers).

public currentContext() : Context
Return values
Context

isEnabled()

Whether a real telemetry backend is wired. When false, instrumentation call sites should skip work entirely (zero overhead).

public isEnabled() : bool
Return values
bool

shutdown()

Flush pending telemetry and stop the provider. Called once during application shutdown; a no-op provider does nothing.

public shutdown() : void

        
On this page

Search results