Difference between revisions of "MagnetoDB/specs/monitoring-api"
(Created page with "== MagnetoDB monitoring api == TBD") |
|||
| Line 1: | Line 1: | ||
== MagnetoDB monitoring api == | == MagnetoDB monitoring api == | ||
| + | |||
| + | Launchpad: [https://blueprints.launchpad.net/magnetodb/+spec/monitoring-api monitoring-api] | ||
| + | |||
| + | The API for exposing usage statistic for users, external monitoring or billing tools. | ||
| + | |||
| + | === Problem Description === | ||
| + | |||
| + | As a magnetodb user I need to know how much data I have in table | ||
| + | As a magnetodb administrator I need to know now much space is used with user's table | ||
| + | As a accountant department I need to know how big user's table is in order to create a bill | ||
| + | |||
| + | === Proposed Change === | ||
| + | |||
| + | # Introduce monitoring API available on the same port as data API by path /moninoting/* | ||
| + | # implement REST method for list of tables /moninoting/{tenant_id}/tables | ||
| + | # table usage details /moninoting/{tenant_id}/table/{table_name} | ||
| + | Response: | ||
| + | {size: 1003432; item_count: 3000} | ||
| + | |||
| + | ==== Alternatives ==== | ||
| + | |||
| + | Implement as part of data API. However it gives access to data itself for monitoring tools. | ||
| + | |||
| + | ==== Security Impact ==== | ||
| + | |||
| + | * authorization is performed by user's token | ||
| + | * authorization can be performed by token with specific role | ||
| + | |||
| + | ==== Notifications Impact ==== | ||
| + | None | ||
| + | ==== Other End User Impact ==== | ||
TBD | TBD | ||
| + | ==== Performance Impact ==== | ||
| + | TBD | ||
| + | ==== Other Deployer Impact ==== | ||
| + | None | ||
| + | ==== Developer Impact ==== | ||
| + | None | ||
| + | ==== Implementation ==== | ||
| + | TBD (cql, JMX) | ||
| + | ===== Assignee(s) ===== | ||
| + | Primary assignee: | ||
| + | <ominakov> | ||
| + | |||
| + | Other contributors: | ||
| + | <None> | ||
| + | |||
| + | ===== Work Items ===== | ||
| + | TBD | ||
| + | ===== Dependencies ===== | ||
| + | None | ||
| + | ==== Documentation Impact ==== | ||
| + | Monitoring API section should be added here http://magnetodb.readthedocs.org/en/latest/api_reference.html | ||
| + | ==== References ==== | ||
| + | None | ||
Revision as of 11:19, 9 September 2014
MagnetoDB monitoring api
Launchpad: monitoring-api
The API for exposing usage statistic for users, external monitoring or billing tools.
Problem Description
As a magnetodb user I need to know how much data I have in table As a magnetodb administrator I need to know now much space is used with user's table As a accountant department I need to know how big user's table is in order to create a bill
Proposed Change
- Introduce monitoring API available on the same port as data API by path /moninoting/*
- implement REST method for list of tables /moninoting/{tenant_id}/tables
- table usage details /moninoting/{tenant_id}/table/{table_name}
Response: {size: 1003432; item_count: 3000}
Alternatives
Implement as part of data API. However it gives access to data itself for monitoring tools.
Security Impact
- authorization is performed by user's token
- authorization can be performed by token with specific role
Notifications Impact
None
Other End User Impact
TBD
Performance Impact
TBD
Other Deployer Impact
None
Developer Impact
None
Implementation
TBD (cql, JMX)
Assignee(s)
Primary assignee:
<ominakov>
Other contributors:
<None>
Work Items
TBD
Dependencies
None
Documentation Impact
Monitoring API section should be added here http://magnetodb.readthedocs.org/en/latest/api_reference.html
References
None
