gh-107877: Update logging levels reference table with usage criteria. (#107894)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
This commit is contained in:
Vinay Sajip 2023-08-13 14:19:41 +01:00 committed by GitHub
parent 2b6dc2accc
commit cc2cf85d03
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -397,21 +397,39 @@ have specific values relative to the predefined levels. If you define a level
with the same numeric value, it overwrites the predefined value; the predefined
name is lost.
+-----------------------+---------------+
| Level | Numeric value |
+=======================+===============+
| .. py:data:: CRITICAL | 50 |
+-----------------------+---------------+
| .. py:data:: ERROR | 40 |
+-----------------------+---------------+
| .. py:data:: WARNING | 30 |
+-----------------------+---------------+
| .. py:data:: INFO | 20 |
+-----------------------+---------------+
| .. py:data:: DEBUG | 10 |
+-----------------------+---------------+
| .. py:data:: NOTSET | 0 |
+-----------------------+---------------+
+-----------------------+---------------+-------------------------------------+
| Level | Numeric value | What it means / When to use it |
+=======================+===============+=====================================+
| .. py:data:: NOTSET | 0 | When set on a logger, indicates that|
| | | ancestor loggers are to be consulted|
| | | to determine the effective level. |
| | | If that still resolves to |
| | | :const:`!NOTSET`, then all events |
| | | are logged. When set on a handler, |
| | | all events are handled. |
+-----------------------+---------------+-------------------------------------+
| .. py:data:: DEBUG | 10 | Detailed information, typically only|
| | | of interest to a developer trying to|
| | | diagnose a problem. |
+-----------------------+---------------+-------------------------------------+
| .. py:data:: INFO | 20 | Confirmation that things are working|
| | | as expected. |
+-----------------------+---------------+-------------------------------------+
| .. py:data:: WARNING | 30 | An indication that something |
| | | unexpected happened, or that a |
| | | problem might occur in the near |
| | | future (e.g. 'disk space low'). The |
| | | software is still working as |
| | | expected. |
+-----------------------+---------------+-------------------------------------+
| .. py:data:: ERROR | 40 | Due to a more serious problem, the |
| | | software has not been able to |
| | | perform some function. |
+-----------------------+---------------+-------------------------------------+
| .. py:data:: CRITICAL | 50 | A serious error, indicating that the|
| | | program itself may be unable to |
| | | continue running. |
+-----------------------+---------------+-------------------------------------+
.. _handler: