| 1 |
.. -*- mode: rst -*- |
| 2 |
.. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79: |
| 3 |
|
| 4 |
.. _chap_design_log_levels: |
| 5 |
|
| 6 |
********** |
| 7 |
Log levels |
| 8 |
********** |
| 9 |
|
| 10 |
.. topic:: Specification scope and status |
| 11 |
|
| 12 |
This specification provides a partial overview of the current |
| 13 |
implementation. |
| 14 |
|
| 15 |
|
| 16 |
Log messages are emitted by a wide range of operations within DataLad. They are |
| 17 |
categorized into distinct levels. While some levels have self-explanatory |
| 18 |
descriptions (e.g. ``warning``, ``error``), others are less specific (e.g. |
| 19 |
``info``, ``debug``). |
| 20 |
|
| 21 |
Common principles |
| 22 |
================= |
| 23 |
|
| 24 |
Parenthical log message use the same level |
| 25 |
When log messages are used to indicate the start and end of an operation, |
| 26 |
both start and end message use the same log-level. |
| 27 |
|
| 28 |
Use cases |
| 29 |
========= |
| 30 |
|
| 31 |
Command execution |
| 32 |
----------------- |
| 33 |
|
| 34 |
For the :class:`~datalad.cmd.WitlessRunner` and its protocols the following log levels are used: |
| 35 |
|
| 36 |
- High-level execution -> ``debug`` |
| 37 |
- Process start/finish -> ``8`` |
| 38 |
- Threading and IO -> ``5`` |