Difference between revisions of "MagnetoDB/specs/monitoring-health-check"
(→Request Syntax) |
Ikhudoshyn (talk | contribs) m (→Specification status) |
||
| (20 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
=== Specification status === | === Specification status === | ||
| − | + | Approved '''isviridov''' | |
| + | Approved "ikhudoshyn" | ||
=== Problem Description === | === Problem Description === | ||
Service administrators should have an ability for lightweigt checking of MagnetoDB health status. | Service administrators should have an ability for lightweigt checking of MagnetoDB health status. | ||
| + | it is also needed for loadbalancers in order to decide if instance can process requests | ||
=== Proposed Change === | === Proposed Change === | ||
It should be http request without credentials, that will allow to understand that: | It should be http request without credentials, that will allow to understand that: | ||
| − | + | # magnetodb-api service is running | |
| − | + | # Keystone is available to magnetodb-api | |
| − | + | # Backend is available to magnetodb-api and working properly | |
| + | |||
| + | ===== Use Cases ===== | ||
| + | # Fast and easy healthcheck for loadbalancer | ||
| + | # Full manual healthcheck just with simple GET request | ||
| + | |||
| + | ===== Usage scenarios ===== | ||
| + | # Checking magnetodb-api server availability without subsystems | ||
| + | # Checking magnetodb-api server availability and checking its connectivity to Keystone and Cassandra | ||
| + | |||
===== Request Syntax ===== | ===== Request Syntax ===== | ||
| − | GET healthcheck/ | + | GET /healthcheck |
| + | GET /healthcheck?fullcheck=true | ||
===== Headers ===== | ===== Headers ===== | ||
| − | * User-Agent | + | * User-Agent |
| − | + | * Accept: text/plain | |
| − | * Accept: | ||
===== Response Code ===== | ===== Response Code ===== | ||
| − | 200 | + | 200 or 503 |
===== Response Body ===== | ===== Response Body ===== | ||
| − | + | "OK|Cassanra: ERROR|Keystone: ERROR|Keystone: ERROR, Cassandra: ERROR" | |
| − | " | ||
| − | |||
| − | |||
===== Intristic implementation ===== | ===== Intristic implementation ===== | ||
| Line 48: | Line 56: | ||
Cassandra availability will be checked with quering "magnetodb.table_info" table: | Cassandra availability will be checked with quering "magnetodb.table_info" table: | ||
| − | SELECT * FROM magnetodb.table_info; | + | SELECT * FROM magnetodb.table_info LIMIT 1; |
Method | Method | ||
| Line 79: | Line 87: | ||
==== Implementation ==== | ==== Implementation ==== | ||
| − | + | Same health check request needs to be implemented for magnetodb-streaming-api | |
===== Assignee(s) ===== | ===== Assignee(s) ===== | ||
Latest revision as of 13:08, 9 October 2014
Contents
- 1 Monitoring - healthcheck http request
- 1.1 Specification status
- 1.2 Problem Description
- 1.3 Proposed Change
- 1.3.1 Use Cases
- 1.3.2 Usage scenarios
- 1.3.3 Request Syntax
- 1.3.4 Headers
- 1.3.5 Response Code
- 1.3.6 Response Body
- 1.3.7 Intristic implementation
- 1.3.8 Alternatives
- 1.3.9 Security Impact
- 1.3.10 Notifications Impact
- 1.3.11 Other End User Impact
- 1.3.12 Performance Impact
- 1.3.13 Other Deployer Impact
- 1.3.14 Developer Impact
- 1.3.15 Implementation
- 1.3.16 Documentation Impact
- 1.3.17 References
Monitoring - healthcheck http request
Launchpad: [1]
Request for check MagnetoDB health status.
Specification status
Approved isviridov Approved "ikhudoshyn"
Problem Description
Service administrators should have an ability for lightweigt checking of MagnetoDB health status. it is also needed for loadbalancers in order to decide if instance can process requests
Proposed Change
It should be http request without credentials, that will allow to understand that:
- magnetodb-api service is running
- Keystone is available to magnetodb-api
- Backend is available to magnetodb-api and working properly
Use Cases
- Fast and easy healthcheck for loadbalancer
- Full manual healthcheck just with simple GET request
Usage scenarios
- Checking magnetodb-api server availability without subsystems
- Checking magnetodb-api server availability and checking its connectivity to Keystone and Cassandra
Request Syntax
GET /healthcheck GET /healthcheck?fullcheck=true
Headers
* User-Agent * Accept: text/plain
Response Code
200 or 503
Response Body
"OK|Cassanra: ERROR|Keystone: ERROR|Keystone: ERROR, Cassandra: ERROR"
Intristic implementation
Keystone availability will be checked by sending request:
GET /
This request should return available versions of Keystone API with 200 code.
Cassandra availability will be checked with quering "magnetodb.table_info" table:
SELECT * FROM magnetodb.table_info LIMIT 1;
Method
bool health_check()
will be added to storage API.
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
Same health check request needs to be implemented for magnetodb-streaming-api
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
