Add optional faust[opentelemetry] extra + docs for OpenTelemetry via the OpenTracing shim#688
Open
wbarnha wants to merge 1 commit into
Open
Add optional faust[opentelemetry] extra + docs for OpenTelemetry via the OpenTracing shim#688wbarnha wants to merge 1 commit into
wbarnha wants to merge 1 commit into
Conversation
Faust's app.tracer accepts any OpenTracing-compatible tracer, so OpenTelemetry works today via its OpenTracing shim -- no code change needed. Make that a first-class, documented path: - requirements/extras/opentelemetry.txt + the 'opentelemetry' setup.py bundle -> pip install faust[opentelemetry] (pulls opentelemetry-opentracing-shim + opentelemetry-sdk). - docs/userguide/sensors.rst: a 'Distributed Tracing' section showing how to build an app.tracer from an OpenTelemetry TracerProvider via create_tracer(), so Faust's spans flow out to any OTel exporter. Non-breaking: no change to faust's tracing internals or public API; this just documents and packages the bridge. Verified the example wires app.tracer through the shim and start_span/set_tag/finish/trace() all work end-to-end.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #688 +/- ##
=======================================
Coverage 94.14% 94.14%
=======================================
Files 104 104
Lines 11136 11136
Branches 1201 1201
=======================================
Hits 10484 10484
Misses 551 551
Partials 101 101 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
A small, non-breaking step toward OpenTelemetry: package + document the bridge that already works.
Faust's
app.traceraccepts any OpenTracing-compatible tracer, and OpenTelemetry ships an official OpenTracing shim (opentelemetry.shim.opentracing_shim.create_tracer) that exposes exactly that, backed by an OTelTracerProvider. So OpenTelemetry works today with no change to Faust's tracing internals or public API — this PR just makes it a first-class, discoverable path.Changes
requirements/extras/opentelemetry.txt+ theopentelemetrybundle insetup.py→pip install "faust[opentelemetry]"(pullsopentelemetry-opentracing-shim+opentelemetry-sdk).docs/userguide/sensors.rst— a new Distributed Tracing section showing how to build anapp.tracerfrom an OpenTelemetryTracerProviderviacreate_tracer(), so Faust's stream/agent/rebalance spans flow out to any OTel exporter (OTLP/Jaeger/Zipkin).Verification
app.tracer = OpenTelemetryTracer(provider)and exercising it the way Faust does internally (get_tracer(...).start_span(operation_name=…, tags=…),set_tag,finish, andapp.tracer.trace(...)) — all work end-to-end, emitting OTel spans (TracerShim/SpanShim).setup.pylint clean (flake8/black); the RST parses cleanly and uses the file's existing.. sourcecode::convention.Context
This is step 2 of a phased OpenTracing→OpenTelemetry plan: #686 makes
opentracingoptional; this documents/packages the OTel bridge (no breaking change); a future major could do a native OTel rewrite or drop built-in tracing in favor ofopentelemetry-instrumentation-faust. It complements #681 (which documents the external auto-instrumentation package) by covering theapp.tracerwiring path.Generated by Claude Code