hphp/doc/command.admin_server

   1 <h2>Admin Server URL Commands</h2>
   2
   3 When running a compiled program as an HTTP server, by default it runs an
   4 admin server on a specified port. One can send an HTTP request to this port
   5 to perform certain actions. To list all possible commands,
   6
   7   GET http://localhost:8088
   8
   9 A particular command is like:
  10
  11   GET http://localhost:8088/<command-URL>?auth=<password>
  12
  13 This is a list of available URLs:
  14
  15
  16 /stop:            stop the web server
  17 /translate:       translate hex encoded stacktrace in 'stack' param
  18     stack         required, stack trace to translate
  19     build-id      optional, if specified, build ID has to match
  20     bare          optional, whether to display frame ordinates
  21 /build-id:        returns build id that's passed in from command line
  22 /check-load:      how many threads are actively handling requests
  23 /check-mem:       report memory quick statistics in log file
  24 /check-apc:       report APC quick statistics
  25 /status.xml:      show server status in XML
  26 /status.json:     show server status in JSON
  27 /status.html:     show server status in HTML
  28 /stats-on:        main switch: enable server stats
  29 /stats-off:       main switch: disable server stats
  30 /stats-clear:     clear all server stats
  31 /stats-web:       turn on/off server page stats (CPU and gen time)
  32 /stats-mem:       turn on/off memory statistics
  33 /stats-apc:       turn on/off APC statistics
  34 /stats-apc-key:   turn on/off APC key statistics
  35 /stats-mcc:       turn on/off memcache statistics
  36 /stats-sql:       turn on/off SQL statistics
  37 /stats-mutex:     turn on/off mutex statistics
  38     sampling      optional, default 1000
  39 /stats.keys:      list all available keys
  40     from          optional, <timestamp>, or <-n> second ago
  41     to            optional, <timestamp>, or <-n> second ago
  42 /stats.xml:       show server stats in XML
  43 /stats.json:      show server stats in JSON
  44 /stats.kvp:       show server stats in key-value pairs
  45 /stats.html:      show server stats in HTML
  46     from          optional, <timestamp>, or <-n> second ago
  47     to            optional, <timestamp>, or <-n> second ago
  48     agg           optional, aggragation: *, url, code
  49     keys          optional, <key>,<key/hit>,<key/sec>,<:regex:>
  50     url           optional, only stats of this page or URL
  51     code          optional, only stats of pages returning this code
  52
  53 If program was compiled with GOOGLE_CPU_PROFILER, these commands will become available,
  54
  55 /prof-cpu-on:     turn on CPU profiler
  56 /prof-cpu-off:    turn off CPU profiler
  57
  58 If program was compiled with GOOGLE_TCMALLOC, these commands will become available,
  59
  60 /free-mem:        ask tcmalloc to release memory to system
  61 /tcmalloc-stats:  get internal tcmalloc stats
  62
  63 If program was compiled with USE_JEMALLOC, these commands will become available,
  64
  65 /free-mem:        ask jemalloc to release memory to system
  66 /jemalloc-stats:  get internal jemalloc stats
  67 /jemalloc-stats-print: get comprehensive jemalloc stats in human-readable form
  68 /jemalloc-prof-activate: activate heap profiling
  69 /jemalloc-prof-deactivate: deactivate heap profiling
  70 /jemalloc-prof-dump: dump heap profile
  71     file          optional, filesystem path