Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documenting master_is_stable health API settings #87901

Merged
merged 9 commits into from
Jul 26, 2022
Merged

Documenting master_is_stable health API settings #87901

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6b5bc3e
Documenting master_is_stable health API settings
masseyke Jun 21, 2022
bec9061
code review feedback
masseyke Jun 23, 2022
1eeae85
removing accidental change
masseyke Jun 23, 2022
fc31aa1
Merge branch 'master' into doc/health-api-settings
masseyke Jun 23, 2022
3661615
renaming health-api-settings.asciidoc
masseyke Jul 22, 2022
e29d794
renaming health-api-settings.asciidoc
masseyke Jul 22, 2022
054615b
code review feedback
masseyke Jul 22, 2022
46bf0d8
Apply suggestions from code review
masseyke Jul 26, 2022
436ffe1
Update docs/reference/settings/health-diagnostic-settings.asciidoc
masseyke Jul 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 12 additions & 14 deletions ...nce/settings/health-api-settings.asciidoc → ...tings/health-diagnostic-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[[health-api-settings]]
=== Health API settings in {es}
[[health-diagnostic-settings]]
=== Health diagnostic settings in {es}
[subs="attributes"]
++++
<titleabbrev>Health API settings</titleabbrev>
<titleabbrev>Health Diagnostic settings</titleabbrev>
++++

The following are the _expert-level_ settings available for configuring the
<<health-api, Health API>>. It is not recommended to change any of these
from their default values.
The following are the _expert-level_ settings available for configuring an internal diagnostics service.
The output of this service is currently exposed through the Health API <<health-api, Health API>>. It
is not recommended to change any of these from their default values.

==== Cluster level settings

Expand All @@ -17,15 +17,13 @@ a master at all, before moving on with other checks. Defaults to `30s` (30 secon

`master_history.max_age`::
(<<static-cluster-setting,Static>>) The maximum amount of time that the master history is kept in memory
for use in the Health API. Master node changes older than this time will not be considered in the Health
API calculation. Defaults to `30m` (30 minutes).
for use in the health diagnostic. Master node changes older than this time will not be considered in the
health diagnostic calculations. Defaults to `30m` (30 minutes).

`health.master_history.identity_changes_threshold`::
(<<static-cluster-setting,Static>>) The number of times that it is not OK to have a master change identity
to another node. This many changes or more will be reported as a problem in the Health API. Defaults to `4`.
(<<static-cluster-setting,Static>>) The number of times that it is _not_ OK to have a master change identity
to another node. This many changes or more will be reported as a unhealthy. Defaults to `4`.

`health.master_history.no_master_transitions_threshold`::
(<<static-cluster-setting,Static>>) The number of times that it is not OK to have a master switch to no
master. This many transitions or more will be reported as a problem in the Health API. Defaults to `4`.


(<<static-cluster-setting,Static>>) The number of times that it is _not_ OK to have a master switch to no
master. This many transitions or more will be reported as unhealthy. Defaults to `4`.
2 changes: 1 addition & 1 deletion docs/reference/setup.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ include::modules/discovery/discovery-settings.asciidoc[]

include::modules/indices/fielddata.asciidoc[]

include::settings/health-api-settings.asciidoc[]
include::settings/health-diagnostic-settings.asciidoc[]

include::settings/ilm-settings.asciidoc[]

Expand Down