This repository has been archived by the owner on Nov 14, 2023. It is now read-only.
API health check #311
Open
API health check #311
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
d-rita
force-pushed
the
feature/health-check
branch
2 times, most recently
from
0ed8991 to
13d7d60
Compare
- Add API monitoring config variables; API URL and access token - Monitor authentication, raw data and mapathon endpoints - Add system health validation models
d-rita
force-pushed
the
feature/health-check
branch
from
13d7d60 to
e69ce11
Compare
| get_req = requests.get(endpoint) | ||
| return get_req.status_code | ||
| if request_type == 'POST': | ||
| post_req = requests.post(endpoint, json=body, headers={'access-token':ACCESS_TOKEN}) |
There was a problem hiding this comment.
Just a question , I can see from the website that access_token is not going to expire but have you tried it ? Do they remain same all the time ? Since you are reading it from config , I am just concerned if they will expire or not . Generally access token do expire
| @@ -83,6 +83,9 @@ | |||
| "value not supported for file_upload_method ,switching to default disk method") | |||
| use_s3_to_upload = False | |||
|
|
|||
| MAIN_API_URL = config.get("API_MONITORING", "MAIN_API_URL", fallback="http://127.0.0.1:8000/v1/") | |||
| ACCESS_TOKEN = config.get("API_MONITORING", "ACCESS_TOKEN", fallback=None) | |||
There was a problem hiding this comment.
May be checking and raising the error if access_token is not supplied would be fruitful since the monitoring depends on it , API should be able to run without those configuration , you can check if it is supplied or not when endpoint is called !
| @@ -0,0 +1,36 @@ | |||
| raw_data_testing_query = { | |||
There was a problem hiding this comment.
I think moving these to /src/tests/fixtures will be fruitful
| @@ -49,6 +49,10 @@ env=dev | |||
| #env=dev # default is prod , supported values are dev and prod | |||
| #shp_limit=6000 # in mb default is 4096 | |||
|
|
|||
| #[API_MONITORING] | |||
| #MAIN_API_URL=http://127.0.0.1:8000/v1/ | |||
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.
What does this PR do?
This PR adds an endpoint
/health/to check if the following endpoints are working as expected, i.e. authentication, mapathon summary, mapathon detail, and raw data.How to test:
git fetch origin && git checkout feature/health-checkto pull the branch.config.txt, under the [API_MONITORING] header, add these:MAIN_API_URL=http://127.0.0.1:8000/v1ACCESS_TOKEN=''NB: The access token is generated using valid credentials of an OSM account. Follow these steps on how to generate a valid token to test authenticated routes in Galaxy.
uvicorn API.main:app --reloadIssues: