Github user revans2 commented on a diff in the pull request:
https://github.com/apache/incubator-storm/pull/157#discussion_r14187663
--- Diff: STORM-UI-REST-API.md ---
@@ -0,0 +1,513 @@
+# Storm UI REST API
+Storm UI server provides a REST Api to access cluster, topology, component
overview and metrics.
+This api returns json response.
+
+## Using the UI REST Api
+
+### /api/v1/cluster/configuration (GET)
+ returns cluster configuration.
+
+Sample Response:
+```json
+ {
+ "dev.zookeeper.path": "/tmp/dev-storm-zookeeper",
+ "topology.tick.tuple.freq.secs": null,
+ "topology.builtin.metrics.bucket.size.secs": 60,
+ "topology.fall.back.on.java.serialization": true,
+ "topology.max.error.report.per.interval": 5,
+ "zmq.linger.millis": 5000,
+ "topology.skip.missing.kryo.registrations": false,
+ "storm.messaging.netty.client_worker_threads": 1,
+ "ui.childopts": "-Xmx768m",
+ "storm.zookeeper.session.timeout": 20000,
+ "nimbus.reassign": true,
+ "topology.trident.batch.emit.interval.millis": 500,
+ "storm.messaging.netty.flush.check.interval.ms": 10,
+ "nimbus.monitor.freq.secs": 10,
+ "logviewer.childopts": "-Xmx128m",
+ "java.library.path": "/usr/local/lib:/opt/local/lib:/usr/lib",
+ "topology.executor.send.buffer.size": 1024,
+ }
+```
+
+### /api/v1/cluster/summary (GET)
+returns cluster summary such as nimbus uptime,number of supervisors,slots
etc..
+
+Response Fields:
+
+|Field |Description|
+|--- |--- |
+|stormVersion| Storm version|
+|nimbusUptime| Shows how long the cluster is running|
+|supervisors| Number of supervisors running|
+|slotsTotal| Total number of available worker slots|
+|slotsUsed| Number of worker slots used|
+|slotsFree| Number of worker slots available|
+|executorsTotal| Total number of executors|
+|tasksTotal| Total tasks|
+
+Sample Response:
+```json
+ {
+ "stormVersion": "0.9.2-incubating-SNAPSHOT",
+ "nimbusUptime": "3m 53s",
+ "supervisors": 1,
+ "slotsTotal": 4,
+ "slotsUsed": 3,
+ "slotsFree": 1,
+ "executorsTotal": 28,
+ "tasksTotal": 28
+ }
+```
+
+### /api/v1/supervisor/summary (GET)
+returns all supervisors summary
+
+Response Fields:
+
+|Field |Description|
+|--- |--- |
+|id| Supervisor's id|
+|host| Supervisor's host name|
+|uptime| Shows how long the supervisor is runninge|
--- End diff --
Similarly we should document the format
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
