Node:get-stats, Next:, Previous:get-stats-description, Up:Protocol Requests



get-stats [112] (11) Recommended


        get-stats [112] ( what : HOLLERITH )
                -> ( ARRAY Stats );

Return a list of the statistical measurements of what. The number of elements in the result corresponds to the when field of the Stats-Description returned by get-stats-description.

See Measured Properties, for more info on the what argument. See also Stats-Description.

Example:

        1 112 7Hclients
        =1 4 { 20 0 0 19.80 1.2 1.1 18.33 1.2 1.1 16.11 1.2 1.2e-02 }

Assuming that the when field of get-stats-description contains the time periods 0, 60, 300 and 900, the above result indicates that there is currently 20 connected clients. The past averages for 1, 5 and 15 minutes are 19.8, 18.33 and 16.11 connected clients.

You can use this call even if you are not logged in.

Error codes

feature-disabled
The measurement that was requested has been disabled.
undefined-measurement
The server doesn't measure the value requested by what.
access-denied
The client isn't allowed to retrieve the requested value. The client might be granted the privilege by logging in as a privileged user, using the enable request, by a receiving a privilege bit, or in an implementation-defined way.