forked from elastic/beats
/
fields.common.yml
599 lines (566 loc) · 18.1 KB
/
fields.common.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
- key: common
title: "Common heartbeat monitor"
description:
fields:
- name: monitor
type: group
description: >
Common monitor fields.
fields:
- name: type
type: keyword
description: >
The monitor type.
- name: name
type: keyword
description: >
The monitors configured name
multi_fields:
- name: text
type: text
analyzer: simple
- name: id
type: keyword
description: >
The monitors full job ID as used by heartbeat.
multi_fields:
- name: text
type: text
analyzer: simple
- name: duration
type: group
description: Total monitoring test duration
fields:
- name: us
type: long
description: Duration in microseconds
- name: scheme
type: alias
path: url.scheme
migration: true
description: >
Address url scheme. For example `tcp`, `tls`, `http`, and `https`.
- name: host
type: alias
path: url.domain
migration: true
description: >
Hostname of service being monitored. Can be missing, if service is
monitored by IP.
- name: ip
type: ip
description: >
IP of service being monitored. If service is monitored by hostname,
the `ip` field contains the resolved ip address for the current host.
- name: status
required: true
type: keyword
description: >
Indicator if monitor could validate the service to be available.
- name: check_group
type: keyword
description: >
A token unique to a simultaneously invoked group of checks as in the case where multiple IPs are checked for a single DNS entry.
- name: timespan
type: date_range
description: >
Time range this ping reported starting at the instant the check was started, ending at the start of the next scheduled check.
- name: origin
type: keyword
description: >
The origin of this monitor configuration, usually either "ui", or "project"
- name: project
type: group
description: >
Project info for this monitor
fields:
- name: id
type: keyword
description: Project ID
- name: name
type: keyword
description: Project name
- key: state
title: "Monitor state"
description: state related fields
fields:
- name: state
type: group
description: "Present in the last event emitted during a check. If a monitor checks multiple endpoints, as is the case with `mode: all`."
fields:
- name: id
type: keyword
description: >
ID of this state
- name: started_at
type: date
description: >
First time state with this ID was seen
- name: duration_ms
type: long
description: >
Length of time this state has existed in millis
- name: status
type: keyword
description: >
The current status, "up", "down", or "flapping"
any state can change into flapping.
- name: checks
type: integer
description: total checks run
- name: up
type: integer
description: total up checks run
- name: down
type: integer
description: total down checks run
- name: flap_history
enabled: false
- name: ends
type: object
description: the state that was ended by this state
fields:
- name: id
type: keyword
description: >
ID of this state
- name: started_at
type: date
description: >
First time state with this ID was seen
- name: duration_ms
type: long
description: >
Length of time this state has existed in millis
- name: status
type: keyword
description: >
The current status, "up", "down", or "flapping"
any state can change into flapping.
- name: checks
type: integer
description: total checks run
- name: up
type: integer
description: total up checks run
- name: down
type: integer
description: total down checks run
- key: summary
title: "Monitor summary"
description:
fields:
- name: summary
type: group
description: "Present in the last event emitted during a check. If a monitor checks multiple endpoints, as is the case with `mode: all`."
fields:
- name: up
type: integer
description: >
The number of endpoints that succeeded
- name: down
type: integer
description: >
The number of endpoints that failed
- key: service
title: "APM Service"
description:
fields:
- name: name
type: keyword
description: APM service name this monitor is linked to
- key: resolve
title: "Host lookup"
description:
fields:
- name: resolve
type: group
description: >
Host lookup fields.
fields:
- name: host
type: alias
path: url.domain
migration: true
description: >
Hostname of service being monitored.
- name: ip
type: ip
description: >
IP address found for the given host.
- name: rtt
type: group
description: Duration required to resolve an IP from hostname.
fields:
- name: us
type: long
description: Duration in microseconds
- key: synthetics
title: "Synthetics types"
description:
fields:
- name: synthetics
type: group
description: >
Synthetics related fields.
fields:
- name: type
type: keyword
- name: package_version
type: keyword
- name: index
type: integer
description: >
Indexed used for creating total order of all events
in this invocation.
- name: payload
type: object
enabled: false
- name: blob
type: binary
description: binary data payload
- name: blob_mime
type: keyword
description: mime type of blob data
- name: step
type: group
fields:
- name: name
type: text
multi_fields:
- name: keyword
type: keyword
- name: index
type: integer
- name: status
type: keyword
- name: duration
type: group
description: Duration required to complete the step.
fields:
- name: us
type: integer
description: Duration in microseconds
- name: journey
type: group
fields:
- name: name
type: text
- name: id
type: keyword
- name: tags
description: Tags used for grouping journeys
type: keyword
- name: error
type: group
fields:
- name: name
type: keyword
- name: message
type: text
- name: stack
type: text
- name: screenshot_ref
type: group
dynamic: false
fields:
- name: width
type: integer
description: Width of the full screenshot in pixels.
- name: height
type: integer
description: Height of the full screenshot in pixels
- name: blocks
type: group
description: Attributes representing individual screenshot blocks. Only hash is indexed since it's the only one we'd query on.
fields:
- name: hash
type: keyword
description: Hash that uniquely identifies this image by content. Corresponds to block document id.
- key: browser
title: "Synthetics browser metrics"
description:
fields:
- name: browser
type: group
description: Browser metrics and traces
fields:
- name: experience
type: group
description: >
Absolute values of all user experience metrics in the browser
relative to the navigation start event in microseconds
fields:
- name: fcp
type: group
description: duration of First contentful paint metric
fields:
- name: us
type: integer
- name: lcp
type: group
description: duration of Largest contentful paint metric
fields:
- name: us
type: integer
- name: dcl
type: group
description: duration of Document content loaded end event
fields:
- name: us
type: integer
- name: load
type: group
description: duration of Load end event
fields:
- name: duration
type: integer
- name: cls
type: integer
description: culumative layout shift score across all frames
- name: relative_trace
type: group
description: >
trace event with timing information that are realtive to
journey timings in microseconds
fields:
- name: name
type: keyword
description: name of the trace event
- name: type
type: text
description: could be one of mark or measure event types
- name: start
type: group
description: monotonically increasing trace start time in microseconds
fields:
- name: us
type: long
- name: duration
type: group
description: duration of the trace event in microseconds.
fields:
- name: us
type: integer
- name: score
type: integer
description: weighted score of the layout shift event
- key: http
title: "HTTP monitor"
description:
fields:
- name: http
type: group
description: >
HTTP related fields.
fields:
- name: url
type: alias
path: url.full
migration: true
description: >
Service url used by monitor.
- name: response
type: group
fields:
- name: body
type: group
fields:
- name: hash
type: keyword
description: >
Hash of the full response body. Can be used to group responses with identical hashes.
- name: redirects
type: keyword
description: >
List of redirects followed to arrive at final content. Last item on the list is the URL for which
body content is shown.
- name: headers.*
type: object
enabled: false
description: >
The canonical headers of the monitored HTTP response.
- name: rtt
type: group
description: >
HTTP layer round trip times.
fields:
- name: validate
type: group
description: |
Duration between first byte of HTTP request being written and
response being processed by validator. Duration based on already
available network connection.
Note: if validator is not reading body or only a prefix, this
number does not fully represent the total time needed
to read the body.
fields:
- name: us
type: long
description: Duration in microseconds
- name: validate_body
type: group
description: |
Duration of validator required to read and validate the response
body.
Note: if validator is not reading body or only a prefix, this
number does not fully represent the total time needed
to read the body.
fields:
- name: us
type: long
description: Duration in microseconds
- name: write_request
type: group
description:
Duration of sending the complete HTTP request. Duration based on
already available network connection.
fields:
- name: us
type: long
description: Duration in microseconds
- name: response_header
type: group
description:
Time required between sending the start of sending the HTTP
request and first byte from HTTP response being read. Duration
based on already available network connection.
fields:
- name: us
type: long
description: Duration in microseconds
- name: content.us
type: long
description: Time required to retrieved the content in micro seconds.
- name: total
type: group
description: |
Duration required to process the HTTP transaction. Starts with
the initial TCP connection attempt. Ends with after validator
did check the response.
Note: if validator is not reading body or only a prefix, this
number does not fully represent the total time needed.
fields:
- name: us
type: long
description: Duration in microseconds
- key: tcp
title: "TCP layer"
description:
fields:
- name: tcp
type: group
description: >
TCP network layer related fields.
fields:
- name: port
type: alias
path: url.port
migration: true
description: >
Service port number.
- name: rtt
type: group
description: >
TCP layer round trip times.
fields:
- name: connect
type: group
description: >
Duration required to establish a TCP connection based on already
available IP address.
fields:
- name: us
type: long
description: Duration in microseconds
- name: validate
type: group
description: >
Duration of validation step based on existing TCP connection.
fields:
- name: us
type: long
description: Duration in microseconds
- key: socks5
title: "SOCKS5 proxy"
description:
fields:
- name: socks5
type: group
description: >
SOCKS5 proxy related fields:
fields:
- name: rtt
type: group
description: >
TLS layer round trip times.
fields:
- name: connect
type: group
description: >
Time required to establish a connection via SOCKS5 to endpoint
based on available connection to SOCKS5 proxy.
fields:
- name: us
type: long
description: Duration in microseconds
- key: tls
title: "TLS encryption layer"
description:
fields:
- name: tls
type: group
description: >
TLS layer related fields.
fields:
- name: certificate_not_valid_before
type: date
deprecated: 7.8.0
description: Deprecated in favor of `tls.server.x509.not_before`. Earliest time at which the connection's certificates are valid.
- name: certificate_not_valid_after
deprecated: 7.8.0
type: date
description: Deprecated in favor of `tls.server.x509.not_after`. Latest time at which the connection's certificates are valid.
- name: rtt
type: group
description: >
TLS layer round trip times.
fields:
- name: handshake
type: group
description: >
Time required to finish TLS handshake based on already available network
connection.
fields:
- name: us
type: long
description: Duration in microseconds
- name: server
type: group
description: Detailed x509 certificate metadata
fields:
- name: version_number
type: keyword
ignore_above: 1024
description: Version of x509 format.
example: 3
- key: icmp
title: "ICMP"
description:
fields:
- name: icmp
type: group
description: >
IP ping fields.
fields:
- name: requests
type: integer
description: >
Number if ICMP EchoRequests send.
- name: rtt
type: group
description: ICMP Echo Request and Reply round trip time
fields:
- name: us
type: long
description: Duration in microseconds