honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[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@1386139460
This commit is contained in:
Lisa Cawley 2017-11-29 08:25:59 -08:00 committed by GitHub
parent bf27cd1457
commit 11ab50d9dc
2 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/en/settings/monitoring-settings.asciidoc
View File

@ -72,15 +72,22 @@ Settings API.
`xpack.monitoring.history.duration`:: `xpack.monitoring.history.duration`::
Sets the retention duration beyond which the indices created by a Monitoring exporter will Sets the retention duration beyond which the indices created by a Monitoring
be automatically deleted. Defaults to `7d` (7 days). 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.
+ +
--
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 IMPORTANT: This setting currently only impacts `local`-type exporters. Indices created using
the `http` exporter will not be deleted automatically. 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
<<notification-settings>>.
--
`xpack.monitoring.exporters`:: `xpack.monitoring.exporters`::
Configures where the agent stores monitoring data. By default, the agent uses a Configures where the agent stores monitoring data. By default, the agent uses a

10
docs/en/settings/notification-settings.asciidoc
View File

@ -35,9 +35,13 @@ required. For more information, see
{xpack-ref}/encrypting-data.html[Encrypting sensitive data in {watcher}]. {xpack-ref}/encrypting-data.html[Encrypting sensitive data in {watcher}].
`xpack.watcher.history.cleaner_service.enabled`:: `xpack.watcher.history.cleaner_service.enabled`::
Set to `false` (default) to disable the cleaner service, which removes previous Set to `false` (default) to disable the cleaner service. If this setting is
versions of {watcher} indices (for example, .watcher-history*) when it `true`, the `xpack.monitoring.enabled` setting must also be set to `true`. The
determines that they are old. 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 <<monitoring-settings>>.
`xpack.http.proxy.host`:: `xpack.http.proxy.host`::
Specifies the address of the proxy server to use to connect to HTTP services. Specifies the address of the proxy server to use to connect to HTTP services.