-
Notifications
You must be signed in to change notification settings - Fork 168
Document Celery's Distributed Tracing Behaviour #1464
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
dhruv-ahuja
wants to merge
2
commits into
pydantic:main
Choose a base branch
from
dhruv-ahuja:docs/celery_tracing
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+34
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -106,6 +106,40 @@ To run the beat, you can use the following command: | |
celery -A tasks beat --loglevel=info | ||
``` | ||
|
||
## Distributed Tracing | ||
|
||
You must configure Celery instrumentation across client and worker processes, to ensure worker-generated spans are linked to the parent spans in the caller process. | ||
|
||
Let's extend the original example to showcase a distributed tracing setup, including both worker and client code with separate entrypoints. You can run the worker process with `celery -A tasks worker --loglevel=info`, and the client by executing `python tasks.py` from a separate terminal session: | ||
|
||
```py title="tasks.py" hl_lines="6-11 19-22" | ||
import logfire | ||
from celery import Celery | ||
from celery.signals import worker_init | ||
|
||
|
||
@worker_init.connect() | ||
def init_worker(*args, **kwargs): | ||
logfire.configure(service_name="worker", distributed_tracing=True) # (1)! | ||
logfire.instrument_celery() | ||
|
||
app = Celery("tasks", broker="redis://localhost:6379/0") | ||
|
||
|
||
@app.task | ||
def add(x: int, y: int): | ||
return x + y | ||
|
||
|
||
if __name__ == "__main__": # (2)! | ||
logfire.configure(service_name="client-app") | ||
logfire.instrument_celery() | ||
add.delay(42, 50) | ||
``` | ||
|
||
1. Mark the configuration as running in a distributed tracing environment. This is only required for the worker. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Explain in more detail and link to docs. |
||
2. Running the file directly will simulate a client application that calls the Celery task. | ||
|
||
The keyword arguments of [`logfire.instrument_celery()`][logfire.Logfire.instrument_celery] are passed to the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Move this to before the installation, it doesn't fit here. |
||
[`CeleryInstrumentor().instrument()`][opentelemetry.instrumentation.celery.CeleryInstrumentor] method. | ||
|
||
|
Oops, something went wrong.
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.
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.
Then this can fit in a screenshot nicely, which should be added