Documenting master_is_stable health API settings #87901
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,31 @@ | ||||||
| [[health-api-settings]] | ||||||
| === Health API settings in {es} | ||||||
| [subs="attributes"] | ||||||
| ++++ | ||||||
| <titleabbrev>Health API 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. | ||||||
|
|
||||||
| ==== Cluster level settings | ||||||
|
|
||||||
| `health.master_history.has_master_lookup_timeframe`:: | ||||||
| (<<static-cluster-setting,Static>>) The amount of time a node looks back to see if it has observed | ||||||
| a master at all, before moving on with other checks. Defaults to `30s` (30 seconds). | ||||||
|
|
||||||
| `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 | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. I think we should potentially decouple these settings from the health API (I see it's mentioned again) There was a problem hiding this comment. If we don't say how these impact the end user, then no one would ever change them, right? That might not be such a bad thing though. |
||||||
| API calculation. 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`. | ||||||
|
|
||||||
| `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`. | ||||||
|
|
||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say this configures an internal diagnostics service as opposed to the API.
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe I should change it to "for configuring an internal diagnostics service that is exposed through the Health API"? To the user changes to these settings will only be visible via the health api right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this idea. Essentially these are internal diagnostics, they are now used in the health API but they might have more use cases, right?
What about calling this page "Health diagnostic settings" or "Internal health diagnostic settings" and only refer to the health API in the begging. Something like: "the outcome of this service is exposed via the Health API"?
I think this could open up different ways of phrasing the impact of the settings. For example:
This many changes or more will be reported as a problem in the Health APIcould be phrased asThis many changes or more will be reported as unhealthy?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
++ I like it too and I like your suggestions @gmarouli !