-
Notifications
You must be signed in to change notification settings - Fork 748
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
11df7e3
8613eea
daf360d
2c8f4b2
d8792e1
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
Entry Points | ||
============ | ||
|
||
OpenTelemetry Python uses Python's **entry points** 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 | ||
------------- | ||
|
||
Entry points are controlled via environment variables: | ||
|
||
|
||
* ``OTEL_TRACES_EXPORTER`` - Trace exporters (e.g., ``console``, ``otlp_proto_grpc``) | ||
|
||
* ``OTEL_METRICS_EXPORTER`` - Metrics exporters (e.g., ``console``, ``prometheus``) | ||
* ``OTEL_LOGS_EXPORTER`` - Log exporters (e.g., ``console``, ``otlp_proto_http``) | ||
* ``OTEL_TRACES_SAMPLER`` - Trace samplers (e.g., ``always_on``, ``traceidratio``) | ||
* ``OTEL_PROPAGATORS`` - Context propagators (e.g., ``tracecontext,baggage``) | ||
|
||
Available Entry Point Groups | ||
---------------------------- | ||
|
||
**Exporters** - Send telemetry data to backends: | ||
|
||
* ``opentelemetry_traces_exporter`` - Trace exporters | ||
|
||
* ``opentelemetry_metrics_exporter`` - Metrics exporters | ||
* ``opentelemetry_logs_exporter`` - Log exporters | ||
|
||
**Configuration** - Control telemetry behavior: | ||
|
||
* ``opentelemetry_traces_sampler`` - Decide which traces to collect | ||
* ``opentelemetry_id_generator`` - Generate trace/span IDs | ||
* ``opentelemetry_resource_detector`` - Detect environment info | ||
|
||
|
||
**Context** - Manage distributed tracing context: | ||
|
||
* ``opentelemetry_propagator`` - Cross-service context propagation | ||
* ``opentelemetry_context`` - Context storage mechanism | ||
|
||
**Providers** - Core telemetry factories: | ||
|
||
* ``opentelemetry_tracer_provider`` - Create tracers | ||
* ``opentelemetry_meter_provider`` - Create meters | ||
* ``opentelemetry_logger_provider`` - Create loggers | ||
|
||
Creating a Custom Exporter | ||
|
||
--------------------------- | ||
|
||
1. **Create your exporter class**: | ||
|
||
.. code-block:: python | ||
|
||
from opentelemetry.sdk.trace.export import SpanExporter | ||
|
||
class MyExporter(SpanExporter): | ||
def export(self, spans): | ||
# Your export logic here | ||
for span in spans: | ||
print(f"Exporting: {span.name}") | ||
|
||
2. **Register in pyproject.toml**: | ||
|
||
.. code-block:: toml | ||
|
||
[project.entry-points.opentelemetry_traces_exporter] | ||
my_exporter = "mypackage.exporters:MyExporter" | ||
|
||
3. **Use it**: | ||
|
||
.. code-block:: bash | ||
|
||
export OTEL_TRACES_EXPORTER=my_exporter | ||
python your_app.py | ||
|
||
See Also | ||
-------- | ||
|
||
* :doc:`trace` - Trace SDK documentation | ||
* :doc:`metrics` - Metrics SDK documentation | ||
* :doc:`environment_variables` - Environment variable reference |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,3 +12,4 @@ OpenTelemetry Python SDK | |
metrics | ||
error_handler | ||
environment_variables | ||
entry_points |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we link to the official entry point documentation here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done!