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.

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

Document properties to enable probe health indicators #22631

Closed

Conversation

ttddyy
Copy link
Contributor

@ttddyy ttddyy commented Jul 28, 2020

Document property names to enable probe(readiness/liveness) health indicators.

Document property names to enable probe(readiness/liveness)
health indicators.
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Jul 28, 2020
@bclozel bclozel added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Jul 28, 2020
@bclozel bclozel self-assigned this Jul 28, 2020
@bclozel bclozel added this to the 2.4.0-M2 milestone Jul 28, 2020
@wilkinsona
Copy link
Member

wilkinsona commented Jul 29, 2020

Related to this, the livenessstate and readinessstate indicators are listed twice – once in the table of auto-configured indicators and once in the table of indicators that are not enabled by default. I suspect they should only appear once.

I also wonder if we should list the full property (or just the ID with an accompanying explanation to determine the property) for every indicator so that the information to enable or disable any of the indicators is available in one place?

@bclozel
Copy link
Member

bclozel commented Jul 29, 2020

I'd be in favor of adding that information in this table directly - we can find that key in the full application properties appendix but this feels like an unnecessary burden for the reader to check that other documentation section.

@ttddyy
Copy link
Contributor Author

ttddyy commented Jul 29, 2020

I was working on readiness/liveness, so I was only looking them especially they are not enabled by default. But it is even better if all properties are documented on the table there.
It is easy for readers to have information there how to enable healthindicators (though other than readiness/liveness are enabled by default).
I don't think it is easy for readers to realize there is an appendices that have all properties listed for actuator unless there is an explicit link in the section.

@bclozel bclozel modified the milestones: 2.4.0-M2, 2.3.3 Aug 1, 2020
bclozel pushed a commit that referenced this pull request Aug 1, 2020
Document property names to enable probe(readiness/liveness)
health indicators.

See gh-22631
@bclozel bclozel closed this in 4aa010c Aug 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants