Project

Profile

Help

Task #2760

Add a "Error Handling" section to the contributing guide and add info about Celery errors

Added by bmbouter over 2 years ago. Updated 6 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
Documentation
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 22

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.

[0]: https://docs.python.org/3/library/exceptions.html


Checklist

Associated revisions

Revision 48e66349 View on GitHub
Added by werwty about 2 years ago

Add Error handling section to docs

closes #2760
https://pulp.plan.io/issues/2760

Revision 48e66349 View on GitHub
Added by werwty about 2 years ago

Add Error handling section to docs

closes #2760
https://pulp.plan.io/issues/2760

Revision 48e66349 View on GitHub
Added by werwty about 2 years ago

Add Error handling section to docs

closes #2760
https://pulp.plan.io/issues/2760

History

#1 Updated by bmbouter over 2 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 2 years ago

  • Tags Documentation added

#3 Updated by amacdona@redhat.com over 2 years ago

  • Description updated (diff)
  • Groomed changed from No to Yes

#4 Updated by mhrivnak over 2 years ago

  • Sprint/Milestone set to 39

#5 Updated by amacdona@redhat.com over 2 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 2 years ago

  • Sprint/Milestone changed from 39 to 40

#7 Updated by bizhang over 2 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bizhang

#8 Updated by bizhang over 2 years ago

  • Status changed from ASSIGNED to POST

#9 Updated by mhrivnak over 2 years ago

  • Sprint/Milestone changed from 40 to 41

#10 Updated by werwty about 2 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#11 Updated by bmbouter over 1 year ago

  • Sprint set to Sprint 22

#12 Updated by bmbouter over 1 year ago

  • Sprint/Milestone deleted (41)

#13 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#14 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF