From 11ab50d9dc1045ae733a73eb3024a45bcd674222 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Wed, 29 Nov 2017 08:25:59 -0800 Subject: [PATCH] [DOCS] Clarified watcher cleaner service behaviour (elastic/x-pack-elasticsearch#3135) * [DOCS] Clarified watcher cleaner service behaviour * [DOCS] Fixed typo in watcher settings * [DOC] Clarified watcher and monitor setting dependencies Original commit: elastic/x-pack-elasticsearch@1386139460dbc9b6e830e1af70647274b75fbb94 --- docs/en/settings/monitoring-settings.asciidoc | 17 ++++++++++++----- docs/en/settings/notification-settings.asciidoc | 10 +++++++--- 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/docs/en/settings/monitoring-settings.asciidoc b/docs/en/settings/monitoring-settings.asciidoc index 7536e3ce64b..8b282d6f6bf 100644 --- a/docs/en/settings/monitoring-settings.asciidoc +++ b/docs/en/settings/monitoring-settings.asciidoc @@ -72,15 +72,22 @@ Settings API. `xpack.monitoring.history.duration`:: -Sets the retention duration beyond which the indices created by a Monitoring exporter will -be automatically deleted. Defaults to `7d` (7 days). -+ -This setting has a minimum value of `1d` (1 day) to ensure that something is being monitored, -and it cannot be disabled. +Sets the retention duration beyond which the indices created by a Monitoring +exporter are automatically deleted. Defaults to `7d` (7 days). + +-- +This setting has a minimum value of `1d` (1 day) to ensure that something is +being monitored, and it cannot be disabled. + IMPORTANT: This setting currently only impacts `local`-type exporters. Indices created using the `http` exporter will not be deleted automatically. +If both {monitoring} and {watcher} are enabled, you can use this setting to +affect the {watcher} cleaner service too. For more information, see the +`xpack.watcher.history.cleaner_service.enabled` setting in the +<>. +-- + `xpack.monitoring.exporters`:: Configures where the agent stores monitoring data. By default, the agent uses a diff --git a/docs/en/settings/notification-settings.asciidoc b/docs/en/settings/notification-settings.asciidoc index 2784aa88b80..b17554c05ce 100644 --- a/docs/en/settings/notification-settings.asciidoc +++ b/docs/en/settings/notification-settings.asciidoc @@ -35,9 +35,13 @@ required. For more information, see {xpack-ref}/encrypting-data.html[Encrypting sensitive data in {watcher}]. `xpack.watcher.history.cleaner_service.enabled`:: -Set to `false` (default) to disable the cleaner service, which removes previous -versions of {watcher} indices (for example, .watcher-history*) when it -determines that they are old. +Set to `false` (default) to disable the cleaner service. If this setting is +`true`, the `xpack.monitoring.enabled` setting must also be set to `true`. The +cleaner service removes previous versions of {watcher} indices (for example, +`.watcher-history*`) when it determines that they are old. The duration of +{watcher} indices is determined by the `xpack.monitoring.history.duration` +setting, which defaults to 7 days. For more information about that setting, +see <>. `xpack.http.proxy.host`:: Specifies the address of the proxy server to use to connect to HTTP services.