1
+ [role="xpack"]
1
2
[[auditing]]
2
- == Auditing Security Events
3
+ == Auditing security events
3
4
4
5
You can enable auditing to keep track of security-related events such as
5
6
authentication failures and refused connections. Logging these events enables you
@@ -40,7 +41,7 @@ events are pushed to the index by setting
40
41
41
42
[float]
42
43
[[audit-event-types]]
43
- === Audit Event Types
44
+ === Audit event types
44
45
45
46
Each request may generate multiple audit events.
46
47
The 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:
81
82
82
83
[float]
83
84
[[audit-event-attributes]]
84
- === Audit Event Attributes
85
+ === Audit event attributes
85
86
86
87
The following table shows the common attributes that can be associated with every event.
87
88
88
- .Common Attributes
89
+ .Common attributes
89
90
[cols="2,7",options="header"]
90
91
|======
91
92
| Attribute | Description
@@ -103,7 +104,7 @@ The following table shows the common attributes that can be associated with ever
103
104
The following tables show the attributes that can be associated with each type of event.
104
105
The log level determines which attributes are included in a log entry.
105
106
106
- .REST anonymous_access_denied Attributes
107
+ .REST anonymous_access_denied attributes
107
108
[cols="2,7",options="header"]
108
109
|======
109
110
| Attribute | Description
@@ -112,7 +113,7 @@ The log level determines which attributes are included in a log entry.
112
113
| `request_body` | The body of the request, if enabled.
113
114
|======
114
115
115
- .REST authentication_success Attributes
116
+ .REST authentication_success attributes
116
117
[cols="2,7",options="header"]
117
118
|======
118
119
| Attribute | Description
@@ -123,7 +124,7 @@ The log level determines which attributes are included in a log entry.
123
124
| `request_body` | The body of the request, if enabled.
124
125
|======
125
126
126
- .REST authentication_failed Attributes
127
+ .REST authentication_failed attributes
127
128
[cols="2,7",options="header"]
128
129
|======
129
130
| Attribute | Description
@@ -133,7 +134,7 @@ The log level determines which attributes are included in a log entry.
133
134
| `request_body` | The body of the request, if enabled.
134
135
|======
135
136
136
- .REST realm_authentication_failed Attributes
137
+ .REST realm_authentication_failed attributes
137
138
[cols="2,7",options="header"]
138
139
|======
139
140
| Attribute | Description
@@ -146,7 +147,7 @@ The log level determines which attributes are included in a log entry.
146
147
consulted realm.
147
148
|======
148
149
149
- .Transport anonymous_access_denied Attributes
150
+ .Transport anonymous_access_denied attributes
150
151
[cols="2,7",options="header"]
151
152
|======
152
153
| Attribute | Description
@@ -161,7 +162,7 @@ The log level determines which attributes are included in a log entry.
161
162
pertains to (when applicable).
162
163
|======
163
164
164
- .Transport authentication_success Attributes
165
+ .Transport authentication_success attributes
165
166
[cols="2,7",options="header"]
166
167
|======
167
168
| Attribute | Description
@@ -176,7 +177,7 @@ The log level determines which attributes are included in a log entry.
176
177
| `request` | The type of request that was executed.
177
178
|======
178
179
179
- .Transport authentication_failed Attributes
180
+ .Transport authentication_failed attributes
180
181
[cols="2,7",options="header"]
181
182
|======
182
183
| Attribute | Description
@@ -192,7 +193,7 @@ The log level determines which attributes are included in a log entry.
192
193
pertains to (when applicable).
193
194
|======
194
195
195
- .Transport realm_authentication_failed Attributes
196
+ .Transport realm_authentication_failed attributes
196
197
[cols="2,7",options="header"]
197
198
|======
198
199
| Attribute | Description
@@ -211,7 +212,7 @@ The log level determines which attributes are included in a log entry.
211
212
consulted realm.
212
213
|======
213
214
214
- .Transport access_granted Attributes
215
+ .Transport access_granted attributes
215
216
[cols="2,7",options="header"]
216
217
|======
217
218
| Attribute | Description
@@ -228,7 +229,7 @@ The log level determines which attributes are included in a log entry.
228
229
pertains to (when applicable).
229
230
|======
230
231
231
- .Transport access_denied Attributes
232
+ .Transport access_denied attributes
232
233
[cols="2,7",options="header"]
233
234
|======
234
235
| Attribute | Description
@@ -245,7 +246,7 @@ The log level determines which attributes are included in a log entry.
245
246
relates to (when applicable).
246
247
|======
247
248
248
- .Transport tampered_request Attributes
249
+ .Transport tampered_request attributes
249
250
[cols="2,7",options="header"]
250
251
|======
251
252
| Attribute | Description
@@ -261,7 +262,7 @@ The log level determines which attributes are included in a log entry.
261
262
pertains to (when applicable).
262
263
|======
263
264
264
- .IP Filter connection_granted Attributes
265
+ .IP filter connection_granted attributes
265
266
[cols="2,7",options="header"]
266
267
|======
267
268
| Attribute | Description
@@ -271,7 +272,7 @@ The log level determines which attributes are included in a log entry.
271
272
the request.
272
273
|======
273
274
274
- .IP Filter connection_denied Attributes
275
+ .IP filter connection_denied attributes
275
276
[cols="2,7",options="header"]
276
277
|======
277
278
| Attribute | Description
@@ -283,14 +284,14 @@ The log level determines which attributes are included in a log entry.
283
284
284
285
[float]
285
286
[[audit-log-output]]
286
- === Logfile Audit Output
287
+ === Logfile audit output
287
288
288
289
The `logfile` audit output is the default output for auditing. It writes data to
289
290
the `<clustername>_access.log` file in the logs directory.
290
291
291
292
[float]
292
293
[[audit-log-entry-format]]
293
- === Log Entry Format
294
+ === Log entry format
294
295
295
296
The format of a log entry is:
296
297
@@ -318,7 +319,7 @@ The format of a log entry is:
318
319
319
320
[float]
320
321
[[audit-log-settings]]
321
- === Logfile Output Settings
322
+ === Logfile output settings
322
323
323
324
The events and some other information about what gets logged can be
324
325
controlled 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
336
337
337
338
[float]
338
339
[[audit-log-ignore-policy]]
339
- === Logfile Audit Events Ignore Policies
340
+ === Logfile audit events ignore policies
340
341
341
342
The comprehensive audit trail is necessary to ensure accountability. It offers tremendous
342
343
value during incident response and can even be required for demonstrating compliance.
@@ -414,7 +415,7 @@ xpack.security.audit.logfile.events.ignore_filters:
414
415
415
416
[float]
416
417
[[audit-index]]
417
- === Index Audit Output
418
+ === Index audit output
418
419
419
420
In addition to logging to a file, you can store audit logs in Elasticsearch
420
421
rolling indices. These indices can be either on the same cluster, or on a
@@ -429,13 +430,13 @@ xpack.security.audit.outputs: [ index, logfile ]
429
430
----------------------------
430
431
431
432
For 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 ].
433
434
434
435
IMPORTANT: No filtering is performed when auditing, so sensitive data may be
435
436
audited in plain text when including the request body in audit events.
436
437
437
438
[float]
438
- ==== Audit Index Settings
439
+ ==== Audit index settings
439
440
440
441
You can also configure settings for the indices that the events are stored in.
441
442
These settings are configured in the `xpack.security.audit.index.settings` namespace
@@ -451,7 +452,7 @@ xpack.security.audit.index.settings:
451
452
----------------------------
452
453
453
454
[float]
454
- ==== Forwarding Audit Logs to a Remote Cluster
455
+ ==== Forwarding audit logs to a remote cluster
455
456
456
457
To index audit events to a remote Elasticsearch cluster, you configure
457
458
the following `xpack.security.audit.index.client` settings:
0 commit comments