- Heartbeat Reference: other versions:
- Overview
- Getting Started With Heartbeat
- Setting up and running Heartbeat
- Configuring Heartbeat
- Set up monitors
- Specify general settings
- Configure the internal queue
- Configure the output
- Configure index lifecycle management
- Specify SSL settings
- Filter and Enhance the exported data
- Define processors
- Add cloud metadata
- Add fields
- Add labels
- Add the local time zone
- Add tags
- Decode JSON fields
- Drop events
- Drop fields from events
- Keep fields from events
- Rename fields from events
- Add Kubernetes metadata
- Add Docker metadata
- Add Host metadata
- Dissect strings
- DNS Reverse Lookup
- Add process metadata
- Parse data by using ingest node
- Enrich events with geoIP information
- Configure project paths
- Configure the Kibana endpoint
- Load the Elasticsearch index template
- Configure logging
- Use environment variables in the configuration
- Autodiscover
- YAML tips and gotchas
- Regular expression support
- HTTP Endpoint
- heartbeat.reference.yml
- Exported fields
- Monitoring Heartbeat
- Securing Heartbeat
- Troubleshooting
- Contributing to Beats
Directory layout
editDirectory layout
editThe directory layout of an installation is as follows:
| Type | Description | Default Location | Config Option |
|---|---|---|---|
home |
Home of the Heartbeat installation. |
|
|
bin |
The location for the binary files. |
|
|
config |
The location for configuration files. |
|
|
data |
The location for persistent data files. |
|
|
logs |
The location for the logs created by Heartbeat. |
|
|
You can change these settings by using CLI flags or setting path options in the configuration file.
Default paths
editHeartbeat uses the following default paths unless you explicitly change them.
deb and rpm
edit| Type | Description | Location |
|---|---|---|
home |
Home of the Heartbeat installation. |
|
bin |
The location for the binary files. |
|
config |
The location for configuration files. |
|
data |
The location for persistent data files. |
|
logs |
The location for the logs created by Heartbeat. |
|
For the deb and rpm distributions, these paths are set in the init script or in
the systemd unit file. Make sure that you start the Heartbeat service by using
the preferred operating system method (init scripts or systemctl).
Otherwise the paths might be set incorrectly.
docker
edit| Type | Description | Location |
|---|---|---|
home |
Home of the Heartbeat installation. |
|
bin |
The location for the binary files. |
|
config |
The location for configuration files. |
|
data |
The location for persistent data files. |
|
logs |
The location for the logs created by Heartbeat. |
|
zip, tar.gz, or tgz
edit| Type | Description | Location |
|---|---|---|
home |
Home of the Heartbeat installation. |
|
bin |
The location for the binary files. |
|
config |
The location for configuration files. |
|
data |
The location for persistent data files. |
|
logs |
The location for the logs created by Heartbeat. |
|
For the zip, tar.gz, or tgz distributions, these paths are based on the location of the extracted binary file. This means that if you start Heartbeat with the following simple command, all paths are set correctly:
./heartbeat
brew
edit| Type | Description | Location |
|---|---|---|
home |
Home of the Heartbeat installation. |
|
bin |
The location for the binary files. |
|
config |
The location for configuration files. |
|
data |
The location for persistent data files. |
|
logs |
The location for the logs created by Heartbeat. |
|