Skip to content

Compress audit logs #64472

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

Merged
merged 13 commits into from
Dec 2, 2020
Merged

Compress audit logs #64472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
226bc8c
Compress audit logs
pgomulka Nov 2, 2020
27f2b4c
remove accidental change
pgomulka Nov 3, 2020
e0dfbf5
Merge branch 'master' into zipping_audit_logs
pgomulka Nov 3, 2020
13da293
remove rolling policy
pgomulka Nov 6, 2020
c165661
Merge branch 'master' into zipping_audit_logs
pgomulka Nov 6, 2020
eaca5d5
Merge branch 'master' into zipping_audit_logs
elasticmachine Nov 10, 2020
d854639
empty line
pgomulka Nov 10, 2020
cb0b663
Merge branch 'zipping_audit_logs' of github.com:pgomulka/elasticsearc…
pgomulka Nov 10, 2020
5d6f559
set nomax for rollover
pgomulka Dec 1, 2020
0a10eab
Merge branch 'master' into zipping_audit_logs
elasticmachine Dec 1, 2020
5c298bc
breaking change doc
pgomulka Dec 1, 2020
f834bdc
Merge branch 'zipping_audit_logs' of github.com:pgomulka/elasticsearc…
pgomulka Dec 1, 2020
21aef69
fix docs
pgomulka Dec 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/reference/migration/migrate_8_0/security.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,24 @@ xpack.security.authc.realms.kerberos.kerb1:
remove_realm_name: false
--------------------------------------------------
====

[[audit-logs-are-rolled-over-and-archived-by-size]]
.Audit logs are rolled-over and archived by size.
[%collapsible]
====
*Details* +
In addition to the existing daily rollover, the security audit logs are
now rolled-over by disk size limit as well. Moreover, the rolled-over logs
are also gzip compressed.

*Impact* +
The names of rolled over audit logfiles (but not the name of the current log)
have changed.
If you've setup automated tools to consume these files, you must configure them
to use the new names and to possibly account for gzip archives instead of plaintext.
The Docker build of Elasticsearch is not affected since it logs on stdout where
rollover is not performed.
====
// end::notable-breaking-changes[]

[[accept-default-password-removed]]
Expand Down Expand Up @@ -181,7 +199,7 @@ xpack.security.http.ssl.certificate_authorities: [ "corporate-ca.crt" ]
<1> or `false`.
====

.A `xpack.security.transport.ssl` certificate and key are now required to enable SSL for the transport interface.
.A `xpack.security.transport.ssl` certificate and key are now required to enable SSL for the transport interface.
[%collapsible]
====
*Details* +
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/migration/migrate_8_0/transport.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=== Transport changes

//tag::notable-breaking-changes[]
.Several `tranport` settings have been replaced.
.Several `transport` settings have been replaced.
[%collapsible]
====
*Details* +
Expand All @@ -26,4 +26,4 @@ Specifying the removed settings in `elasticsearch.yml` will result in an error
on startup.
====

// end::notable-breaking-changes[]
// end::notable-breaking-changes[]
6 changes: 5 additions & 1 deletion x-pack/plugin/core/src/main/config/log4j2.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,15 @@ appender.audit_rolling.layout.pattern = {\
# "rule" name of the applied rule if the "origin.type" is "ip_filter"
# "event.category" fixed value "elasticsearch-audit"

appender.audit_rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_audit-%d{yyyy-MM-dd}.json
appender.audit_rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_audit-%d{yyyy-MM-dd}-%i.json.gz
appender.audit_rolling.policies.type = Policies
appender.audit_rolling.policies.time.type = TimeBasedTriggeringPolicy
appender.audit_rolling.policies.time.interval = 1
appender.audit_rolling.policies.time.modulate = true
appender.audit_rolling.policies.size.type = SizeBasedTriggeringPolicy
appender.audit_rolling.policies.size.size = 1GB
Copy link
Contributor

@albertzaharovits albertzaharovits Dec 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to explicitly set the nomax file index attribute.

appender.audit_rolling.strategy.type = DefaultRolloverStrategy
appender.audit_rolling.strategy.fileIndex = nomax

Copy link
Contributor Author

@pgomulka pgomulka Dec 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that's right, good find.

appender.audit_rolling.strategy.type = DefaultRolloverStrategy
appender.audit_rolling.strategy.fileIndex = nomax

logger.xpack_security_audit_logfile.name = org.elasticsearch.xpack.security.audit.logfile.LoggingAuditTrail
logger.xpack_security_audit_logfile.level = info
Expand Down