summaryrefslogtreecommitdiff
path: root/doc/logging.rst
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2020-09-21 16:44:10 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2020-09-21 16:44:10 -0500
commitfbb4f560be709e5c6c404c9b1e15693870cd17e7 (patch)
treeaa38851a787e981ca9907688c220ebdeb1e24e68 /doc/logging.rst
parentbc317b274504fcd51119c2e8d30c5c4217f8c9f3 (diff)
downloadnetconfapk-fbb4f560be709e5c6c404c9b1e15693870cd17e7.tar.gz
netconfapk-fbb4f560be709e5c6c404c9b1e15693870cd17e7.tar.bz2
netconfapk-fbb4f560be709e5c6c404c9b1e15693870cd17e7.tar.xz
netconfapk-fbb4f560be709e5c6c404c9b1e15693870cd17e7.zip
doc: Formatting fixes for logging spec
Diffstat (limited to 'doc/logging.rst')
-rw-r--r--doc/logging.rst32
1 files changed, 18 insertions, 14 deletions
diff --git a/doc/logging.rst b/doc/logging.rst
index 8b86608..7280ee7 100644
--- a/doc/logging.rst
+++ b/doc/logging.rst
@@ -21,10 +21,10 @@ Distributions system.
Definition of terms
-------------------
-* `NETCONF APK`: The NETCONF for APK Distributions system, including the
+* ``NETCONF APK``: The NETCONF for APK Distributions system, including the
base server and modules contained in the netconfapk source distribution.
-* `stderr`: The standard error output stream as defined by POSIX.
+* ``stderr``: The standard error output stream as defined by POSIX.
Intended audience
@@ -47,16 +47,20 @@ the message. The message's Level indicates the urgency of the message,
and may be one of the following six values: Critical, Error, Warning,
Notice, Info, and Debug. The message's Message is the text being logged.
-The system outputs every message processed to `stderr`, with the
+The system outputs every message processed to ``stderr``, with the
following format:
+::
+
<iso-date> : <device> : <category> : <level> : <message>
iso-date is defined as an ISO 8601 extended timestamp, of the format:
+::
+
YYYY-MM-DDThh:mm:ss
-`device` is the hostname of the device running the logging system.
+``device`` is the hostname of the device running the logging system.
@@ -64,12 +68,12 @@ iso-date is defined as an ISO 8601 extended timestamp, of the format:
Configuration
=============
-The `netconf.conf` YAML configuration file will be read for a scalar
-`loglevel` present in the top-level `server` node, which defines the
-lowest log level to output. The default, if the `loglevel` scalar is not
-set, is `notice`.
+The ``netconf.conf`` YAML configuration file will be read for a scalar
+``loglevel`` present in the top-level ``server`` node, which defines the
+lowest log level to output. The default, if the ``loglevel`` scalar is
+not set, is ``notice``.
-The `loglevel` node is case-insensitive.
+The ``loglevel`` node is case-insensitive.
@@ -134,8 +138,8 @@ operational
-----------
Messages in this category concern operations carried out. This includes
-standard operations such as `edit-config` and also RPCs such as
-`system-restart`.
+standard operations such as ``edit-config`` and also RPCs such as
+``system-restart``.
RPC executed
````````````
@@ -183,7 +187,7 @@ reading and writing to any NETCONF datastore.
Configuration editing
`````````````````````
-This event is triggered just before `edit-config` is executed.
+This event is triggered just before ``edit-config`` is executed.
:Format:
%{user} on session %{sessid} is editing configuration: %{xml}
@@ -192,7 +196,7 @@ This event is triggered just before `edit-config` is executed.
Configuration edited
````````````````````
-This event is triggered when `edit-config` nodes are being processed by
+This event is triggered when ``edit-config`` nodes are being processed by
their respective NETCONF modules.
:Format:
@@ -202,7 +206,7 @@ their respective NETCONF modules.
Configuration reading
`````````````````````
-This event is triggered just before `get-config` or `get` is executed.
+This event is triggered just before ``get-config`` or ``get`` is executed.
:Format:
%{user} on session %{sessid} is requesting configuration: %{xml}