Skip to content

Commit 9befdd0

Browse files
committed
Document logging settings
Resolves #1974
1 parent 1b8445d commit 9befdd0

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

doc/reference/reference_lua/log.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
Tarantool provides a set of :ref:`options <cfg_logging>` used to configure logging
1414
in various ways: you can set a level of logging, specify where to send the log's output,
1515
configure a log format, and so on.
16-
The ``log`` module allows you to configure logging in you application and
16+
The ``log`` module allows you to configure logging in your application and
1717
provides additional capabilities, for example, logging custom messages and
1818
rotating log files.
1919

@@ -31,24 +31,24 @@ Below is a list of all ``log`` functions.
3131
+--------------------------------------+---------------------------------+
3232
| Name | Use |
3333
+======================================+=================================+
34-
| :ref:`log.cfg({}) | Configure a logger |
34+
| :ref:`log.cfg({}) | Configures a logger |
3535
| <log-cfg>` | |
3636
+--------------------------------------+---------------------------------+
3737
| :ref:`log.error() | |
3838
| <log-ug_message>` |br| | |
3939
| :ref:`log.warn() | |
4040
| <log-ug_message>` |br| | |
41-
| :ref:`log.info() | Log a message with the |
41+
| :ref:`log.info() | Logs a message with the |
4242
| <log-ug_message>` |br| | specified level |
4343
| :ref:`log.verbose() | |
4444
| <log-ug_message>` |br| | |
4545
| :ref:`log.debug() | |
4646
| <log-ug_message>` | |
4747
+--------------------------------------+---------------------------------+
48-
| :ref:`log.logger_pid() | Get the PID of a logger |
49-
| <log-logger_pid>` | |
48+
| :ref:`log.pid() | Gets the PID of a logger |
49+
| <log-pid>` | |
5050
+--------------------------------------+---------------------------------+
51-
| :ref:`log.rotate() | Rotate a log file |
51+
| :ref:`log.rotate() | Rotates a log file |
5252
| <log-rotate>` | |
5353
+--------------------------------------+---------------------------------+
5454

@@ -63,18 +63,19 @@ Below is a list of all ``log`` functions.
6363

6464
See also: :ref:`log_level <cfg_logging-log_level>`.
6565

66-
* ``log``: Specifies where to to send the log's output, for example,
66+
* ``log``: Specifies where to send the log's output, for example,
6767
to a file, pipe, or system logger.
6868

69-
See also: :ref:`log <cfg_logging-log>`
69+
See also: :ref:`log <cfg_logging-log>`.
7070

7171
* ``nonblock``: If **true**, Tarantool does not block during logging when the system
7272
is not ready for writing, and drops the message instead.
7373

74-
See also: :ref:`log_nonblock <cfg_logging-log_nonblock>`
74+
See also: :ref:`log_nonblock <cfg_logging-log_nonblock>`.
7575

7676
* ``format``: Specifies the log format: 'plain' or 'json'.
77-
See also: :ref:`log_format <cfg_logging-log_format>`
77+
78+
See also: :ref:`log_format <cfg_logging-log_format>`.
7879

7980
The example below shows how to set the log level to 'debug' and how to send the resulting log
8081
to the 'tarantool.log' file:
@@ -137,11 +138,11 @@ Below is a list of all ``log`` functions.
137138
is for a type greater than :ref:`log_level
138139
<cfg_logging-log_level>`.
139140

140-
.. _log-logger_pid:
141+
.. _log-pid:
141142

142-
.. function:: logger_pid()
143+
.. function:: pid()
143144

144-
:return: Returns a PID of a logger.
145+
:return: A PID of a logger.
145146

146147
.. _log-rotate:
147148

0 commit comments

Comments
 (0)