twitter-archive/ostrich

Mention the possible meaning (usage) of internal urls

xasima opened this issue · 1 comments

Besides documenting the standards ostrich commands (that is presented on project description).

ping
reload
shutdown
quiesce
stats
server_info
threads
gc

please mention in more details the possible meaning (usage) of internal urls

/report/
/pprof/heap
/pprof/profile
/pprof/contention
/tracing
/health
/graph/
/graph_data
/quitquitquit
/abortabortabort

It seems that html /report (versus json /stats), health (versus admin /ping), and graph_data may brings additional information for developers / integration.

Here's more explanation:
the pprof command line tool can be found here: https://code.google.com/p/gperftools/

/pprof/contention
Returns a CPU contention profile. The output is in pprof format.

/pprof/profile
Returns a CPU usage profile. The output is in pprof format.
$ curl -s localhost:8080/admin/pprof/profile > /tmp/cpu_profiling
$ pprof --text /tmp/cpu_profiling
Using local file /tmp/cpu_profiling.
Using local file /tmp/cpu_profiling.
Total: 48 samples
47 97.9% 97.9% 47 97.9% sun.nio.ch.KQueueArrayWrapper.kevent0
1 2.1% 100.0% 1 2.1% java.lang.System.arraycopy
0 0.0% 100.0% 1 2.1% com.twitter.concurrent.AsyncQueue.offer
0 0.0% 100.0% 1 2.1% com.twitter.concurrent.Scheduler$.submit
0 0.0% 100.0% 1 2.1% com.twitter.concurrent.Scheduler$LocalScheduler.run
0 0.0% 100.0% 1 2.1% com.twitter.concurrent.Scheduler$LocalScheduler.submit
0 0.0% 100.0% 1 2.1% com.twitter.finagle.Filter$$anon$2.apply
...

/pprof/heap
Returns a heap profile computed by the heapster agent. The output is in pprof format.
$ java -agentlib:heapster -jar target/myserver-1.0.0-SNAPSHOT.jar
$ pprof /tmp/heapster_profile
Welcome to pprof! For help, type 'help'.
(pprof) top
Total: 2001520 samples
2000024 99.9% 99.9% 2000048 99.9% LTest;main
1056 0.1% 100.0% 1056 0.1% Ljava/lang/Object;
296 0.0% 100.0% 296 0.0% Ljava/lang/String;toCharArray
104 0.0% 100.0% 136 0.0% Ljava/lang/Shutdown;

/tracing
Enable (/tracing?enable=true) or disable tracing (/tracing?disable=true)
See zipkin documentation for more info.

Those are Mesos related:
(See http://incubator.apache.org/mesos/)

/abortabortabort
Abort the process.

/health
Return OK (identical to /ping).

/quitquitquit
Quit the process.