Skip to content

Commit

Permalink
[Auditbeat] System: Document entity_id fields (#18694)
Browse files Browse the repository at this point in the history
Adds docs about the `entity_id` fields that the system module uses to
identify entities. The machine-id sources for each OS as well as a
workaround for CentOS 6.x which doesn't have a machine-id by default.
  • Loading branch information
adriansr authored May 22, 2020
1 parent b0f7ae7 commit da2c4ed
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
20 changes: 20 additions & 0 deletions x-pack/auditbeat/docs/modules/system.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,26 @@ All datasets are currently using a poll model to retrieve their data.
The frequency of these polls is controlled by the `period` configuration
parameter.

[float]
==== Entity IDs

This module populates `entity_id` fields to uniquely identify entities (users,
packages, processes...) within a host. This requires {beatname_uc}
to obtain a unique identifier for the host:

- Windows: Uses the `HKLM\Software\Microsoft\Cryptography\MachineGuid` registry
key.
- macOS: Uses the value returned by `gethostuuid(2)` system call.
- Linux: Uses the content of one of the following files, created by either
`systemd` or `dbus`:
* /etc/machine-id
* /var/lib/dbus/machine-id
* /var/db/dbus/machine-id

NOTE: Under CentOS 6.x, it's possible that none of the files above exist.
In that case, running `dbus-uuidgen --ensure` (provided by the `dbus` package)
will generate one for you.

[float]
==== Example dashboard

Expand Down
20 changes: 20 additions & 0 deletions x-pack/auditbeat/module/system/_meta/docs.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,26 @@ All datasets are currently using a poll model to retrieve their data.
The frequency of these polls is controlled by the `period` configuration
parameter.

[float]
==== Entity IDs

This module populates `entity_id` fields to uniquely identify entities (users,
packages, processes...) within a host. This requires {beatname_uc}
to obtain a unique identifier for the host:

- Windows: Uses the `HKLM\Software\Microsoft\Cryptography\MachineGuid` registry
key.
- macOS: Uses the value returned by `gethostuuid(2)` system call.
- Linux: Uses the content of one of the following files, created by either
`systemd` or `dbus`:
* /etc/machine-id
* /var/lib/dbus/machine-id
* /var/db/dbus/machine-id

NOTE: Under CentOS 6.x, it's possible that none of the files above exist.
In that case, running `dbus-uuidgen --ensure` (provided by the `dbus` package)
will generate one for you.

[float]
==== Example dashboard

Expand Down

0 comments on commit da2c4ed

Please sign in to comment.