Skip to content

Commit

Permalink
Fix heartbeat docs for config reloading (#8840)
Browse files Browse the repository at this point in the history
This commit fixes a nasty bug in the docs for config reloading where the `reload.enabled` option wasn't documented. Without this config reloading does not work.

This commit also adds these config options to the heartbeat.reference.yml file, which was an oversight in the original PR.

(cherry picked from commit 95df3e7)
  • Loading branch information
andrewvc committed Oct 31, 2018
1 parent bda6707 commit 7861e60
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
10 changes: 10 additions & 0 deletions heartbeat/_meta/beat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,16 @@ heartbeat.monitors:
# Interval between file file changed checks.
#interval: 5s

# Define a directory to load monitor definitions from. Definitions take the form
# of individual yaml files.
# heartbeat.config.monitors:
# Directory + glob pattern to search for configuration files
#path: /path/to/my/monitors.d/*.yml
# If enabled, heartbeat will periodically check the config.monitors path for changes
#reload.enabled: true
# How often to check for changes
#reload.period: 1s

- type: tcp # monitor type `tcp`. Connect via TCP and optionally verify endpoint
# by sending/receiving a custom payload

Expand Down
2 changes: 2 additions & 0 deletions heartbeat/docs/heartbeat-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ happening to you. To do so you would instead have your +heartbeat.yml+ file cont
heartbeat.config.monitors:
# Directory + glob pattern to search for configuration files
path: /path/to/my/monitors.d/*.yml
# If enabled, heartbeat will periodically check the config.monitors path for changes
reload.enabled: true
# How often to check for changes
reload.period: 1s
----------------------------------------------------------------------
Expand Down
10 changes: 10 additions & 0 deletions heartbeat/heartbeat.reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,16 @@ heartbeat.monitors:
# Interval between file file changed checks.
#interval: 5s

# Define a directory to load monitor definitions from. Definitions take the form
# of individual yaml files.
# heartbeat.config.monitors:
# Directory + glob pattern to search for configuration files
#path: /path/to/my/monitors.d/*.yml
# If enabled, heartbeat will periodically check the config.monitors path for changes
#reload.enabled: true
# How often to check for changes
#reload.period: 1s

- type: tcp # monitor type `tcp`. Connect via TCP and optionally verify endpoint
# by sending/receiving a custom payload

Expand Down

0 comments on commit 7861e60

Please sign in to comment.