opentelemetry.sdk.trace.export¶
-
class
opentelemetry.sdk.trace.export.
SpanExportResult
(value)[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 spans recorded in their own format.
To export data this MUST be registered to the :class`opentelemetry.sdk.trace.Tracer` using a
SimpleSpanProcessor
or aBatchSpanProcessor
.-
export
(spans)[source]¶ Exports a batch of telemetry data.
- Parameters
spans (
Sequence
[ReadableSpan
]) – The list ofopentelemetry.trace.Span
objects to be exported- Return type
- Returns
The result of the export
-
-
class
opentelemetry.sdk.trace.export.
SimpleSpanProcessor
(span_exporter)[source]¶ Bases:
opentelemetry.sdk.trace.SpanProcessor
Simple SpanProcessor implementation.
SimpleSpanProcessor is an implementation of
SpanProcessor
that passes ended spans directly to the configuredSpanExporter
.-
on_start
(span, parent_context=None)[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
) – Theopentelemetry.trace.Span
that just started.parent_context (
Optional
[Context
]) – The parent context of the span that just started.
- Return type
-
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 (
ReadableSpan
) – Theopentelemetry.trace.Span
that just ended.- Return type
-
shutdown
()[source]¶ Called when a
opentelemetry.sdk.trace.TracerProvider
is shutdown.- Return type
-
-
class
opentelemetry.sdk.trace.export.
BatchSpanProcessor
(span_exporter, max_queue_size=None, schedule_delay_millis=None, max_export_batch_size=None, export_timeout_millis=None)[source]¶ Bases:
opentelemetry.sdk.trace.SpanProcessor
Batch span processor implementation.
BatchSpanProcessor
is an implementation ofSpanProcessor
that batches ended spans and pushes them to the configuredSpanExporter
.BatchSpanProcessor
is configurable with the following environment variables which correspond to constructor parameters:-
on_start
(span, parent_context=None)[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
) – Theopentelemetry.trace.Span
that just started.parent_context (
Optional
[Context
]) – The parent context of the span that just started.
- Return type
-
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 (
ReadableSpan
) – Theopentelemetry.trace.Span
that just ended.- Return type
-
force_flush
(timeout_millis=None)[source]¶ Export all ended spans to the configured Exporter that have not yet been exported.
-
shutdown
()[source]¶ Called when a
opentelemetry.sdk.trace.TracerProvider
is shutdown.- Return type
-
class
opentelemetry.sdk.trace.export.
ConsoleSpanExporter
(service_name=None, 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
[ReadableSpan
]) – The list ofopentelemetry.trace.Span
objects to be exported- Return type
- Returns
The result of the export
-