units: Units in which the figure is measured.",
"summary": " Statistics description",
"httpMethod": "GET",
"examples": "
shell> curl --data-binary @- --dump - http://localhost:8529/_admin/statistics-description\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n \"groups\" : [ \n { \n \"group\" : \"system\", \n \"name\" : \"Process Statistics\", \n \"description\" : \"Statistics about the ArangoDB process\" \n }, \n { \n \"group\" : \"client\", \n \"name\" : \"Client Connection Statistics\", \n \"description\" : \"Statistics about the connections.\" \n }, \n { \n \"group\" : \"http\", \n \"name\" : \"HTTP Request Statistics\", \n \"description\" : \"Statistics about the HTTP requests.\" \n }, \n { \n \"group\" : \"server\", \n \"name\" : \"Server Statistics\", \n \"description\" : \"Statistics about the ArangoDB server\" \n } \n ], \n \"figures\" : [ \n { \n \"group\" : \"system\", \n \"identifier\" : \"userTime\", \n \"name\" : \"User Time\", \n \"description\" : \"Amount of time that this process has been scheduled in user mode, measured in seconds.\", \n \"type\" : \"accumulated\", \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"systemTime\", \n \"name\" : \"System Time\", \n \"description\" : \"Amount of time that this process has been scheduled in kernel mode, measured in seconds.\", \n \"type\" : \"accumulated\", \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"numberOfThreads\", \n \"name\" : \"Number of Threads\", \n \"description\" : \"Number of threads in the arangod process.\", \n \"type\" : \"current\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"residentSize\", \n \"name\" : \"Resident Set Size\", \n \"description\" : \"The total size of the number of pages the process has in real memory. This is just the pages which count toward text, data, or stack space. This does not include pages which have not been demand-loaded in, or which are swapped out. The resident set size is reported in bytes.\", \n \"type\" : \"current\", \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"residentSizePercent\", \n \"name\" : \"Resident Set Size\", \n \"description\" : \"The percentage of physical memory used by the process as resident set size.\", \n \"type\" : \"current\", \n \"units\" : \"percent\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"virtualSize\", \n \"name\" : \"Virtual Memory Size\", \n \"description\" : \"On Windows, this figure contains the total amount of memory that the memory manager has committed for the arangod process. On other systems, this figure contains The size of the virtual memory the process is using.\", \n \"type\" : \"current\", \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"minorPageFaults\", \n \"name\" : \"Minor Page Faults\", \n \"description\" : \"The number of minor faults the process has made which have not required loading a memory page from disk. This figure is not reported on Windows.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"system\", \n \"identifier\" : \"majorPageFaults\", \n \"name\" : \"Major Page Faults\", \n \"description\" : \"On Windows, this figure contains the total number of page faults. On other system, this figure contains the number of major faults the process has made which have required loading a memory page from disk.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"httpConnections\", \n \"name\" : \"Client Connections\", \n \"description\" : \"The number of connections that are currently open.\", \n \"type\" : \"current\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"totalTime\", \n \"name\" : \"Total Time\", \n \"description\" : \"Total time needed to answer a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.01, \n 0.05, \n 0.1, \n 0.2, \n 0.5, \n 1 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"requestTime\", \n \"name\" : \"Request Time\", \n \"description\" : \"Request time needed to answer a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.01, \n 0.05, \n 0.1, \n 0.2, \n 0.5, \n 1 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"queueTime\", \n \"name\" : \"Queue Time\", \n \"description\" : \"Queue time needed to answer a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.01, \n 0.05, \n 0.1, \n 0.2, \n 0.5, \n 1 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"bytesSent\", \n \"name\" : \"Bytes Sent\", \n \"description\" : \"Bytes sents for a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 250, \n 1000, \n 2000, \n 5000, \n 10000 \n ], \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"bytesReceived\", \n \"name\" : \"Bytes Received\", \n \"description\" : \"Bytes receiveds for a request.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 250, \n 1000, \n 2000, \n 5000, \n 10000 \n ], \n \"units\" : \"bytes\" \n }, \n { \n \"group\" : \"client\", \n \"identifier\" : \"connectionTime\", \n \"name\" : \"Connection Time\", \n \"description\" : \"Total connection time of a client.\", \n \"type\" : \"distribution\", \n \"cuts\" : [ \n 0.1, \n 1, \n 60 \n ], \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsTotal\", \n \"name\" : \"Total requests\", \n \"description\" : \"Total number of HTTP requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsAsync\", \n \"name\" : \"Async requests\", \n \"description\" : \"Number of asynchronously executed HTTP requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsGet\", \n \"name\" : \"HTTP GET requests\", \n \"description\" : \"Number of HTTP GET requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsHead\", \n \"name\" : \"HTTP HEAD requests\", \n \"description\" : \"Number of HTTP HEAD requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsPost\", \n \"name\" : \"HTTP POST requests\", \n \"description\" : \"Number of HTTP POST requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsPut\", \n \"name\" : \"HTTP PUT requests\", \n \"description\" : \"Number of HTTP PUT requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsPatch\", \n \"name\" : \"HTTP PATCH requests\", \n \"description\" : \"Number of HTTP PATCH requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsDelete\", \n \"name\" : \"HTTP DELETE requests\", \n \"description\" : \"Number of HTTP DELETE requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsOptions\", \n \"name\" : \"HTTP OPTIONS requests\", \n \"description\" : \"Number of HTTP OPTIONS requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"http\", \n \"identifier\" : \"requestsOther\", \n \"name\" : \"other HTTP requests\", \n \"description\" : \"Number of other HTTP requests.\", \n \"type\" : \"accumulated\", \n \"units\" : \"number\" \n }, \n { \n \"group\" : \"server\", \n \"identifier\" : \"uptime\", \n \"name\" : \"Server Uptime\", \n \"description\" : \"Number of seconds elapsed since server start.\", \n \"type\" : \"current\", \n \"units\" : \"seconds\" \n }, \n { \n \"group\" : \"server\", \n \"identifier\" : \"physicalMemory\", \n \"name\" : \"Physical Memory\", \n \"description\" : \"Physical memory in bytes.\", \n \"type\" : \"current\", \n \"units\" : \"bytes\" \n } \n ], \n \"error\" : false, \n \"code\" : 200 \n}\n
@endDocuBlock",
"nickname": "StatisticsDescription"
}
],
"path": "/_admin/statistics-description"
},
{
"operations": [
{
"errorResponses": [],
"parameters": [
{
"dataType": "Javascript",
"paramType": "body",
"required": "true",
"name": "body",
"description": "A JSON body containing an attribute \"tests\" which lists the files containing the test suites.
"
}
],
"notes": "
Executes the specified tests on the server and returns an object with the test results. The object has an attribute \"error\" which states whether any error occurred. The object also has an attribute \"passed\" which indicates which tests passed and which did not. @endDocuBlock",
"summary": " Runs tests on server",
"httpMethod": "POST",
"examples": "",
"nickname": "RunsTestsOnServer"
}
],
"path": "/_admin/test"
},
{
"operations": [
{
"errorResponses": [],
"parameters": [
{
"dataType": "Javascript",
"paramType": "body",
"required": "true",
"name": "body",
"description": "The body to be executed.
"
}
],
"notes": "
Executes the javascript code in the body on the server as the body of a function with no arguments. If you have a return statement then the return value you produce will be returned as content type application/json. If the parameter returnAsJSON is set to true, the result will be a JSON object describing the return value directly, otherwise a string produced by JSON.stringify will be returned. @endDocuBlock",
"summary": " Execute program",
"httpMethod": "POST",
"examples": "",
"nickname": "ExecuteProgram"
}
],
"path": "/_admin/execute"
}
]
}