- Home
- Unravel 4.5 Documentation
- Advanced Topics
- REST API
- Report Endpoints
Report Endpoints
These endpoints return key performance indicators (KPIs) for clusters, the small files report, chargeback reports (by user, queue, app), and cluster workload reports.
Cluster Reports
Chargeback Reports
Gets chargeback reports by application type. Gives the count of all applications in all queues for all users across all clusters.
GET http://unravel-host
:3000/api/v1/search/cb/appt?from={date}&to={date}
None.
Name | Type | Description |
---|---|---|
| string | Start date. Format: |
| string | End date. Format: |
{ "cb": [ // array organizing by application type { "ms": memory usage seconds, "count": application count, "v1": "application type (mr | spark)", "vs": vcore usage in second } ] }
Request:
curl -X GET "http://myserver.com:3000/api/v1/search/cb/appt?from=1536670860&to=1536757260" -H "accept: application/json" -H "Authorization: JWT token
"
Response:
{ "cb": [ { "ms": 2324825154, "count": 4332, "v1": "mr", "vs": 1512734 }, { "ms": 298989641, "count": 75, "v1": "spark", "vs": 120404 } ] }
Gets chargeback reports by user.
GET http://unravel-host
:3000/api/v1/search/cb/appt/user?from={date}&to={date}
None.
Name | Type | Description |
---|---|---|
| string | Start date. Format: |
| string | End date. Format: |
{ "cb": [ // array by application type { "count": application count, "v1": application type (mr, | spark), , "cb": [ //array of users or queues (depending on command) { "ms": memory usage in milliseconds,, "count": application count,, "v2": userName | queueName,, "vs": vcore usage in seconds } ] } ]
Request:
curl -X GET "http://myserver.com:3000/api/v1/search/cb/appt/user?from=1536676860&to=1536763260" -H "accept: application/json" -H "Authorization: JWT token
"
Response:
{ "cb": [ { "count": 27, "v1": "mr", "cb": [ { "ms": 1974235, "count": 27, "v2": "root.users.root", "vs": 798 } ] } ] }
Gets chargeback reports by queue.
GET http://unravel-host
:3000/api/v1/search/cb/appt/queue?from={date}&to={date}
None.
Name | Type | Description |
---|---|---|
| string | Start date. Format: |
| string | End date. Format: |
{ "cb": [ // array by application type { "count": application count, "v1": application type (mr, | spark), , "cb": [ //array of users or queues (depending on command) { "ms": memory usage in milliseconds,, "count": application count,, "v2": userName | queueName,, "vs": vcore usage in seconds } ] } ] }
Request:
curl -X GET "http://myserver.com:3000/api/v1/search/cb/appt/queue?from=1536676860&to=1536763260" -H "accept: application/json" -H "Authorization: JWT token
"
Response:
{ "cb": [ { "count": 27, "v1": "mr", "cb": [ { "ms": 1974235, "count": 27, "v2": "root.users.root", "vs": 798 } ] } ] }
Gets chargeback reports by application type for a specific queue.
GET http://unravel-host
:3000/api/v1/search/cb/user?appt={app_type}>e={date}<e={date}&queue={queue_name}
None.
Name | Type | Description |
---|---|---|
| string | Application type. Required. Valid values are |
| string | Start date. Format: |
| string | End date. Format: |
| string | Queue name. Required. |
{ "cb": [ // array by application type { "ms": memory usage in milliseconds, "count": application count, "v2": userName | queueName, "vs": vcore usage in seconds } ] }
Request:
curl -X GET "http://myserver.com:3000/api/v1/search/cb/user?appt=mr>e=1536677580<e=1536763980&queue=root.users.root" -H "accept: application/json" -H "Authorization: JWT token
"
Response:
{ "cb": [ { "ms": 2324825154, "count": 4332, "v1": "mr", "vs": 1512734 }, { "ms": 298989641, "count": 75, "v1": "spark", "vs": 120404 } ] }