interface SpanProcessorInterface
@see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.6…
Hierarchy
- interface \OpenTelemetry\SDK\Trace\SpanProcessorInterface
Expanded class hierarchy of SpanProcessorInterface
All classes that implement SpanProcessorInterface
4 files declare their use of SpanProcessorInterface
- BatchSpanProcessor.php in vendor/
open-telemetry/ sdk/ Trace/ SpanProcessor/ BatchSpanProcessor.php - MultiSpanProcessor.php in vendor/
open-telemetry/ sdk/ Trace/ SpanProcessor/ MultiSpanProcessor.php - NoopSpanProcessor.php in vendor/
open-telemetry/ sdk/ Trace/ SpanProcessor/ NoopSpanProcessor.php - SimpleSpanProcessor.php in vendor/
open-telemetry/ sdk/ Trace/ SpanProcessor/ SimpleSpanProcessor.php
File
-
vendor/
open-telemetry/ sdk/ Trace/ SpanProcessorInterface.php, line 11
Namespace
OpenTelemetry\SDK\TraceView source
interface SpanProcessorInterface {
/**
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/specification/trace/sdk.md#onstart
*/
public function onStart(ReadWriteSpanInterface $span, ContextInterface $parentContext) : void;
/**
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/specification/trace/sdk.md#onendspan
*/
public function onEnd(ReadableSpanInterface $span) : void;
/**
* Export all ended spans to the configured Exporter that have not yet been exported.
* Returns `true` if the flush was successful, otherwise `false`.
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/specification/trace/sdk.md#forceflush-1
*/
public function forceFlush(?CancellationInterface $cancellation = null) : bool;
/**
* Cleanup; after shutdown, calling onStart, onEnd, or forceFlush is invalid
* Returns `false` is the processor is already shutdown, otherwise `true`.
*
* @see https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/specification/trace/sdk.md#shutdown-1
*/
public function shutdown(?CancellationInterface $cancellation = null) : bool;
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
SpanProcessorInterface::forceFlush | public | function | Export all ended spans to the configured Exporter that have not yet been exported. Returns `true` if the flush was successful, otherwise `false`. |
4 |
SpanProcessorInterface::onEnd | public | function | 4 | |
SpanProcessorInterface::onStart | public | function | 4 | |
SpanProcessorInterface::shutdown | public | function | Cleanup; after shutdown, calling onStart, onEnd, or forceFlush is invalid Returns `false` is the processor is already shutdown, otherwise `true`. |
4 |