Skip to content

Commit

Permalink
note on prefix; example
Browse files Browse the repository at this point in the history
  • Loading branch information
s-m-e committed Feb 6, 2022
1 parent 0713232 commit 6262346
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/source/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Debugging
=========

Every :ref:`CLI <cli>` command supports the ``-l`` or ``--log_level`` option, which adjusts `log level`_ of the application. Set it to ``INFO`` (i.e. ``20``) for general information on what is happening. Set it to ``DEBUG`` (i.e. ``10``) for full debugging output.
Every :ref:`CLI <cli>` command supports the ``-l`` or ``--log_level`` option, which adjusts `log level`_ of the application. Set it to ``INFO`` (i.e. ``20``) for general information on what is happening. Set it to ``DEBUG`` (i.e. ``10``) for full debugging output, e.g. ``scherbelberg create -l 10``.

If *scherbelberg* is used via its :ref:`API <api>`, the log level can be adjusted via Python's standard library's logging module for instance as follows:

Expand All @@ -18,4 +18,8 @@ If *scherbelberg* is used via its :ref:`API <api>`, the log level can be adjuste
level=INFO,
)
.. note::

The used logger is, by default, named after the cluster, i.e. its ``prefix``.

.. _log level: https://docs.python.org/3/library/logging.html#levels

0 comments on commit 6262346

Please sign in to comment.