- Heartbeat Reference: other versions:
- Heartbeat overview
- Quick start: installation and configuration
- Set up and run
- Configure
- Monitors
- Task scheduler
- General settings
- Project paths
- Output
- 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
- community_id
- convert
- copy_fields
- decode_base64_field
- 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
- rate_limit
- registered_domain
- rename
- script
- translate_sid
- truncate_fields
- urldecode
- Autodiscover
- Internal queue
- Logging
- HTTP endpoint
- Regular expression support
- Instrumentation
- heartbeat.reference.yml
- How to guides
- Exported fields
- Beat 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
- SOCKS5 proxy fields
- Monitor summary fields
- Synthetics types fields
- TCP layer fields
- TLS encryption layer fields
- Monitor
- Secure
- Troubleshoot
- Get help
- Debug
- 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
- Contribute to Beats
Configure APM instrumentation
editConfigure APM instrumentation
editLibbeat uses the Elastic APM Go Agent to instrument its publishing pipeline. Currently, only the Elasticsearch output is instrumented. To gain insight into the performance of Heartbeat, you can enable this instrumentation and send trace data to the APM Integration.
Example configuration with instrumentation enabled:
instrumentation: enabled: true environment: production hosts: - "http://localhost:8200" api_key: L5ER6FEvjkmlfalBealQ3f3fLqf03fazfOV
Configuration options
editYou can specify the following options in the instrumentation
section of the heartbeat.yml
config file:
enabled
editSet to true
to enable instrumentation of Heartbeat.
Defaults to false
.
environment
editSet the environment in which Heartbeat is running, for example, staging
, production
, dev
, etc.
Environments can be filtered in the APM app.
hosts
editThe APM integration host to report instrumentation data to.
Defaults to http://localhost:8200
.
api_key
editThe API Key used to secure communication with the APM Integration.
If api_key
is set then secret_token
will be ignored.
secret_token
editThe Secret token used to secure communication with the APM Integration.
profiling.cpu.enabled
editSet to true
to enable CPU profiling, where profile samples are recorded as events.
This feature is experimental.
profiling.cpu.interval
editConfigure the CPU profiling interval. Defaults to 60s
.
This feature is experimental.
profiling.cpu.duration
editConfigure the CPU profiling duration. Defaults to 10s
.
This feature is experimental.
profiling.heap.enabled
editSet to true
to enable heap profiling.
This feature is experimental.
profiling.heap.interval
editConfigure the heap profiling interval. Defaults to 60s
.
This feature is experimental.
On this page