WARNING: Version 5.5 of Heartbeat has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
Common monitoring fields Fieldsedit
None
typeedit
type: keyword
required: True
The monitor type.
monitoredit
type: keyword
Monitor job name.
schemeedit
type: keyword
Address url scheme. For example tcp
, ssl
, http
, and https
.
hostedit
type: keyword
Hostname of service being monitored. Can be missing, if service is monitored by IP.
portedit
type: integer
Service port number.
urledit
type: text
Service url used by monitor.
ipedit
type: keyword
IP of service being monitored. If service is monitored by hostname, the ip
field contains the resolved ip address for the current host.
duration Fieldsedit
total monitoring test duration
duration.usedit
type: long
Duration in microseconds
resolve_rtt Fieldsedit
Duration required to resolve an IP from hostname.
resolve_rtt.usedit
type: long
Duration in microseconds
icmp_rtt Fieldsedit
ICMP Echo Request and Reply round trip time
icmp_rtt.usedit
type: long
Duration in microseconds
tcp_connect_rtt Fieldsedit
Duration required to establish a TCP connection based on already available IP address.
tcp_connect_rtt.usedit
type: long
Duration in microseconds
socks5_connect_rtt Fieldsedit
Time required to establish a connection via SOCKS5 to endpoint based on available connection to SOCKS5 proxy.
socks5_connect_rtt.usedit
type: long
Duration in microseconds
tls_handshake_rtt Fieldsedit
Time required to finish TLS handshake based on already available network connection.
tls_handshake_rtt.usedit
type: long
Duration in microseconds
http_rtt Fieldsedit
Time required between sending the HTTP request and first by from HTTP response being read. Duration based on already available network connection.
http_rtt.usedit
type: long
Duration in microseconds
validate_rtt Fieldsedit
Time required for validating the connection if connection checks are configured.
validate_rtt.usedit
type: long
Duration in microseconds
response Fieldsedit
Service response parameters.
response.statusedit
type: integer
Response status code.
upedit
type: boolean
required: True
Boolean indicator if monitor could validate the service to be available.
error Fieldsedit
Reason monitor flagging a service as down.
error.typeedit
type: keyword
Failure type. For example io
or validate
.
error.messageedit
type: text
Failure description.