Add MicroProfile Health guide #1483
Merged
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
gsmet
requested changes
Mar 15, 2019
| include::./attributes.adoc[] | ||
| = {project-name} - MicroProfile Health | ||
|
|
||
| This guide demonstrates how can your {project-name} application utilize MicroProfile |
There was a problem hiding this comment.
Suggested change
| This guide demonstrates how can your {project-name} application utilize MicroProfile | |
| This guide demonstrates how your {project-name} application can utilize the MicroProfile |
|
|
||
| == Architecture | ||
|
|
||
| In this guide, we build a simple REST application that exposes MP Health functionality at |
There was a problem hiding this comment.
Let's use MicroProfile in full in the guide.
Suggested change
| In this guide, we build a simple REST application that exposes MP Health functionality at | |
| In this guide, we build a simple REST application that exposes MicroProfile Health functionalities at |
| == Architecture | ||
|
|
||
| In this guide, we build a simple REST application that exposes MP Health functionality at | ||
| `/health` endpoint according to the specification. It will also provide several other REST |
There was a problem hiding this comment.
Suggested change
| `/health` endpoint according to the specification. It will also provide several other REST | |
| the `/health` endpoint according to the specification. It will also provide several other REST |
|
|
||
| == Running the health check | ||
|
|
||
| Importing `smallrye-health` extension directly exposes a single REST endpoint at |
There was a problem hiding this comment.
Suggested change
| Importing `smallrye-health` extension directly exposes a single REST endpoint at | |
| Importing the `smallrye-health` extension directly exposes a single REST endpoint at |
| == Running the health check | ||
|
|
||
| Importing `smallrye-health` extension directly exposes a single REST endpoint at | ||
| `/health` of your application that can be used to run the health check procedures: |
There was a problem hiding this comment.
Suggested change
| `/health` of your application that can be used to run the health check procedures: | |
| `/health` that can be used to run the health check procedures: |
| == Negative health check procedure | ||
|
|
||
| In this section we create another health check procedure which simulates connection to | ||
| external service provider like database. For the simplicity reasons, we only determine |
There was a problem hiding this comment.
Suggested change
| external service provider like database. For the simplicity reasons, we only determine | |
| an external service provider such as a database. For simplicity reasons, we only determine |
| see in the `checks` array the newly added `Database connection health check` which is | ||
| down and the error message explaining why it failed. | ||
|
|
||
| As we shouldn't leave this application with health check in DOWN state and because we |
There was a problem hiding this comment.
Suggested change
| As we shouldn't leave this application with health check in DOWN state and because we | |
| As we shouldn't leave this application with a health check in DOWN state and because we |
|
|
||
| As we shouldn't leave this application with health check in DOWN state and because we | ||
| are running {project-name} dev mode you can add `database.up=true` in | ||
| `META-INF/microprofile-config.properties` and rerun the health check again -- |
There was a problem hiding this comment.
Suggested change
| `META-INF/microprofile-config.properties` and rerun the health check again -- | |
| `src/main/resources/application.properties` and rerun the health check again -- |
This might need a change to the quickstart itself if you included the configuration file.
|
|
||
| == Conclusion | ||
|
|
||
| MicroProfile Health provides a way how can your application distribute information |
There was a problem hiding this comment.
Suggested change
| MicroProfile Health provides a way how can your application distribute information | |
| MicroProfile Health provides a way for your application to distribute information |
| == Conclusion | ||
|
|
||
| MicroProfile Health provides a way how can your application distribute information | ||
| about its healthness state to typically state whether or not it is able to function properly. |
There was a problem hiding this comment.
I would remove typically to simplify:
Suggested change
| about its healthness state to typically state whether or not it is able to function properly. | |
| about its healthness state to state whether or not it is able to function properly. |
gsmet
approved these changes
Mar 15, 2019
|
Merged, thanks @xstefank! |
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.
quickstart: quarkusio/quarkus-quickstarts#97