File: log_levels.rst

package info (click to toggle)
datalad 1.1.5-2.1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 7,140 kB
  • sloc: python: 69,392; sh: 1,521; makefile: 220
file content (38 lines) | stat: -rw-r--r-- 972 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
.. -*- mode: rst -*-
.. vi: set ft=rst sts=4 ts=4 sw=4 et tw=79:

.. _chap_design_log_levels:

**********
Log levels
**********

.. topic:: Specification scope and status

   This specification provides a partial overview of the current
   implementation.


Log messages are emitted by a wide range of operations within DataLad. They are
categorized into distinct levels. While some levels have self-explanatory
descriptions (e.g. ``warning``, ``error``), others are less specific (e.g.
``info``, ``debug``).

Common principles
=================

Parenthical log message use the same level
  When log messages are used to indicate the start and end of an operation,
  both start and end message use the same log-level.

Use cases
=========

Command execution
-----------------

For the :class:`~datalad.cmd.WitlessRunner` and its protocols the following log levels are used:

- High-level execution -> ``debug``
- Process start/finish -> ``8``
- Threading and IO -> ``5``