opentelemetry.sdk.trace.export¶

class opentelemetry.sdk.trace.export.SpanExportResult[source]¶

Bases: enum.Enum

An enumeration.

SUCCESS = 0¶

FAILURE = 1¶

class opentelemetry.sdk.trace.export.SpanExporter[source]¶

Bases: object

Interface for exporting spans.

Interface to be implemented by services that want to export recorded in its own format.

To export data this MUST be registered to the :class`opentelemetry.sdk.trace.Tracer` using a SimpleExportSpanProcessor or a BatchExportSpanProcessor.

export(spans)[source]¶

Exports a batch of telemetry data.

Parameters: spans (Sequence[Span]) – The list of opentelemetry.trace.Span objects to be exported
Return type: SpanExportResult
Returns: The result of the export

shutdown()[source]¶

Shuts down the exporter.

Called when the SDK is shut down.

Return type: None

class opentelemetry.sdk.trace.export.SimpleExportSpanProcessor(span_exporter)[source]¶

Bases: opentelemetry.sdk.trace.SpanProcessor

Simple SpanProcessor implementation.

SimpleExportSpanProcessor is an implementation of SpanProcessor that passes ended spans directly to the configured SpanExporter.

on_start(span)[source]¶

Called when a opentelemetry.trace.Span is started.

This method is called synchronously on the thread that starts the span, therefore it should not block or throw an exception.

Parameters: span (Span) – The opentelemetry.trace.Span that just started.
Return type: None

on_end(span)[source]¶

Called when a opentelemetry.trace.Span is ended.

This method is called synchronously on the thread that ends the span, therefore it should not block or throw an exception.

Parameters: span (Span) – The opentelemetry.trace.Span that just ended.
Return type: None

shutdown()[source]¶

Called when a opentelemetry.sdk.trace.Tracer is shutdown.

Return type: None

force_flush(timeout_millis=30000)[source]¶

Export all ended spans to the configured Exporter that have not yet been exported.

Parameters: timeout_millis (int) – The maximum amount of time to wait for spans to be exported.
Return type: bool
Returns: False if the timeout is exceeded, True otherwise.

class opentelemetry.sdk.trace.export.BatchExportSpanProcessor(span_exporter, max_queue_size=2048, schedule_delay_millis=5000, max_export_batch_size=512)[source]¶

Bases: opentelemetry.sdk.trace.SpanProcessor

Batch span processor implementation.

BatchExportSpanProcessor is an implementation of SpanProcessor that batches ended spans and pushes them to the configured SpanExporter.

on_start(span)[source]¶

Called when a opentelemetry.trace.Span is started.

This method is called synchronously on the thread that starts the span, therefore it should not block or throw an exception.

Parameters: span (Span) – The opentelemetry.trace.Span that just started.
Return type: None

on_end(span)[source]¶

Called when a opentelemetry.trace.Span is ended.

This method is called synchronously on the thread that ends the span, therefore it should not block or throw an exception.

Parameters: span (Span) – The opentelemetry.trace.Span that just ended.
Return type: None

worker()[source]¶

export()[source]¶

Exports at most max_export_batch_size spans.

Return type: None

force_flush(timeout_millis=30000)[source]¶

Export all ended spans to the configured Exporter that have not yet been exported.

Parameters: timeout_millis (int) – The maximum amount of time to wait for spans to be exported.
Return type: bool
Returns: False if the timeout is exceeded, True otherwise.

shutdown()[source]¶

Called when a opentelemetry.sdk.trace.Tracer is shutdown.

Return type: None

class opentelemetry.sdk.trace.export.ConsoleSpanExporter(out=<_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>, formatter=<function ConsoleSpanExporter.<lambda>>)[source]¶

Bases: opentelemetry.sdk.trace.export.SpanExporter

Implementation of SpanExporter that prints spans to the console.

This class can be used for diagnostic purposes. It prints the exported spans to the console STDOUT.

export(spans)[source]¶

Exports a batch of telemetry data.

Parameters: spans (Sequence[Span]) – The list of opentelemetry.trace.Span objects to be exported
Return type: SpanExportResult
Returns: The result of the export