WARNING: Version 5.6 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 Fields
editCommon monitoring fields Fields
editNone
type
edittype: keyword
required: True
The monitor type.
monitor
edittype: keyword
Monitor job name.
scheme
edittype: keyword
Address url scheme. For example tcp, ssl, http, and https.
host
edittype: keyword
Hostname of service being monitored. Can be missing, if service is monitored by IP.
port
edittype: integer
Service port number.
url
edittype: text
Service url used by monitor.
ip
edittype: 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 Fields
edittotal monitoring test duration
duration.us
edittype: long
Duration in microseconds
resolve_rtt Fields
editDuration required to resolve an IP from hostname.
resolve_rtt.us
edittype: long
Duration in microseconds
icmp_rtt Fields
editICMP Echo Request and Reply round trip time
icmp_rtt.us
edittype: long
Duration in microseconds
tcp_connect_rtt Fields
editDuration required to establish a TCP connection based on already available IP address.
tcp_connect_rtt.us
edittype: long
Duration in microseconds
socks5_connect_rtt Fields
editTime required to establish a connection via SOCKS5 to endpoint based on available connection to SOCKS5 proxy.
socks5_connect_rtt.us
edittype: long
Duration in microseconds
tls_handshake_rtt Fields
editTime required to finish TLS handshake based on already available network connection.
tls_handshake_rtt.us
edittype: long
Duration in microseconds
http_rtt Fields
editTime required between sending the HTTP request and first by from HTTP response being read. Duration based on already available network connection.
http_rtt.us
edittype: long
Duration in microseconds
validate_rtt Fields
editTime required for validating the connection if connection checks are configured.
validate_rtt.us
edittype: long
Duration in microseconds
response Fields
editService response parameters.
response.status
edittype: integer
Response status code.
up
edittype: boolean
required: True
Boolean indicator if monitor could validate the service to be available.
error Fields
editReason monitor flagging a service as down.
error.type
edittype: keyword
Failure type. For example io or validate.
error.message
edittype: text
Failure description.