Record exception in Celery instrumentation #1573
Conversation
I noticed there were no tests for the error scenario in the Celery package. This commit adds a basic test, based on the previous test and how I see other packages test the error status on the span. Part of open-telemetry#987
In addition to setting the status on the span, also record the exception on the span. This adds an event to the span with more details about the error, following the format other instrumentations also use.
|
Looking great! |
|
I'm pretty sure I fixed the lint failures. I can't reliably run the linter locally though to confirm. |
|
You can run just the python code formatter, it will fix most of the problems |
|
Thanks! That's a lot quicker than running Does this PR also need an update to the docker-tests? Like you mentioned in the Redis query sanitization PR? #1572 (comment) |
There is no need to add docket-tests in this case, In your last PR you changed the default behavior so you had to update all Redis tests(including the docker tests) |
|
Great! Then this PR is ready for review. |
The celery tests failed on Python 3.11. This is most likely due to this issue in billiard, a celery dependency, about it not working on Python 3.11 because of the error reported in the CI: celery/billiard#377 It's been fixed in billiard 4.1.0, but celery is locked on billiard version lower than 4, so it cannot use this version with the fix. This issue does not arise on the Docker tests, because they use Python 3.9.16. I've moved the error test span event assertions to the error test that is available in the functional tests, and removed the unit test. That way, the build will run successfully.
This was added in a recent merge commit on this PR branch.
|
@srikanthccv I've updated the PR to fix the failing CI. It's become of some dependency issue described in 2888c12. I've moved the error test assertion to the functional tests so the build is green. Can you run the build again? |
With the move of the tests for tasks with errors to the functional tests, remove the unit test's error task and unused imports.
|
@srikanthccv I'm learning a lot about what checks need to pass. (I can't run the tox lint task in its entirety locally (some C extension error), so it's process.) The flake8 output contains many issues that do not apply to this PR. I fixed what was related to the celery instrumentation. I hope that's enough. Please try the build again. I really hope it will now be green. |
|
If you think we can improve/document the steps based on your experience, please suggest them. We want our contributing experience to be better. Whenever I try to reproduce some of these things, I fail because sometimes the errors occur in specific env. |
|
@srikanthccv I asked for help on Slack and Diego was able to help out, resulting in PR #1604. I may send in a PR or two for other things I ran into. Edit: blocked on #1609 |
Description
Add tests for errors in Celery tasks
I noticed there were no tests for the error scenario in the Celery
package. This commit adds a basic test, based on the previous test and
how I see other packages test the error status on the span.
Part of #987
Record exception in Celery instrumentation
In addition to setting the status on the span, also record the exception
on the span. This adds an event to the span with more details about the
error, following the format other instrumentations also use.
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
tox -e test-instrumentation-celeryDoes This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.