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

Operational Plugin: Health check #40

Closed
gcotelli opened this issue Jul 29, 2019 · 2 comments
Closed

Operational Plugin: Health check #40

gcotelli opened this issue Jul 29, 2019 · 2 comments

Comments

@gcotelli
Copy link
Member

gcotelli commented Jul 29, 2019

One of the operational plugins (#41) .

  • Endpoint /operations/health-check
  • Must be possible to configure this plugin with additional checks to be run.
  • In case there are multiple checks the general status will be the worst status of the check runs and every check status can be accessed asking for the details media type and looking at the details object.
  • A POST operation with the summary media type can be requested without Authorization, the rest requires an authenticated request with the proper authorization credentials.

Supported operations:

  • Run a health check and report the status: POST - application/vnd.stargate.health-check.summary+json
  • Run a health check and report a detailed status: POST - application/vnd.stargate.health-check.details+json

Supported statuses

Status Keyword HTTP Status Code Description
PASS 200 OK The service is fully operational
WARN 200 OK The service is responding but with degraded performance
FAIL 503 Service Unavailable The service endpoints are not responding reliably
@gcotelli gcotelli mentioned this issue Jul 29, 2019
10 tasks
@serpi90 serpi90 removed their assignment Jul 29, 2019
@ba-st ba-st deleted a comment from serpi90 Jul 30, 2019
@gcotelli gcotelli changed the title Health check Operational Plugin: Health check Jul 30, 2019
@gcotelli
Copy link
Member Author

@gcotelli
Copy link
Member Author

gcotelli commented Nov 6, 2019

Fixed in #60

@gcotelli gcotelli closed this as completed Nov 6, 2019
@gcotelli gcotelli added this to the v4.0.0 milestone Nov 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants