[Config] Update 'Audit log' to using a new config #3983
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xuniq
force-pushed
the
gh-3667-audit-new
branch
3 times, most recently
from
e853fc1 to
a696542
Compare
8 tasks
xuniq
force-pushed
the
gh-3667-audit-new
branch
2 times, most recently
from
51c1d26 to
559bf9c
Compare
xuniq
force-pushed
the
gh-3667-audit-new
branch
2 times, most recently
from
eaf6ff3 to
1904098
Compare
xuniq
force-pushed
the
gh-3667-audit-new
branch
2 times, most recently
from
ac90435 to
9e07fff
Compare
andreyaksenov
requested changes
Jan 24, 2024
xuniq
force-pushed
the
gh-3667-audit-new
branch
2 times, most recently
from
b50c05a to
2ab386d
Compare
Totktonada
reviewed
Feb 6, 2024
doc/code_snippets/snippets/config/instances.enabled/audit_log/myapp.lua
Outdated
Show resolved
Hide resolved
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
|
|
||
| Specify a pipe for the audit log destination. | ||
| You can set the ``pipe`` type using the :ref:`audit_log.to <configuration_reference_audit_to>` option. | ||
| If log is a program, its pid is stored in the ``audit_log.logger_pid`` variable. |
There was a problem hiding this comment.
Is audit_log.logger_pid means audit_log module (obtained by require('audit_log')) and its field logger_pid?
Now it looks very similar to audit_log.to and others, which are configuration options in this context. Maybe it worth to clarify it here to avoid a confusion.
Totktonada
reviewed
Feb 6, 2024
Comment on lines
+170
to
+179
| If the ``audit_log`` string starts with '|', | ||
| the string is interpreted as a Unix `pipeline <https://en.wikipedia.org/wiki/Pipeline_%28Unix%29>`_. |
There was a problem hiding this comment.
A pipeline connected to process'es stdin, I guess?
So, if there is no pipe at start, where the logs will be send?
(These my questions as a reader, I don't remember how it works.)
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
Totktonada
reviewed
Feb 6, 2024
doc/enterprise/audit_log.rst
Outdated
Comment on lines
624
to
625
| However, it is not recommended to use the entire memory, as this may cause performance degradation | ||
| and even loss of some logs. |
There was a problem hiding this comment.
That's an unclear recommendation, because there are no configurable memory limit for the audit log.
Totktonada
approved these changes
Feb 6, 2024
xuniq
force-pushed
the
gh-3667-audit-new
branch
from
97456da to
83f0975
Compare
* Add `audit_log` config section * Rewrite `Audit log module` page
xuniq
force-pushed
the
gh-3667-audit-new
branch
from
83f0975 to
849bb3d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated and restructured Audit module page
Added audit_log reference section:
Documented new audit log fields - uuid, severity
Added a new Severity level subsection to Custom events section (with examples)
Fixed typo in the
tt searchdescriptionFixes #3667
Fixes https://github.com/tarantool/enterprise_doc/issues/258
Fixes https://github.com/tarantool/enterprise_doc/issues/257
Fixes https://github.com/tarantool/enterprise_doc/issues/221 - also related to 2.11, don't forget to update this in 2.11 branch
Fixes https://github.com/tarantool/enterprise_doc/issues/248