Skip to content

Commit 83f0975

Browse files
committed
audit log: apply review suggestions
1 parent b935974 commit 83f0975

File tree

3 files changed

+16
-8
lines changed

3 files changed

+16
-8
lines changed

doc/code_snippets/snippets/config/instances.enabled/audit_log/myapp.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
-- Create space
44
function create_space()
5-
box.schema.space.create('Bands')
5+
box.schema.space.create('bands')
66
box.space.bands:format({
77
{ name = 'id', type = 'unsigned' },
88
{ name = 'band_name', type = 'string' },

doc/enterprise/audit_log.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -617,9 +617,9 @@ Tips
617617
How many events can be recorded?
618618
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
619619

620-
If you write to a file, the size of the Tarantool audit module is limited by the disk space.
621-
If you write to a system logger, the size of the Tarantool audit module is limited by the system logger.
622-
If you write to a pipe, the size of the Tarantool audit module is limited by the system buffer.
620+
If you write to a file, the size of the Tarantool audit log is limited by the disk space.
621+
If you write to a system logger, the size of the Tarantool audit log is limited by the system logger.
622+
If you write to a pipe, the size of the Tarantool audit message is limited by the system buffer.
623623
If the ``audit_log.nonblock = false``, if ``audit_log.nonblock`` = ``true``, there is no limit.
624624
However, it is not recommended to use the entire memory, as this may cause performance degradation
625625
and even loss of some logs.

doc/reference/configuration/configuration_reference.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,17 @@ The ``audit_log`` section defines configuration parameters related to :ref:`audi
8080
* Event names (for example, ``password_change``). For details, see :ref:`Audit log events <audit-log-events>`.
8181
* Event groups (for example, ``audit``). For details, see :ref:`Event groups <audit-log-event-groups>`.
8282

83-
The option contains either one value from above or a combination of them.
83+
The option contains either one value from ``Possible values`` section (see below) or a combination of them.
8484

85-
To enable :ref:`user-defined audit log events <audit-log-custom>`, specify the ``custom`` value in this option.
85+
To enable :ref:`custom audit log events <audit-log-custom>`, specify the ``custom`` value in this option.
86+
87+
**Example**
88+
89+
.. literalinclude:: /code_snippets/snippets/config/instances.enabled/audit_log/myapp.lua
90+
:language: lua
91+
:start-at: filter:
92+
:end-at: custom ]
93+
:dedent:
8694

8795
|
8896
| Type: array
@@ -218,7 +226,7 @@ The ``audit_log`` section defines configuration parameters related to :ref:`audi
218226

219227
.. confval:: audit_log.syslog_identity
220228

221-
Specify an arbitrary string that will be placed at the beginning of all messages.
229+
Specify an application name to show in logs.
222230
You can enable logging to a system logger using the :ref:`audit_log.to <configuration_reference_audit_to>` option.
223231

224232
See also: :ref:`syslog configuration example <configuration_reference_audit_syslog-example>`.
@@ -314,7 +322,7 @@ The ``audit_log`` section defines configuration parameters related to :ref:`audi
314322

315323
- ``devnull``: disable audit logging.
316324
- ``file``: write audit logs to a file (see :ref:`audit_log.file <configuration_reference_audit_file>`).
317-
- ``pipe``: write audit logs to a pipe (see :ref:`audit_log.pipe <configuration_reference_audit_pipe>`).
325+
- ``pipe``: start a program and write audit logs to it (see :ref:`audit_log.pipe <configuration_reference_audit_pipe>`).
318326
- ``syslog``: write audit logs to a system logger (see :ref:`audit_log.syslog <configuration_reference_audit_pipe>`).
319327

320328
By default, audit logging is disabled.

0 commit comments

Comments
 (0)