Skip to content

Commit c824092

Browse files
committed
Document logging settings - update per review
Resolves #1974
1 parent a62644c commit c824092

File tree

2 files changed

+19
-18
lines changed

2 files changed

+19
-18
lines changed

doc/reference/configuration/cfg_logging.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -27,34 +27,35 @@ application.
2727

2828
By setting ``log_level``, you can enable logging of all events with severities above
2929
or equal to the given level. Tarantool prints logs to the standard
30-
error stream by default, but this can be changed with the
30+
error stream by default. This can be changed with the
3131
:ref:`log <cfg_logging-log>` configuration parameter.
3232

3333
| Type: integer
3434
| Default: 5
3535
| Environment variable: TT_LOG_LEVEL
3636
| Dynamic: **yes**
3737
38-
Warning: prior to Tarantool 1.7.5 there were only six levels and ``DEBUG`` was
39-
level 6. Starting with Tarantool 1.7.5, ``VERBOSE`` is level 6 and ``DEBUG`` is level 7.
40-
``VERBOSE`` is a new level for monitoring repetitive events which would cause
41-
too much log writing if ``INFO`` were used instead.
38+
.. note::
39+
Prior to Tarantool 1.7.5 there were only six levels and ``DEBUG`` was
40+
level 6. Starting with Tarantool 1.7.5, ``VERBOSE`` is level 6 and ``DEBUG`` is level 7.
41+
``VERBOSE`` is a new level for monitoring repetitive events which would cause
42+
too much log writing if ``INFO`` were used instead.
4243

4344
.. _cfg_logging-log:
4445

4546
.. confval:: log
4647

4748
Since version 1.7.4.
4849
By default, Tarantool sends the log to the standard error stream
49-
(``stderr``). If ``log`` is specified, Tarantool can send the log to a ...
50+
(``stderr``). If ``log`` is specified, Tarantool can send the log to a:
5051

51-
* file;
52+
* file
5253

53-
* pipe;
54+
* pipe
5455

55-
* system logger.
56+
* system logger
5657

57-
The example below shows how to send logs to the ``tarantool.log`` file:
58+
Example 1: sending the log to the ``tarantool.log`` file.
5859

5960
.. code-block:: lua
6061
@@ -66,7 +67,7 @@ application.
6667
directory. If the ``log`` string has no prefix or has the prefix "file:",
6768
then the string is interpreted as a file path.
6869

69-
This example shows how to send the log to a pipe:
70+
Example 2: sending the log to a pipe.
7071

7172
.. code-block:: lua
7273
@@ -80,7 +81,7 @@ application.
8081
then the string is interpreted as a Unix
8182
`pipeline <https://en.wikipedia.org/wiki/Pipeline_%28Unix%29>`_.
8283
83-
The example below shows how to send the log to syslog:
84+
Example 3: sending the log to syslog.
8485

8586
.. code-block:: lua
8687
@@ -96,8 +97,8 @@ application.
9697
interpreted as a message for the
9798
`syslogd <https://linux.die.net/man/8/syslogd>`_ program, which normally
9899
is running in the background on any Unix-like platform.
99-
The setting can be 'syslog:', 'syslog:facility=...', 'syslog:identity=...',
100-
'syslog:server=...', or a combination.
100+
The setting can be ``syslog:``, ``syslog:facility=...``, ``syslog:identity=...``,
101+
``syslog:server=...``, or a combination.
101102

102103
* The ``syslog:identity`` setting is an arbitrary string, which is placed at
103104
the beginning of all messages. The default value is "tarantool".

doc/reference/reference_lua/log.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,10 @@ Below is a list of all ``log`` functions.
128128

129129
The actual output will be a line in the log, containing:
130130

131-
* the current timestamp,
132-
* a module name,
133-
* 'E', 'W', 'I', 'V' or 'D' depending on the called function, and
134-
* ``message``.
131+
* the current timestamp
132+
* a module name
133+
* 'E', 'W', 'I', 'V' or 'D' depending on the called function
134+
* ``message``
135135

136136
Note that the message will not be logged if the severity level corresponding to
137137
the called function is less than :ref:`log_level <cfg_logging-log_level>`.

0 commit comments

Comments
 (0)