opentelemetry.ext.jaeger package

Module contents

Jaeger Span Exporter for OpenTelemetry.

class opentelemetry.ext.jaeger.JaegerSpanExporter(service_name, agent_host_name='localhost', agent_port=6831, collector_host_name=None, collector_port=None, collector_endpoint='/api/traces?format=jaeger.thrift', username=None, password=None)[source]

Bases: opentelemetry.sdk.trace.export.SpanExporter

Jaeger span exporter for OpenTelemetry.

Parameters

  • service_name – Service that logged an annotation in a trace.Classifier when query for spans.

  • agent_host_name – The host name of the Jaeger-Agent.

  • agent_port – The port of the Jaeger-Agent.

  • collector_host_name – The host name of the Jaeger-Collector HTTP Thrift.

  • collector_port – The port of the Jaeger-Collector HTTP Thrift.

  • collector_endpoint – The endpoint of the Jaeger-Collector HTTP Thrift.

  • username – The user name of the Basic Auth if authentication is required.

  • password – The password of the Basic Auth if authentication is required.

property agent_client
property collector
export(spans)[source]

Exports a batch of telemetry data.

Parameters

spans – The list of opentelemetry.trace.Span objects to be exported

Returns

The result of the export

shutdown()[source]

Shuts down the exporter.

Called when the SDK is shut down.

class opentelemetry.ext.jaeger.AgentClientUDP(host_name, port, max_packet_size=65000, client=<class 'opentelemetry.ext.jaeger.gen.agent.Agent.Client'>)[source]

Bases: object

Implement a UDP client to agent.

Parameters

  • host_name – The host name of the Jaeger server.

  • port – The port of the Jaeger server.

  • max_packet_size – Maximum size of UDP packet.

  • client – Class for creating new client objects for agencies.

emit(batch)[source]
Parameters

batch (Batch) – Object to emit Jaeger spans.

class opentelemetry.ext.jaeger.Collector(thrift_url='', auth=None, client=<class 'opentelemetry.ext.jaeger.gen.jaeger.Collector.Client'>, http_transport=<class 'thrift.transport.THttpClient.THttpClient'>)[source]

Bases: object

Submits collected spans to Thrift HTTP server.

Parameters

  • thrift_url – URL of the Jaeger HTTP Thrift.

  • auth – Auth tuple that contains username and password for Basic Auth.

  • client – Class for creating a Jaeger collector client.

  • http_transport – Class for creating new client for Thrift HTTP server.

submit(batch)[source]

Submits batches to Thrift HTTP Server through Binary Protocol.

Parameters

batch (Batch) – Object to emit Jaeger spans.