Skip to content

[Config] Update 'Audit log' to using a new config #3667

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
Tracked by #3957
andreyaksenov opened this issue Sep 1, 2023 · 1 comment · Fixed by #3983
Closed
Tracked by #3957

[Config] Update 'Audit log' to using a new config #3667

andreyaksenov opened this issue Sep 1, 2023 · 1 comment · Fixed by #3983
Assignees
@xuniq
Labels
3.0 config EE EE functionality

Comments

@andreyaksenov
Copy link
Contributor

andreyaksenov commented Sep 1, 2023 •
edited
Loading

Product: Tarantool
Since: 3.0
Root document:

SME: @ Totktonada

Details

Environment variables:

% tarantool --help-env-list | grep AUDIT
| TT_AUDIT_LOG_EXTRACT_KEY                    | boolean        | false                                         | Enterprise Edition |
| TT_AUDIT_LOG_FILE                           | string         | var/log/{{ instance_name }}/audit.log         | Enterprise Edition |
| TT_AUDIT_LOG_FILTER                         | array          | nil                                           | Enterprise Edition |
| TT_AUDIT_LOG_FORMAT                         | string         | json                                          | Enterprise Edition |
| TT_AUDIT_LOG_NONBLOCK                       | boolean        | false                                         | Enterprise Edition |
| TT_AUDIT_LOG_PIPE                           | string         | box.NULL                                      | Enterprise Edition |
| TT_AUDIT_LOG_SPACES                         | array          | box.NULL                                      | Enterprise Edition |
| TT_AUDIT_LOG_SYSLOG_FACILITY                | string         | local7                                        | Enterprise Edition |
| TT_AUDIT_LOG_SYSLOG_IDENTITY                | string         | tarantool                                     | Enterprise Edition |
| TT_AUDIT_LOG_SYSLOG_SERVER                  | string         | box.NULL                                      | Enterprise Edition |
| TT_AUDIT_LOG_TO                             | string         | devnull                                       | Enterprise Edition |

Schema: https://github.com/tarantool/tarantool/blob/aab0096945f0e1561429f45f7297e5082b2ea0af/src/box/lua/config/instance_config.lua#L1791

Migration from 2.11 to 3.0: https://docs.google.com/spreadsheets/d/1_yEK9N_hBVWIga9mOk7zZzA6Zd3mAq7e5KZsnrbgj30/edit#gid=0
@andreyaksenov andreyaksenov added 3.0 config EE EE functionality labels Sep 1, 2023
@andreyaksenov andreyaksenov mentioned this issue Sep 1, 2023
Closed
14 tasks
@xuniq xuniq self-assigned this Dec 14, 2023
@xuniq xuniq mentioned this issue Dec 15, 2023
Closed
@andreyaksenov andreyaksenov mentioned this issue Dec 21, 2023
Closed
14 tasks
@andreyaksenov
Copy link
Contributor Author

What's new section: https://www.tarantool.io/en/doc/latest/release/3.0.0/#audit-logging-ee

@xuniq xuniq mentioned this issue Jan 9, 2024
Merged
xuniq added a commit that referenced this issue Feb 8, 2024
@xuniq
[Config] Update 'Audit log' to using a new config (#3983)
4b018aa 
* Updated and restructured Audit module page
* Documented new audit log fields - uuid, severity
* Added a new Severity level subsection to Custom events section (with examples)
* Added audit_log reference section:
   - audit_log.extract_key, audit_log.spaces - new options
   - other options are moved from the box.cfg reference

* Fixed typo in the tt search description

Fixes #3667
Fixes tarantool/enterprise_doc#258
Fixes tarantool/enterprise_doc#257
Fixes tarantool/enterprise_doc#221 
Fixes tarantool/enterprise_doc#248
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@xuniq xuniq

Labels
3.0 config EE EE functionality
Projects
None yet
Milestone
No milestone
2 participants
@andreyaksenov @xuniq