Task #2760
Add a "Error Handling" section to the contributing guide and add info about Celery errors
Start date:
Due date:
% Done:
100%
Estimated time:
Platform Release:
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation
Sprint:
Sprint 22
Quarter:
Description
The Contributing Guide part of the docs needs a new top-level section added to it called "Error Handling". Inside of that page a section on "Errors in Tasks" should also be added about how errors are handled while running a task. The basic things to get across are that:
- Uncaught exceptions are treated as fatal exceptions, the task is marked as failed, and the error representation is returned to the user as the task 'error'.
- Built-In Python exceptions [0] should be used whenever possible.
- Coded exceptions should be used for known error situations. These should link to
PulpException
- Non fatal exceptions can be recorded with the
append_non_fatal_error()
and it should link them to that part of the plugin API docs - These non-fatal exceptions will be returned with the task details through the API.
Associated revisions
Revision 48e66349
View on GitHub
Add Error handling section to docs
History
#1
Updated by bmbouter over 3 years ago
- Subject changed from Add the error handling for Celery tasks to the plugin guide to Add a "Error Handling" section to the contributing guide and add info about Celery errors
- Description updated (diff)
#2
Updated by bmbouter over 3 years ago
- Tags Documentation added
#3
Updated by amacdona@redhat.com over 3 years ago
- Description updated (diff)
- Groomed changed from No to Yes
#4
Updated by mhrivnak over 3 years ago
- Sprint/Milestone set to 39
#5
Updated by amacdona@redhat.com over 3 years ago
Feel free to write and update a draft here: https://pulp.plan.io/projects/pulp/wiki/Pulp_3_Developer_Notes
#6
Updated by mhrivnak over 3 years ago
- Sprint/Milestone changed from 39 to 40
#7
Updated by bizhang over 3 years ago
- Status changed from NEW to ASSIGNED
- Assignee set to bizhang
#8
Updated by bizhang over 3 years ago
- Status changed from ASSIGNED to POST
#9
Updated by mhrivnak over 3 years ago
- Sprint/Milestone changed from 40 to 41
#10
Updated by werwty over 3 years ago
- Status changed from POST to MODIFIED
- % Done changed from 0 to 100
Applied in changeset pulp|48e66349b6a10221686bfade0522156949ddc25a.
#11
Updated by bmbouter almost 3 years ago
- Sprint set to Sprint 22
#12
Updated by bmbouter almost 3 years ago
- Sprint/Milestone deleted (
41)
#13
Updated by daviddavis almost 2 years ago
- Sprint/Milestone set to 3.0.0
#14
Updated by bmbouter almost 2 years ago
- Tags deleted (
Pulp 3)
#15
Updated by bmbouter about 1 year ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Please register to edit this issue
Add Error handling section to docs
closes #2760 https://pulp.plan.io/issues/2760