Audit log¶
Журнал аудита содержит записи о событиях безопасности в TDG.
To view the log:
Configure at least one instance with the
storagerole.Go to the Cluster tab and click the Bootstrap vshard button.
Go to the Audit log tab.
Note
Начиная с версии 2.6.1, журнал аудита работает на основе встроенного Tarantool-модуля audit и настраивается отдельно
от журнала событий.
Подробности о модуле audit приведена в
документации платформы Tarantool.
В версиях до 2.6.1 журнал аудита использует встроенный Tarantool-модуль log, события безопасности при этом
отображаются вместе с логами журнала событий.
Enabling and disabling the audit log¶
The audit log is enabled by default and records messages regardless of authorization settings.
Отключить ведение журнала аудита можно одним из способов ниже:
на вкладке Audit log нажать кнопку Disable logging;
на вкладке Settings > Audit logs отключить опцию Audit logging enabled. Доступно с версии 2.18.0;
на вкладке Graphql выполнить следующий запрос:
mutation { audit_log { config { enabled(value: false) } } }
Note
При использовании версии ниже 2.18.0 для выполнения мутации используйте формат ниже:
mutation {
audit_log {
enabled(value: false)
}
}
To check if the audit log is enabled:
query {
audit_log {
config {
enabled
}
}
}
Note
При использовании версии ниже 2.18.0 для проверки включенного журнала аудита используйте запрос ниже:
query {
audit_log {
enabled
}
}
Clearing the audit log¶
Журнал аудита хранится в memtx.
Если явно задать время жизни для событий безопасности (опция remove_older_than_n_hours),
события с истекшим сроком жизни в журнале будут очищаться автоматически.
По умолчанию срок хранения событий в журнале аудита не ограничен.
To fully clear the space associated with the audit log, run the following GraphQL code:
mutation {
audit_log {
clear
}
}
Log structure¶
Each table entry provides the following information:
Severity
From - To
Subject ID
Subject
Request ID
Module
Node (Узел)
Message
The audit log can be filtered by each of the parameters. Below is more information about every one of them.
Severity¶
Possible values (in order of ascending severity):
VERBOSE – детальная информация;
INFO – уведомление;
WARNING – предупреждение;
ALARM – тревога.
A filter by severity displays events of the specified level or more severe. Choose the “VERBOSE” filter to display all messages.
From - To¶
Дата и время события. По умолчанию время события отображается в часовом поясе GMT+0 (или UTC). Начиная с версии 2.15.0, в таблице при наведении курсора на время события отображается всплывающая подсказка с исходным временем, которое передал сервер.
Начиная с версии 2.17.0, задать часовой пояс можно в настройках на вкладке *Settings > Time Zone.
Subject ID¶
Internal identifier of the access subject.
Subject¶
Access subject name and type. Possible values:
system %q: системное сообщение, где%q– имя сущности в системе.token %q: доступ к HTTP API при помощи токена приложения (например, чтобы получить данные GraphQL), где%q– имя сущности, запросившей доступ.user: access attempt from GUI.anonymous: access attempt from GUI, if mandatory authorization is disabled.unauthorized: access attempt from GUI by an unauthorized user.
Request ID¶
Internal identifier of the request.
Module¶
Name of the system module that initiated the event. Examples: common.admin.auth is the module responsible for authorization.
Node¶
Доступно с версии 2.18.0.
Идентификатор экземпляра TDG, на котором произошло событие журнала аудита.
Message¶
Event description. Can be provided by the user.
Конфигурация журнала аудита¶
В файле конфигурации¶
The default settings that Tarantool Data Grid starts up with can be found in the file config.yml. Audit log settings can be listed in this
audit_log:
remove_older_than_n_hours: 24 # how many hours a message should exist before being deleted
severity: VERBOSE # record messages of this severity level and higher
enabled: true
Список поддерживаемых опций конфигурации для журнала аудита приведен в справочнике по конфигурации.
В веб-интерфейсе¶
В веб-интерфейсе задать настройки журнала аудита можно на вкладке Settings > Audit logs. С версии 2.18.0 доступны следующие настройки:
флаг Audit logging enabled – включить или отключить ведение журнала аудита;
Logging level – минимальный уровень важности записываемых событий;
Remove entries older than (hours) – время жизни сообщения в часах.
Кнопка Clear audit log очищает журнал аудита.
