Skip to content

Commit e8017ff

Browse files
committed
[docs] clarify recognized log levels
Related to #1660
1 parent f68e27d commit e8017ff

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/source/formats.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,32 @@ object with the following fields:
304304
:level-field: The name of the regex capture group that contains the log
305305
message level. Defaults to "level".
306306

307+
The following log level strings are recognized automatically
308+
(case-insensitive) and do not require a custom :code:`level` mapping:
309+
310+
============ ========================================
311+
Level Recognized strings
312+
============ ========================================
313+
trace ``trace``, ``verbose``
314+
debug ``debug``
315+
debug2 ``debug2``
316+
debug3 ``debug3``
317+
debug4 ``debug4``
318+
debug5 ``debug5``
319+
info ``info``, ``system``
320+
notice ``notice``, ``note``, ``log``
321+
stats ``stats``
322+
warning ``warn``, ``warning``, ``deprecation``
323+
error ``err``, ``error``, ``fail``
324+
critical ``critical``, ``severe``, ``alert``
325+
fatal ``fatal``, ``emergency``
326+
============ ========================================
327+
328+
Single-letter abbreviations are also recognized:
329+
**T** (trace), **D**/**V** (debug), **I** (info), **S** (stats),
330+
**N** (notice), **W** (warning), **E** (error), **C** (critical),
331+
**F** (fatal).
332+
307333
:body-field: The name of the field that contains the main body of the
308334
message. Defaults to "body".
309335

0 commit comments

Comments
 (0)