• Heartbeat Reference: other versions:
  • Heartbeat overview
  • Quick start: installation and configuration
  • Set up and run
    • Directory layout
    • Secrets keystore
    • Command reference
    • Repositories for APT and YUM
    • Run Heartbeat on Docker
    • Running Heartbeat on Kubernetes
    • Heartbeat and systemd
    • Stop Heartbeat
    • Windows Installation Script
  • Configure
    • Monitors
      • Common monitor options
      • ICMP options
      • TCP options
      • HTTP options
    • Task scheduler
    • General settings
    • Project paths
    • Output
      • Elasticsearch Service
      • Elasticsearch
      • Logstash
      • Kafka
      • Redis
      • File
      • Console
      • Discard
      • Change the output codec
    • Kerberos
    • SSL
    • Index lifecycle management (ILM)
    • Elasticsearch index template
    • Processors
      • Define processors
      • add_cloud_metadata
      • add_cloudfoundry_metadata
      • add_docker_metadata
      • add_fields
      • add_host_metadata
      • add_id
      • add_kubernetes_metadata
      • add_labels
      • add_locale
      • add_network_direction
      • add_nomad_metadata
      • add_observer_metadata
      • add_process_metadata
      • add_tags
      • append
      • community_id
      • convert
      • copy_fields
      • decode_base64_field
      • decode_duration
      • decode_json_fields
      • decode_xml
      • decode_xml_wineventlog
      • decompress_gzip_field
      • detect_mime_type
      • dissect
      • dns
      • drop_event
      • drop_fields
      • extract_array
      • fingerprint
      • include_fields
      • move_fields
      • rate_limit
      • registered_domain
      • rename
      • replace
      • script
      • syslog
      • translate_ldap_attribute
      • translate_sid
      • truncate_fields
      • urldecode
    • Autodiscover
      • Hints based autodiscover
      • Advanced usage
    • Internal queue
    • Logging
    • HTTP endpoint
    • Regular expression support
    • Instrumentation
    • Feature flags
    • heartbeat.reference.yml
  • How to guides
    • Add observer and geo metadata
    • Load the Elasticsearch index template
    • Change the index name
    • Enrich events with geoIP information
    • Use environment variables in the configuration
    • Parse data using an ingest pipeline
    • Avoid YAML formatting problems
  • Exported fields
    • Beat fields
    • Synthetics browser metrics fields
    • Cloud provider metadata fields
    • Common heartbeat monitor fields
    • Docker fields
    • ECS fields
    • Host fields
    • HTTP monitor fields
    • ICMP fields
    • Jolokia Discovery autodiscover provider fields
    • Kubernetes fields
    • Process fields
    • Host lookup fields
    • APM Service fields
    • SOCKS5 proxy fields
    • Monitor state fields
    • Monitor summary fields
    • Synthetics types fields
    • TCP layer fields
    • TLS encryption layer fields
  • Monitor
    • Use internal collection
      • Settings for internal collection
    • Use Metricbeat collection
  • Secure
    • Grant users access to secured resources
      • Create a setup user
      • Create a monitoring user
      • Create a publishing user
      • Create a reader user
      • Learn more about privileges, roles, and users
    • Grant access using API keys
    • Secure communication with Elasticsearch
    • Secure communication with Logstash
    • Use Linux Secure Computing Mode (seccomp)
  • Troubleshoot
    • Get help
    • Debug
    • Understand logged metrics
    • Common problems
      • Heartbeat uses too much bandwidth
      • Error loading config file
      • Found unexpected or unknown characters
      • Logstash connection doesn’t work
      • Publishing to Logstash fails with "connection reset by peer" message
      • @metadata is missing in Logstash
      • Not sure whether to use Logstash or Beats
      • SSL client fails to connect to Logstash
      • Monitoring UI shows fewer Beats than expected
      • High RSS memory usage due to MADV settings
  • Contribute to Beats