MagnetoDB/specs/monitoring-health-check
Contents
- 1 Monitoring - healthcheck http request
- 1.1 Specification status
- 1.2 Problem Description
- 1.3 Proposed Change
- 1.3.1 Request Syntax
- 1.3.2 Headers
- 1.3.3 Request Body
- 1.3.4 Return Code
- 1.3.5 Return Body
- 1.3.6 Alternatives
- 1.3.7 Security Impact
- 1.3.8 Notifications Impact
- 1.3.9 Other End User Impact
- 1.3.10 Performance Impact
- 1.3.11 Other Deployer Impact
- 1.3.12 Developer Impact
- 1.3.13 Implementation
- 1.3.14 Documentation Impact
- 1.3.15 References
Monitoring - healthcheck http request
Launchpad: [1]
Request for check MagnetoDB health status.
Specification status
Needs approval
Problem Description
Service administrators should have an ability for lightweigt checking of MagnetoDB health status.
Proposed Change
It should be http request without credentials, that will allow to understand that: 1. magnetodb-api service is running 2. Keystone is available to magnetodb-api 3. Backend is available to magnetodb-api and working properly
Request Syntax
POST v1/health_status
Headers
- User-Agent
- Content-Type: application/json
- Accept: application/json
Request Body
{}
Return Code
200
Return Body
{
"status": {"OK", "Error"}
"details": <"Keystone {OK, Error}, Cassandra {OK, Error}">
}
Alternatives
none
Security Impact
We consider that this request will not need any credentials and an ability to send it to MagnetoDB should be under external control
Notifications Impact
none
Other End User Impact
none
Performance Impact
none
Other Deployer Impact
none
Developer Impact
none
Implementation
none
Assignee(s)
Primary assignee:
aostapenko
Other contributors:
none
Work Items
none
Dependencies
none
Documentation Impact
Feature needs to be described in doc sources
References
none
