1+ [role="xpack"]
12[[auditing]]
2- == Auditing Security Events
3+ == Auditing security events
34
45You can enable auditing to keep track of security-related events such as
56authentication failures and refused connections. Logging these events enables you
@@ -40,7 +41,7 @@ events are pushed to the index by setting
4041
4142[float]
4243[[audit-event-types]]
43- === Audit Event Types
44+ === Audit event types
4445
4546Each request may generate multiple audit events.
4647The following is a list of the events that can be generated:
@@ -81,11 +82,11 @@ The following is a list of the events that can be generated:
8182
8283[float]
8384[[audit-event-attributes]]
84- === Audit Event Attributes
85+ === Audit event attributes
8586
8687The following table shows the common attributes that can be associated with every event.
8788
88- .Common Attributes
89+ .Common attributes
8990[cols="2,7",options="header"]
9091|======
9192| Attribute | Description
@@ -103,7 +104,7 @@ The following table shows the common attributes that can be associated with ever
103104The following tables show the attributes that can be associated with each type of event.
104105The log level determines which attributes are included in a log entry.
105106
106- .REST anonymous_access_denied Attributes
107+ .REST anonymous_access_denied attributes
107108[cols="2,7",options="header"]
108109|======
109110| Attribute | Description
@@ -112,7 +113,7 @@ The log level determines which attributes are included in a log entry.
112113| `request_body` | The body of the request, if enabled.
113114|======
114115
115- .REST authentication_success Attributes
116+ .REST authentication_success attributes
116117[cols="2,7",options="header"]
117118|======
118119| Attribute | Description
@@ -123,7 +124,7 @@ The log level determines which attributes are included in a log entry.
123124| `request_body` | The body of the request, if enabled.
124125|======
125126
126- .REST authentication_failed Attributes
127+ .REST authentication_failed attributes
127128[cols="2,7",options="header"]
128129|======
129130| Attribute | Description
@@ -133,7 +134,7 @@ The log level determines which attributes are included in a log entry.
133134| `request_body` | The body of the request, if enabled.
134135|======
135136
136- .REST realm_authentication_failed Attributes
137+ .REST realm_authentication_failed attributes
137138[cols="2,7",options="header"]
138139|======
139140| Attribute | Description
@@ -146,7 +147,7 @@ The log level determines which attributes are included in a log entry.
146147 consulted realm.
147148|======
148149
149- .Transport anonymous_access_denied Attributes
150+ .Transport anonymous_access_denied attributes
150151[cols="2,7",options="header"]
151152|======
152153| Attribute | Description
@@ -161,7 +162,7 @@ The log level determines which attributes are included in a log entry.
161162 pertains to (when applicable).
162163|======
163164
164- .Transport authentication_success Attributes
165+ .Transport authentication_success attributes
165166[cols="2,7",options="header"]
166167|======
167168| Attribute | Description
@@ -176,7 +177,7 @@ The log level determines which attributes are included in a log entry.
176177| `request` | The type of request that was executed.
177178|======
178179
179- .Transport authentication_failed Attributes
180+ .Transport authentication_failed attributes
180181[cols="2,7",options="header"]
181182|======
182183| Attribute | Description
@@ -192,7 +193,7 @@ The log level determines which attributes are included in a log entry.
192193 pertains to (when applicable).
193194|======
194195
195- .Transport realm_authentication_failed Attributes
196+ .Transport realm_authentication_failed attributes
196197[cols="2,7",options="header"]
197198|======
198199| Attribute | Description
@@ -211,7 +212,7 @@ The log level determines which attributes are included in a log entry.
211212 consulted realm.
212213|======
213214
214- .Transport access_granted Attributes
215+ .Transport access_granted attributes
215216[cols="2,7",options="header"]
216217|======
217218| Attribute | Description
@@ -228,7 +229,7 @@ The log level determines which attributes are included in a log entry.
228229 pertains to (when applicable).
229230|======
230231
231- .Transport access_denied Attributes
232+ .Transport access_denied attributes
232233[cols="2,7",options="header"]
233234|======
234235| Attribute | Description
@@ -245,7 +246,7 @@ The log level determines which attributes are included in a log entry.
245246 relates to (when applicable).
246247|======
247248
248- .Transport tampered_request Attributes
249+ .Transport tampered_request attributes
249250[cols="2,7",options="header"]
250251|======
251252| Attribute | Description
@@ -261,7 +262,7 @@ The log level determines which attributes are included in a log entry.
261262 pertains to (when applicable).
262263|======
263264
264- .IP Filter connection_granted Attributes
265+ .IP filter connection_granted attributes
265266[cols="2,7",options="header"]
266267|======
267268| Attribute | Description
@@ -271,7 +272,7 @@ The log level determines which attributes are included in a log entry.
271272 the request.
272273|======
273274
274- .IP Filter connection_denied Attributes
275+ .IP filter connection_denied attributes
275276[cols="2,7",options="header"]
276277|======
277278| Attribute | Description
@@ -283,14 +284,14 @@ The log level determines which attributes are included in a log entry.
283284
284285[float]
285286[[audit-log-output]]
286- === Logfile Audit Output
287+ === Logfile audit output
287288
288289The `logfile` audit output is the default output for auditing. It writes data to
289290the `<clustername>_access.log` file in the logs directory.
290291
291292[float]
292293[[audit-log-entry-format]]
293- === Log Entry Format
294+ === Log entry format
294295
295296The format of a log entry is:
296297
@@ -318,7 +319,7 @@ The format of a log entry is:
318319
319320[float]
320321[[audit-log-settings]]
321- === Logfile Output Settings
322+ === Logfile output settings
322323
323324The events and some other information about what gets logged can be
324325controlled using settings in the `elasticsearch.yml` file. See
@@ -336,7 +337,7 @@ file located in `CONFIG_DIR`. By default, audit information is appended to the
336337
337338[float]
338339[[audit-log-ignore-policy]]
339- === Logfile Audit Events Ignore Policies
340+ === Logfile audit events ignore policies
340341
341342The comprehensive audit trail is necessary to ensure accountability. It offers tremendous
342343value during incident response and can even be required for demonstrating compliance.
@@ -414,7 +415,7 @@ xpack.security.audit.logfile.events.ignore_filters:
414415
415416[float]
416417[[audit-index]]
417- === Index Audit Output
418+ === Index audit output
418419
419420In addition to logging to a file, you can store audit logs in Elasticsearch
420421rolling indices. These indices can be either on the same cluster, or on a
@@ -429,13 +430,13 @@ xpack.security.audit.outputs: [ index, logfile ]
429430----------------------------
430431
431432For more configuration options, see
432- {ref}/auditing-settings.html#index-audit-settings[Audit Log Indexing Configuration Settings ].
433+ {ref}/auditing-settings.html#index-audit-settings[Audit log indexing configuration settings ].
433434
434435IMPORTANT: No filtering is performed when auditing, so sensitive data may be
435436audited in plain text when including the request body in audit events.
436437
437438[float]
438- ==== Audit Index Settings
439+ ==== Audit index settings
439440
440441You can also configure settings for the indices that the events are stored in.
441442These settings are configured in the `xpack.security.audit.index.settings` namespace
@@ -451,7 +452,7 @@ xpack.security.audit.index.settings:
451452----------------------------
452453
453454[float]
454- ==== Forwarding Audit Logs to a Remote Cluster
455+ ==== Forwarding audit logs to a remote cluster
455456
456457To index audit events to a remote Elasticsearch cluster, you configure
457458the following `xpack.security.audit.index.client` settings:
0 commit comments