From 95df3e73836d3929a5c2101399c052cdecf7dcf7 Mon Sep 17 00:00:00 2001 From: Andrew Cholakian Date: Tue, 30 Oct 2018 14:53:43 -0500 Subject: [PATCH] Fix heartbeat docs for config reloading 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. --- heartbeat/_meta/beat.reference.yml | 10 ++++++++++ heartbeat/docs/heartbeat-options.asciidoc | 2 ++ heartbeat/heartbeat.reference.yml | 10 ++++++++++ 3 files changed, 22 insertions(+) diff --git a/heartbeat/_meta/beat.reference.yml b/heartbeat/_meta/beat.reference.yml index 80a1027601f..8742837bf40 100644 --- a/heartbeat/_meta/beat.reference.yml +++ b/heartbeat/_meta/beat.reference.yml @@ -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 diff --git a/heartbeat/docs/heartbeat-options.asciidoc b/heartbeat/docs/heartbeat-options.asciidoc index 6587cf1308a..a7f6026d800 100644 --- a/heartbeat/docs/heartbeat-options.asciidoc +++ b/heartbeat/docs/heartbeat-options.asciidoc @@ -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 ---------------------------------------------------------------------- diff --git a/heartbeat/heartbeat.reference.yml b/heartbeat/heartbeat.reference.yml index e0b81fbb592..fb0b3ff9c91 100644 --- a/heartbeat/heartbeat.reference.yml +++ b/heartbeat/heartbeat.reference.yml @@ -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