Docs be explicit on how to turn off deprecated auditing (#37316)
Just be explicit about turning off the deprecated audit log appender because we really want people to turn it off.
This commit is contained in:
parent
19fc59f089
commit
a88c050a05
|
@ -7,11 +7,36 @@ the `<clustername>_audit.log` file in the logs directory. To maintain
|
||||||
compatibility with releases prior to 6.5.0, a `<clustername>_access.log` file
|
compatibility with releases prior to 6.5.0, a `<clustername>_access.log` file
|
||||||
is also generated. They differ in the output format but the contents
|
is also generated. They differ in the output format but the contents
|
||||||
are similar. For systems that are not ingesting the audit file for search or
|
are similar. For systems that are not ingesting the audit file for search or
|
||||||
analytics it is strongly recommended to only keep the newer format.
|
analytics it is strongly recommended to keep only the newer format.
|
||||||
Turning off the deprecated output format can be achieved by disabling the logger
|
|
||||||
in the `log4j2.properties` file (hint: there is a config comment
|
To turn off the deprecated output format, you can disable the logger in the
|
||||||
about it).
|
`log4j2.properties` file:
|
||||||
For more information, see {ref}/logging.html#configuring-logging-levels[configuring-logging].
|
|
||||||
|
[source, properties]
|
||||||
|
--------------------------------------------------
|
||||||
|
# change info to off
|
||||||
|
# logger.xpack_security_audit_deprecated_logfile.level = info
|
||||||
|
logger.xpack_security_audit_deprecated_logfile.level = off
|
||||||
|
--------------------------------------------------
|
||||||
|
|
||||||
|
Alternatively, use the
|
||||||
|
{ref}/cluster-update-settings.html[cluster update settings API] to dynamically
|
||||||
|
configure the logger:
|
||||||
|
|
||||||
|
[source,js]
|
||||||
|
--------------------------------------------------
|
||||||
|
PUT /_cluster/settings
|
||||||
|
{
|
||||||
|
"persistent": {
|
||||||
|
"logger.org.elasticsearch.xpack.security.audit.logfile.DeprecatedLoggingAuditTrail": "off"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
--------------------------------------------------
|
||||||
|
// CONSOLE
|
||||||
|
|
||||||
|
NOTE: If you overwrite the `log4j2.properties` and do not specify appenders for
|
||||||
|
any of the audit trails, audit events are forwarded to the root appender, which
|
||||||
|
by default points to the `elasticsearch.log` file.
|
||||||
|
|
||||||
|
|
||||||
[float]
|
[float]
|
||||||
|
|
Loading…
Reference in New Issue