Return to status.txt CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / lighttpd / doc / outdated

1.4.33

    1: =============
    2: Server Status
    3: =============
    4: 
    5: ------------------
    6: Module: mod_status
    7: ------------------
    8: 
    9: :Author: Jan Kneschke
   10: :Date: $Date: 2013/10/14 10:32:48 $
   11: :Revision: $Revision: 1.1.1.1 $
   12: 
   13: :abstract:
   14:   mod_status displays the server's status and configuration
   15: 
   16: .. meta::
   17:   :keywords: lighttpd, server status
   18: 
   19: .. contents:: Table of Contents
   20: 
   21: Description
   22: ===========
   23: 
   24: The server status module generates the status overview of the webserver. The
   25: information covers:
   26: 
   27: - uptime
   28: - average throughput
   29: - current throughput
   30: - active connections and their state
   31: 
   32: 
   33: We need to load the module first. ::
   34: 
   35:   server.modules = ( ..., "mod_ssi", ... )
   36: 
   37: By default the status page is disabled to hide internal information from
   38: unauthorized users. ::
   39: 
   40:   status.status-url = "/server-status"
   41: 
   42: If you want to open the status page just for users from the local network
   43: cover it in a conditional. ::
   44: 
   45:   $HTTP["remoteip"] == "10.0.0.0/8" {
   46:     status.status-url = "/server-status"
   47:   }
   48: 
   49: Or require authorization: ::
   50: 
   51:   auth.require = ( "/server-status" =>
   52:     ( "realm" ... ) )
   53: 
   54: 
   55: Please note that when using the server.max-worker directive, the stati of the
   56: childs are not combined yet, so you're going to see different stats with each
   57: request.
   58: 
   59: 
   60: Output Format
   61: -------------
   62: 
   63: By default a nice looking HTML page is generated. If you append ?auto to the
   64: status-url you can get a text version which is simpler to parse. ::
   65: 
   66:   Total Accesses: 1234
   67:   Total kBytes: 1043
   68:   Uptime: 1234
   69:   BusyServers: 123
   70: 
   71: Total Accesses is the number of handled requests, kBytes the overall outgoing
   72: traffic, Uptime the uptime in seconds and BusyServers the number of currently
   73: active connections.
   74: 
   75: The naming is kept compatible to Apache even if we have another concept and
   76: don't start new servers for each connection.
   77: 
   78: 
   79: Options
   80: =======
   81: 
   82: status.status-url
   83: 
   84:   relative URL which is used to retrieve the status-page
   85: 
   86:   Default: unset
   87: 
   88:   Example: status.status-url = "/server-status"
   89: 
   90: status.enable-sort
   91: 
   92:   add JavaScript which allows client-side sorting for the connection overview
   93: 
   94:   Default: enable
   95: 
   96: status.config-url
   97: 
   98:   relative URL for the config page which displays the loaded modules
   99: 
  100:   Default: unset
  101: 
  102:   Example: status.config-url = "/server-config"
  103: 
  104: status.statistics-url
  105: 
  106:   relative URL for a plain-text page containing the internal statistics
  107: 
  108:   Default: unset
  109: 
  110:   Example: status.statistics-url = "/server-statistics"
  111: