getstats

Get runtime statistics of the server and of XML Libraries.



HTTP Request: GET

Parameters:

NameValueDescriptionformat
level

"admin" (the default), or "expert".

If the level is "admin", statistics are summarized, otherwise all statistics are returned.

format
  • "text" : (the default) returns tab-separated lines, each containing the fields described below.
  • "json" : returns an array containing one map for each statistic (see below) .

Response:

   mime-type: text/plain

   mime-type: application/json

Whatever the format, the response contains the following fields:

FieldDescription
IdIdentifier of the statistic: corresponds with an activity or an action. Several values can be attached: "count", "size", "time" etc. (see below)
TypeName of a type of value attached to an activity:
  • count: total number of occurrences
  • size: total number of bytes (for a data flow)
  • time: total time spent in this activity in milliseconds.
  • hits: total number of accesses for a Cache
  • hit_ratio: percentage of accesses where data was found in a Cache
ValueValue of the measurement according to its type
FamilyFamily or class of measured activity:
  • Activity: a simple event like a REST request.

    Associated values: count, time
  • CachedIO: cached data flow.

    Associated values: hits, hit_ratio, size, time
  • Data: data allocation.

    Associated values: count, size, time
  • Event: simple event.

    Associated values: count
  • IO: data flow.

    Associated values: count, size, time

Error codes:

AccessControl
if the user does not have the admin role.