-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Document all fields used in auditd dashboards #3962
Conversation
To allow the dashboards to load all fields used in the dashboards need to be in the Kibana index pattern. I also change pid, ppid, item, and item to just be keywords. There wasn’t really a good reason reason for these to be stored as numbers and sometime in the events these were set to characters like “?”.
filebeat/docs/fields.asciidoc
Outdated
The item field indicates which item out of the total number of items. This number is zero-based; a value of 0 means it is the first item. | ||
|
||
|
||
[float] | ||
=== auditd.log.a0 | ||
|
||
This first argument to the system call. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this say, "The first argument..."?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, will fix them all. Thanks
filebeat/docs/fields.asciidoc
Outdated
[float] | ||
=== auditd.log.res | ||
|
||
This result of the system call (success or failure). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this say, "The result of..."
description: > | ||
The item field indicates which item out of the total number of items. | ||
This number is zero-based; a value of 0 means it is the first item. | ||
- name: a0 | ||
description: > | ||
This first argument to the system call. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See above comment.
This first argument to the system call. | ||
- name: res | ||
description: > | ||
This result of the system call (success or failure). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See above comment.
… (elastic#3941) (elastic#3962) The PR adds an auditd module for parsing logs from the auditd daemon. There is a sample dashboard for viewing this data. Features - Parses audit event type, unix epoch time, audit event counter, and the arbitrary key/value pairs that follow. - Applies geoip lookup to the `auditd.log.addr` field which is present for some remote login events. - Decodes hex encoded ascii values that are sometimes used for the `auditd.log.exe` and `auditd.log.cmd` fields. - Remove key/value pairs where the value is `?`. Missing Features - Decoder for `auditd.log.saddr` field present in SOCKADDR audit events. A recipe is described [here](https://unix.stackexchange.com/questions/102926/how-to-interpret-the-saddr-field-of-an-audit-log) and could probably be ported to painless. Sample value: `type=SOCKADDR msg=audit(1481078693.491:873): saddr=01002F7661722F72756E2F6E7363642F736F636B657400008983B330BE7F0000000000000000000070830130BE7F000004000000000000001B00000000000000D128B7ED000000008B8BB330BE7F00003B00000000000000403E4BF7FD7F0000447F0130BE7F000080150230BE7F`
) (#3975) The PR adds an auditd module for parsing logs from the auditd daemon. There is a sample dashboard for viewing this data. Features - Parses audit event type, unix epoch time, audit event counter, and the arbitrary key/value pairs that follow. - Applies geoip lookup to the `auditd.log.addr` field which is present for some remote login events. - Decodes hex encoded ascii values that are sometimes used for the `auditd.log.exe` and `auditd.log.cmd` fields. - Remove key/value pairs where the value is `?`. Missing Features - Decoder for `auditd.log.saddr` field present in SOCKADDR audit events. A recipe is described [here](https://unix.stackexchange.com/questions/102926/how-to-interpret-the-saddr-field-of-an-audit-log) and could probably be ported to painless. Sample value: `type=SOCKADDR msg=audit(1481078693.491:873): saddr=01002F7661722F72756E2F6E7363642F736F636B657400008983B330BE7F0000000000000000000070830130BE7F000004000000000000001B00000000000000D128B7ED000000008B8BB330BE7F00003B00000000000000403E4BF7FD7F0000447F0130BE7F000080150230BE7F`
To allow the dashboards to load all fields used in the dashboards need to be in the Kibana index pattern.
I also changed pid, ppid, item, and item to just be keywords. There wasn’t really a good reason reason for these to be stored as numbers and sometimes in the events these were set to characters like “?”.