@@ -11,62 +11,85 @@ The SDK supports configuring entry points via environment variables by specifyin
1111Entry Point Configuration Reference
1212~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1313
14- .. list-table ::
15- :header-rows: 1
16- :widths: 20 20 40 20
17-
18- * - Environment Variable
19- - Entry Point Group
20- - Available Entrypoint Names
21- - Base Type
22- * - OTEL_LOGS_EXPORTER
23- - opentelemetry_logs_exporter
24- - ``console ``, ``otlp_proto_grpc ``, ``otlp_proto_http ``
25- - LogExporter
26- * - OTEL_METRICS_EXPORTER
27- - opentelemetry_metrics_exporter
28- - ``console ``, ``otlp ``, ``otlp_proto_grpc ``,
29- ``otlp_proto_http ``, ``prometheus ``
30- - :class: `MetricExporter <opentelemetry.sdk.metrics.export.MetricExporter> ` or :class: `MetricReader <opentelemetry.sdk.metrics.export.MetricReader> `
31- * - OTEL_PROPAGATORS
32- - opentelemetry_propagator
33- - ``b3 ``, ``b3multi ``, ``baggage ``,
34- ``jaeger ``, ``tracecontext ``
35- - :class: `TextMapPropagator <opentelemetry.propagators.textmap.TextMapPropagator> `
36- * - OTEL_TRACES_SAMPLER
37- - opentelemetry_traces_sampler
38- - ``always_off ``, ``always_on ``, ``parentbased_always_off ``,
39- ``parentbased_always_on ``, ``parentbased_traceidratio ``, ``traceidratio ``
40- - :class: `Sampler <opentelemetry.sdk.trace.sampling.Sampler> `
41- * - OTEL_EXPERIMENTAL_RESOURCE_DETECTORS
42- - opentelemetry_resource_detector
43- - ``host ``, ``os ``, ``otel ``, ``process ``
44- - :class: `ResourceDetector <opentelemetry.sdk.resources.ResourceDetector> `
45- * - OTEL_PYTHON_ID_GENERATOR
46- - opentelemetry_id_generator
47- - ``random ``
48- - :class: `IdGenerator <opentelemetry.sdk.trace.id_generator.IdGenerator> `
49- * - OTEL_TRACES_EXPORTER
50- - opentelemetry_traces_exporter
51- - ``console ``, ``otlp ``, ``otlp_proto_grpc ``, ``otlp_proto_http ``,
52- ``zipkin ``, ``zipkin_json ``, ``zipkin_proto ``
53- - :class: `SpanExporter <opentelemetry.sdk.trace.export.SpanExporter> `
54- * - OTEL_PYTHON_TRACER_PROVIDER
55- - opentelemetry_tracer_provider
56- - ``default_tracer_provider ``, ``sdk_tracer_provider ``
57- - :class: `TracerProvider <opentelemetry.trace.TracerProvider> `
58- * - OTEL_PYTHON_METER_PROVIDER
59- - opentelemetry_meter_provider
60- - ``default_meter_provider ``, ``sdk_meter_provider ``
61- - :class: `MeterProvider <opentelemetry.metrics.MeterProvider> `
62- * - OTEL_PYTHON_LOGGER_PROVIDER
63- - opentelemetry_logger_provider
64- - ``default_logger_provider ``, ``sdk_logger_provider ``
65- - :class: `LoggerProvider <opentelemetry._logs.LoggerProvider> `
66- * - OTEL_PYTHON_EVENT_LOGGER_PROVIDER
67- - opentelemetry_event_logger_provider
68- - ``default_event_logger_provider ``
69- - *No implementations available *
14+ **Logs Exporter **
15+
16+ :Environment Variable: ``OTEL_LOGS_EXPORTER ``
17+ :Entry Point Group: ``opentelemetry_logs_exporter ``
18+ :Available Names: ``console ``, ``otlp_proto_grpc ``, ``otlp_proto_http ``
19+ :Base Type: ``LogExporter `` *(alpha) *
20+
21+ **Metrics Exporter **
22+
23+ :Environment Variable: ``OTEL_METRICS_EXPORTER ``
24+ :Entry Point Group: ``opentelemetry_metrics_exporter ``
25+ :Available Names: ``console ``, ``otlp ``, ``otlp_proto_grpc ``, ``otlp_proto_http ``, ``prometheus ``
26+ :Base Type: :class: `MetricExporter <opentelemetry.sdk.metrics.export.MetricExporter> ` or :class: `MetricReader <opentelemetry.sdk.metrics.export.MetricReader> `
27+
28+ **Propagators **
29+
30+ :Environment Variable: ``OTEL_PROPAGATORS ``
31+ :Entry Point Group: ``opentelemetry_propagator ``
32+ :Available Names: ``b3 ``, ``b3multi ``, ``baggage ``, ``jaeger ``, ``tracecontext ``
33+ :Base Type: :class: `TextMapPropagator <opentelemetry.propagators.textmap.TextMapPropagator> `
34+
35+ **Traces Sampler **
36+
37+ :Environment Variable: ``OTEL_TRACES_SAMPLER ``
38+ :Entry Point Group: ``opentelemetry_traces_sampler ``
39+ :Available Names: ``always_off ``, ``always_on ``, ``parentbased_always_off ``, ``parentbased_always_on ``, ``parentbased_traceidratio ``, ``traceidratio ``
40+ :Base Type: :class: `Sampler <opentelemetry.sdk.trace.sampling.Sampler> `
41+
42+ **Resource Detectors **
43+
44+ :Environment Variable: ``OTEL_EXPERIMENTAL_RESOURCE_DETECTORS ``
45+ :Entry Point Group: ``opentelemetry_resource_detector ``
46+ :Available Names: ``host ``, ``os ``, ``otel ``, ``process ``
47+ :Base Type: :class: `ResourceDetector <opentelemetry.sdk.resources.ResourceDetector> `
48+
49+ **ID Generator **
50+
51+ :Environment Variable: ``OTEL_PYTHON_ID_GENERATOR ``
52+ :Entry Point Group: ``opentelemetry_id_generator ``
53+ :Available Names: ``random ``
54+ :Base Type: :class: `IdGenerator <opentelemetry.sdk.trace.id_generator.IdGenerator> `
55+
56+ **Traces Exporter **
57+
58+ :Environment Variable: ``OTEL_TRACES_EXPORTER ``
59+ :Entry Point Group: ``opentelemetry_traces_exporter ``
60+ :Available Names: ``console ``, ``otlp ``, ``otlp_proto_grpc ``, ``otlp_proto_http ``, ``zipkin ``, ``zipkin_json ``, ``zipkin_proto ``
61+ :Base Type: :class: `SpanExporter <opentelemetry.sdk.trace.export.SpanExporter> `
62+
63+ **Tracer Provider **
64+
65+ :Environment Variable: ``OTEL_PYTHON_TRACER_PROVIDER ``
66+ :Entry Point Group: ``opentelemetry_tracer_provider ``
67+ :Available Names: ``default_tracer_provider ``, ``sdk_tracer_provider ``
68+ :Base Type: :class: `TracerProvider <opentelemetry.trace.TracerProvider> `
69+
70+ **Meter Provider **
71+
72+ :Environment Variable: ``OTEL_PYTHON_METER_PROVIDER ``
73+ :Entry Point Group: ``opentelemetry_meter_provider ``
74+ :Available Names: ``default_meter_provider ``, ``sdk_meter_provider ``
75+ :Base Type: :class: `MeterProvider <opentelemetry.metrics.MeterProvider> `
76+
77+ **Logger Provider **
78+
79+ :Environment Variable: ``OTEL_PYTHON_LOGGER_PROVIDER ``
80+ :Entry Point Group: ``opentelemetry_logger_provider ``
81+ :Available Names: ``sdk_logger_provider ``
82+ :Base Type: :class: `LoggerProvider <opentelemetry._logs.LoggerProvider> `
83+
84+ **Event Logger Provider **
85+
86+ :Environment Variable: ``OTEL_PYTHON_EVENT_LOGGER_PROVIDER ``
87+ :Entry Point Group: ``opentelemetry_event_logger_provider `` *(not implemented) *
88+ :Available Names: *None - no entry point implementations exist *
89+ :Base Type: ``EventLoggerProvider `` *(experimental) *
90+
91+ .. note ::
92+ The Events API is `experimental <https://github.com/open-telemetry/opentelemetry-python#project-status >`_ and currently has no entry point implementations.
7093
7194See Also
7295--------
0 commit comments