Skip to content

Commit 749cb2e

Browse files
committed
Add docs for filesystem health checks
Documents the feature and settings introduced in elastic#52680.
1 parent f6cc374 commit 749cb2e

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

docs/reference/modules/discovery/discovery-settings.asciidoc

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,3 +227,22 @@ APIs are not be blocked and can run on any available node.
227227
===============================
228228

229229
--
230+
231+
`monitor.fs.health.enabled`::
232+
233+
(<<cluster-update-settings,Dynamic>>, boolean) Sets whether the node runs
234+
periodic <<cluster-fault-detection-filesystem-health,filesystem health
235+
checks>>. Defaults to `true`.
236+
237+
`monitor.fs.health.refresh_interval`::
238+
239+
(<<time-units, Time unit value>>) Sets the interval between successive
240+
<<cluster-fault-detection-filesystem-health,filesystem health checks>>.
241+
Defaults to `2m`.
242+
243+
`monitor.fs.health.slow_path_logging_threshold`::
244+
245+
(<<time-units, Time unit value>>) If a
246+
<<cluster-fault-detection-filesystem-health,filesystem health checks>>
247+
takes longer than this threshold then {es} logs a warning. Defaults to
248+
`5s`.

docs/reference/modules/discovery/fault-detection.asciidoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,10 @@ Similarly, if a node detects that the elected master has disconnected, this
1818
situation is treated as an immediate failure. The node bypasses the timeout and
1919
retry settings and restarts its discovery phase to try and find or elect a new
2020
master.
21+
22+
[[cluster-fault-detection-filesystem-health]]
23+
Additionally, each node periodically verifies that its data path is healthy by
24+
writing a small file to disk and then deleting it again. If a node discovers
25+
its data path is unhealthy then it is removed from the cluster until the data
26+
path recovers. You can control this behavior with the
27+
<<modules-discovery-settings,`monitor.fs.health` settings>>.

0 commit comments

Comments
 (0)