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

WI-15: Add health check for site status #919

Merged
merged 5 commits into from
Dec 12, 2023
Merged

Conversation

chandra-tacc
Copy link
Collaborator

Overview

To have a monitoring website, a non-authenticated endpoint is needed. This health-check endpoint provides a mechanism to share status.

Related

Changes

/core/health-check endpoint will provide ping status to validate nginx, uwsgi, django worker is up or not.
A 200 status shows the portal is up. Anything else shows the portal is down.

In future this can be expanded to provide additional status (DB, ES, etc).

Testing

  1. curl https://cep.test/core/health-check
    {"status": "healthy"}
  2. Unit test to ensure this endpoint is not removed accidently.

UI

N/A

Notes

/core/health-check endpoint will provide ping status to validate nginx, uwsgi, django worker is up or not.
Copy link

codecov bot commented Dec 12, 2023

Codecov Report

Merging #919 (8b23dce) into main (700c52f) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #919      +/-   ##
==========================================
+ Coverage   63.47%   63.49%   +0.01%     
==========================================
  Files         431      431              
  Lines       12426    12430       +4     
  Branches     2595     2595              
==========================================
+ Hits         7888     7892       +4     
  Misses       4322     4322              
  Partials      216      216              
Flag Coverage Δ
javascript 69.74% <ø> (ø)
unittests 57.11% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
server/portal/urls.py 100.00% <100.00%> (ø)
server/portal/views/views.py 36.84% <100.00%> (+11.84%) ⬆️

@chandra-tacc chandra-tacc marked this pull request as ready for review December 12, 2023 19:35
Copy link
Collaborator

@taoteg taoteg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Exciting!

Copy link
Member

@rstijerina rstijerina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@chandra-tacc chandra-tacc merged commit 272c632 into main Dec 12, 2023
6 checks passed
@chandra-tacc chandra-tacc deleted the task/WI-15-site-status branch December 12, 2023 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants