This repository was archived by the owner on Jan 7, 2019. It is now read-only.
Write HealthCheck route #154
Open
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
Generated by 🚫 dangerJS |
Almouro
reviewed
Oct 9, 2018
ops/health-check-route.s.md
Outdated
|
|
||
| # Why | ||
|
|
||
| In order to monitor correctly their environments, some Cloud services require a HealthCheck route which returns a status depending on how the API is running. |
There was a problem hiding this comment.
could apply to any backend service
ops/health-check-route.s.md
Outdated
|
|
||
| ## Checks | ||
|
|
||
| - [ ] Do a call to every DB used by the API |
ops/health-check-route.s.md
Outdated
|
|
||
| - [ ] Do a call to every DB used by the API | ||
| - [ ] Send a 2xx status code status in case of API running correctly and 5xx status code if not | ||
| - [ ] Do the less data usage DB calls |
ops/health-check-route.s.md
Outdated
| return res.status(200).send({ status: 200, message: "OK" }); | ||
| } | ||
|
|
||
| nextFetchingDate = Date.now() + TIME_CHECKING_INTERVAL; |
There was a problem hiding this comment.
maybe put nextFetchingDate before the catch
ops/health-check-route.s.md
Outdated
| - [ ] Do a call to every DB used by the API | ||
| - [ ] Send a 2xx status code status in case of API running correctly and 5xx status code if not | ||
| - [ ] Do the less data usage DB calls | ||
| - [ ] Include a timestamp in order not to reduce the number of successive calls |
ops/health-check-route.s.md
Outdated
| ```javascript | ||
| app.get("/health", async (req, res) => { | ||
| try { | ||
| await findAllDataCollectors(); // DataCollectors ~ 100 entries |
There was a problem hiding this comment.
you can be more generic, like RDS.getAll
ops/health-check-route.s.md
Outdated
| } | ||
|
|
||
| nextFetchingDate = Date.now() + TIME_CHECKING_INTERVAL; | ||
| await Promise.all([AppsDynamoRepo.getDynamoHealth(), getHealth()]); |
There was a problem hiding this comment.
mayeb more generic in your examples -> what is getHealth
Arlevoy
force-pushed
the
health-check-route
branch
from
467572a to
cd24cf7
Compare
Almouro
approved these changes
Oct 9, 2018
ops/health-check-route.s.md
Outdated
| ## Checks | ||
|
|
||
| - [ ] Make a call to every database used by the API | ||
| - [ ] Send a 2xx status code status in case of API running correctly and 5xx status code if not |
There was a problem hiding this comment.
Send a 2xx status code status if the API is running correctly, 5xx status code if not
ops/health-check-route.s.md
Outdated
|
|
||
| - [ ] Make a call to every database used by the API | ||
| - [ ] Send a 2xx status code status in case of API running correctly and 5xx status code if not | ||
| - [ ] Make the less data usage database calls: the health check route is likely to be called very often in short period of time |
There was a problem hiding this comment.
Make database calls retrieving as little data as possible
ops/health-check-route.s.md
Outdated
|
|
||
| ## Examples | ||
|
|
||
| In the examples below the API is concentrating calls to one database RDS and one DynamoDB |
There was a problem hiding this comment.
concentrating? Did you mean making?
ops/health-check-route.s.md
Outdated
|
|
||
| - There is a call to one of the database but not the other | ||
| - The call is using too much data | ||
| - There is a 503 if the DB is down |
ops/health-check-route.s.md
Outdated
| await knex.raw("select 1+1 as result"); | ||
| }; | ||
|
|
||
| DynamoDB.getDynamoHealth = (): Promise<Array<Object>> => { |
There was a problem hiding this comment.
maybe remove typing as it is not used anywhere else
Arlevoy
force-pushed
the
health-check-route
branch
from
e5e4e70 to
95ffe1f
Compare
|
Can you liaise with Louis to merge your standard into his? |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No description provided.