Skip to content

Update docs for entrypoints #4701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions docs/sdk/entry_points.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
Entry Points
============

OpenTelemetry Python uses Python's `entry points <https://setuptools.pypa.io/en/stable/userguide/entry_point.html>`_ mechanism to provide a pluggable architecture. Entry points allow you to register custom components (exporters, samplers, etc.) that can be discovered and loaded at runtime.

Configuration
-------------

The SDK supports configuring entry points via environment variables by specifying the entry point name. For a complete list of supported environment variables, see :doc:`../api/environment_variables`.

Entry Point Configuration Reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. list-table::
:header-rows: 1
:widths: 20 20 40 20

* - Environment Variable
- Entry Point Group
- Available Entrypoint Names
- Base Type
* - OTEL_LOGS_EXPORTER
- opentelemetry_logs_exporter
- ``console``, ``otlp_proto_grpc``, ``otlp_proto_http``
- LogExporter
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is an _internal class - should it still be linked here? is it relevant still?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The LogExporter ? I don't think it's meant to be internal.. the file it's in is prefixed with a _ because it's in alpha

* - OTEL_METRICS_EXPORTER
- opentelemetry_metrics_exporter
- ``console``, ``otlp``, ``otlp_proto_grpc``,
``otlp_proto_http``, ``prometheus``
- :class:`MetricExporter <opentelemetry.sdk.metrics.export.MetricExporter>` or :class:`MetricReader <opentelemetry.sdk.metrics.export.MetricReader>`
* - OTEL_PROPAGATORS
- opentelemetry_propagator
- ``b3``, ``b3multi``, ``baggage``,
``jaeger``, ``tracecontext``
- :class:`TextMapPropagator <opentelemetry.propagators.textmap.TextMapPropagator>`
* - OTEL_TRACES_SAMPLER
- opentelemetry_traces_sampler
- ``always_off``, ``always_on``, ``parentbased_always_off``,
``parentbased_always_on``, ``parentbased_traceidratio``, ``traceidratio``
- :class:`Sampler <opentelemetry.sdk.trace.sampling.Sampler>`
* - OTEL_EXPERIMENTAL_RESOURCE_DETECTORS
- opentelemetry_resource_detector
- ``host``, ``os``, ``otel``, ``process``
- :class:`ResourceDetector <opentelemetry.sdk.resources.ResourceDetector>`
* - OTEL_PYTHON_ID_GENERATOR
- opentelemetry_id_generator
- ``random``
- :class:`IdGenerator <opentelemetry.sdk.trace.id_generator.IdGenerator>`
* - OTEL_TRACES_EXPORTER
- opentelemetry_traces_exporter
- ``console``, ``otlp``, ``otlp_proto_grpc``, ``otlp_proto_http``,
``zipkin``, ``zipkin_json``, ``zipkin_proto``
- :class:`SpanExporter <opentelemetry.sdk.trace.export.SpanExporter>`
* - OTEL_PYTHON_TRACER_PROVIDER
- opentelemetry_tracer_provider
- ``default_tracer_provider``, ``sdk_tracer_provider``
- :class:`TracerProvider <opentelemetry.trace.TracerProvider>`
* - OTEL_PYTHON_METER_PROVIDER
- opentelemetry_meter_provider
- ``default_meter_provider``, ``sdk_meter_provider``
- :class:`MeterProvider <opentelemetry.metrics.MeterProvider>`
* - OTEL_PYTHON_LOGGER_PROVIDER
- opentelemetry_logger_provider
- ``default_logger_provider``, ``sdk_logger_provider``
- :class:`LoggerProvider <opentelemetry._logs.LoggerProvider>`
* - OTEL_PYTHON_EVENT_LOGGER_PROVIDER
- opentelemetry_event_logger_provider
- ``default_event_logger_provider``
- *No implementations available*

See Also
--------

* :doc:`trace` - Trace SDK documentation
* :doc:`metrics` - Metrics SDK documentation
* :doc:`environment_variables` - Environment variable reference
1 change: 1 addition & 0 deletions docs/sdk/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ OpenTelemetry Python SDK
metrics
error_handler
environment_variables
entry_points