You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by xi...@apache.org on 2017/07/18 07:45:01 UTC
[7/7] storm git commit: add doc for owner-resources rest api
add doc for owner-resources rest api
Project: http://git-wip-us.apache.org/repos/asf/storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/8ea90b9d
Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/8ea90b9d
Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/8ea90b9d
Branch: refs/heads/master
Commit: 8ea90b9d39c068c177613f08523780c7e1866c85
Parents: 02f2b77
Author: Ethan Li <et...@gmail.com>
Authored: Mon Jul 17 20:12:05 2017 -0500
Committer: Ethan Li <et...@gmail.com>
Committed: Mon Jul 17 20:12:05 2017 -0500
----------------------------------------------------------------------
docs/STORM-UI-REST-API.md | 57 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 57 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/storm/blob/8ea90b9d/docs/STORM-UI-REST-API.md
----------------------------------------------------------------------
diff --git a/docs/STORM-UI-REST-API.md b/docs/STORM-UI-REST-API.md
index 73be854..53adeb8 100644
--- a/docs/STORM-UI-REST-API.md
+++ b/docs/STORM-UI-REST-API.md
@@ -340,6 +340,63 @@ Sample response:
}
```
+### /api/v1/owner-resources (GET)
+
+Returns summary information aggregated at the topology owner level. Pass an optional id for a specific owner (e.g. /api/v1/owner-resources/theowner)
+
+Response fields:
+
+|Field |Value|Description|
+|--- |--- |---
+|owner |String |Topology owner
+|totalTopologies|Integer|Total number of topologies owner is running
+|totalExecutors |Integer|Total number of executors used by owner
+|totalWorkers |Integer|Total number of workers used by owner
+|totalTasks|Integer|Total number of tasks used by owner
+|totalMemoryUsage|Double|Total Memory Assigned on behalf of owner in MB
+|totalCpuUsage|Double|Total CPU Resource Assigned on behalf of User. Every 100 means 1 core
+|memoryGuarantee|Double|The amount of memory resource (in MB) guaranteed to owner
+|cpuGuarantee|Double|The amount of CPU resource (every 100 means 1 core) guaranteed to owner
+|isolatedNodes|Integer|The amount of nodes that are guaranteed isolated to owner
+|memoryGuaranteeRemaining|Double|The amount of guaranteed memory resources (in MB) remaining
+|cpuGuaranteeRemaining|Double|The amount of guaranteed CPU resource (every 100 means 1 core) remaining
+|totalReqOnHeapMem|Double| Total On-Heap Memory Requested by User in MB
+|totalReqOffHeapMem|Double|Total Off-Heap Memory Requested by User in MB
+|totalReqMem|Double|Total Memory Requested by User in MB
+|totalReqCpu|Double|Total CPU Resource Requested by User. Every 100 means 1 core
+|totalAssignedOnHeapMem|Double|Total On-Heap Memory Assigned on behalf of owner in MB
+|totalAssignedOffHeapMem|Double|Total Off-Heap Memory Assigned on behalf of owner in MB
+
+Sample response:
+
+```json
+{
+ "owners": [
+ {
+ "totalReqOnHeapMem": 896,
+ "owner": "ownerA",
+ "totalExecutors": 7,
+ "cpuGuaranteeRemaining": 30,
+ "totalReqMem": 896,
+ "cpuGuarantee": 100,
+ "isolatedNodes": "N/A",
+ "memoryGuarantee": 4000,
+ "memoryGuaranteeRemaining": 3104,
+ "totalTasks": 7,
+ "totalMemoryUsage": 896,
+ "totalReqOffHeapMem": 0,
+ "totalReqCpu": 70,
+ "totalWorkers": 2,
+ "totalCpuUsage": 70,
+ "totalAssignedOffHeapMem": 0,
+ "totalAssignedOnHeapMem": 896,
+ "totalTopologies": 1
+ }
+ ],
+ "schedulerDisplayResource": true
+}
+```
+
### /api/v1/topology/summary (GET)
Returns summary information for all topologies.