Significant changes and corrections to the SE health doc #8125
Conversation
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
oracle-contributor-agreement
bot
added
the
OCA Verified
This was referenced Dec 11, 2023
spericas
reviewed
Dec 12, 2023
spericas
reviewed
Dec 12, 2023
spericas
reviewed
Dec 12, 2023
|
|
||
| ==== Adding configuration to a custom observer | ||
| In addition to preparing the health observer builder with hard-coded settings, your code can also apply configuration for health so your user could set any health behavior there as well. | ||
|
|
There was a problem hiding this comment.
Was confused by "your user" here. Maybe rephrase this? Maybe "your code can also apply configuration by directly referring to a config node" or something like that.
There was a problem hiding this comment.
I've rephrased this in a way that, I hope, is clearer.
spericas
reviewed
Dec 12, 2023
spericas
reviewed
Dec 12, 2023
|
|
||
| Order is important. Here, the code first sets `details` to `true` explicitly and later applies configuration. If your end user sets `details` in the `server.features.observe.observers.health` config to `false`, that setting overrides the hard-coded `true` setting in the code _because of where in the code you apply the configuration_. Try changing the `details` value to `false` in the config file and then stop, rebuild, and rerun the application. Access the health endpoint and notice that the output is no longer detailed. | ||
|
|
||
| In general, most applications should apply settings from config _after_ assigning any settings in the code so users have the final say, but there might be exceptions in your particular case. |
There was a problem hiding this comment.
I see the "users" again. I'd would use "external config" or simply "config" instead, but I understand the notion better now.
spericas
reviewed
Dec 12, 2023
spericas
reviewed
Dec 12, 2023
spericas
approved these changes
Dec 12, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Resolves #7945
The health doc was significantly out of step with the late coding changes for 4.0.0. This PR addresses a number of problems, including what config key prefix is correct and the code examples to create a custom observe feature and a custom health observer in which to add custom health checks.
Documentation
This is a doc PR.