Base interface for an OpenTelemetry tracer responsible for creating spans. More...

Public Member Functions
	createRootSpan (string $spanName)
	Create a new root span, i.e.

	createSpan (string $spanName)
	Create a span with the given name and the currently active span as the implicit parent.

	createSpanWithParent (string $spanName, SpanContext $parentSpanContext)
	Create a span with the given name and parent.

	shutdown ()
	Shut down this tracer and export collected trace data.

Detailed Description

Base interface for an OpenTelemetry tracer responsible for creating spans.

Definition at line 10 of file TracerInterface.php.

Member Function Documentation

Wikimedia\Telemetry\TracerInterface::createRootSpan ( string $spanName )

Create a new root span, i.e.

a span with no parent that forms the basis for a new trace.

Parameters

string $spanName The descriptive name of this span. Refer to the OTEL Tracing API spec for recommended naming conventions.

Wikimedia\Telemetry\TracerInterface::createSpan ( string $spanName )

Create a span with the given name and the currently active span as the implicit parent.

This requires a span to be already active and will throw an error otherwise.

Parameters

string $spanName The descriptive name of this span. Refer to the OTEL Tracing API spec for recommended naming conventions.

Exceptions

PreconditionException If no span was active

Wikimedia\Telemetry\TracerInterface::createSpanWithParent	(	string	$spanName,
		SpanContext	$parentSpanContext )

Create a span with the given name and parent.

Parameters

string	$spanName	The descriptive name of this span. Refer to the OTEL Tracing API spec for recommended naming conventions.
SpanContext	$parentSpanContext	Context of the parent span this span should be associated with.

Wikimedia\Telemetry\TracerInterface::shutdown ( )

Shut down this tracer and export collected trace data.

The documentation for this interface was generated from the following file: