Skip to content
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.

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

ECS Audit Logging Settings 7.11 doc page changes missed other branches #94679

Closed
nerophon opened this issue Mar 16, 2021 · 2 comments
Closed
Labels
bug Fixes for quality problems that affect the customer experience docs documentation Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more!

Comments

@nerophon
Copy link
Contributor

Kibana version: 7.11

Describe the bug:
https://www.elastic.co/guide/en/kibana/current/security-settings-kb.html#ecs-audit-logging-settings
This page shows the following correct example:

xpack.security.audit.appender:
  kind: rolling-file
  path: ./audit.log
  policy:
    kind: time-interval
    interval: 24h 
  strategy:
    kind: numeric
    max: 10 
  layout:
    kind: json

However, the same page on the wider branches is incorrect:

xpack.security.audit.appender:
  type: rolling-file
  fileName: ./audit.log
  policy:
    type: time-interval
    interval: 24h 
  strategy:
    type: numeric
    max: 10 
  layout:
    type: json

Pages affected:
https://www.elastic.co/guide/en/kibana/master/security-settings-kb.html#ecs-audit-logging-settings
https://www.elastic.co/guide/en/kibana/7.x/security-settings-kb.html#ecs-audit-logging-settings
https://www.elastic.co/guide/en/kibana/7.12/security-settings-kb.html#ecs-audit-logging-settings

This bug was noticed because there is a direct link into the 7.x branch via the ECS section (search "ECS" on the page) of:
https://www.elastic.co/blog/whats-new-kibana-7-11-0-alerting-generally-available

@nerophon nerophon added bug Fixes for quality problems that affect the customer experience docs documentation labels Mar 16, 2021
@jportner jportner added the Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more! label Sep 1, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-security (Team:Security)

@jportner
Copy link
Contributor

jportner commented Sep 1, 2021

These keys were intentionally changed starting in 7.12 via #90764.
The docs in 7.11 are correct.
The docs in 7.12+ have been updated to reflect the new keys (type, fileName), but the old keys (kind, path) will continue to work.

@jportner jportner closed this as completed Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience docs documentation Team:Security Team focused on: Auth, Users, Roles, Spaces, Audit Logging, and more!
Projects
None yet
Development

No branches or pull requests

3 participants