Get Server Statistics on Resources Usage

Request Parameters

Request does not contain parameters.

Request Example

http://192.168.1.1:9080/api/server/usage.ds

XML and JSON response structure examples are described below.

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1558521947" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<usage>
<alert total="0" size="0" failed="0" sent="0"/>

<load-average>
<load1>0.88</load1>

<used-by-server>29</used-by-server>
</memory>

<soft-limit>131170</soft-limit>

<hard-limit>131170</hard-limit>
</fd>
</usage>
</drweb-es-api>

Description of XML Response Parameters

The <usage /> element contains information on utilizing Server resources.

•The <alert /> element contains information on the Server notifications.

The <alert /> element attributes:

Attribute	Description
total	Total number of generated notifications
size	Total size of generated notifications
failed	Number of unsent notifications
sent	Number of successfully sent notifications

•The <client /> element contains information on the clients connected to the Server.

The <client /> element attributes:

Attribute	Description
agents	Number of connected Agents
consoles	Number of connected Control Centers
installs	Number of the Agent installations currently running
links	Number of connected neighbor Servers
newbies	Number of newbies
proxies	Number of proxy servers

•The <cluster /> element contains information on the Servers cluster.

The <cluster /> element attributes:

Attribute	Description
bytes_in	Number of received data in bytes
bytes_out	Number of sent data in bytes
messages_in	Number of received messages
messages_out	Number of sent messages

•The <connections /> element contains information on the Server network connections.

The <connections /> element attributes:

Attribute	Description
total	Total number of allowed connections
current	Number of active connections at the moment
maximum	Fixed maximum of simultaneous connections

•The <vm /> element contains information on a usage of system resources on the computer with the Server installed.

The <vm /> element attributes:

Attribute	Description
context_switches	Number of context switches
cpu_kernel	CPU operation time in the kernel mode
cpu_user	CPU operation time in the user mode
page_faults	Number of page faults
read_cnt	Number of memory read
write_cnt	Number of memory write
virtual_memory	Virtual memory currently allocated to the Server
threads	Number of running threads
working_set	Working set

•The <db /> element contains information on the Server database usage.

The <db /> element attributes:

Attribute	Description
rows_read	Number of read rows
rows_written	Number of written rows
statements_fail	Number of failed statements
statements_ok	Number of succeeded statements
transactions_rolledback	Number of rolled back transactions
transactions_comitted	Number of committed transactions

•The <repository /> element contains information on the Server repository.

The <repository /> element attributes:

Attribute	Description
bytes_in	Number of received data in bytes
bytes_out	Number of sent data in bytes
files_added	Number of new files added
files_deleted	Number of deleted files
files_replaced	Number of replaced files
http_fail	Number of failed HTTP requests
http_ok	Number of succeeded HTTP requests

•The <cache /> element contains information on a cache usage.

▫The <dns /> element contains information on DNS cache usage.

The <dns /> element attributes:

Attribute	Description
hit	Number of cache hits
missed	Number of cache misses
size	Current cache size

▫The <file /> element contains information on usage of the file cache.

The <file /> element attributes:

Attribute	Description
hit	Number of cache hits
max_msize	Maximum cache size
max_vsize	Maximum virtual cache size
vsize	Virtual cache size
missed	Number of cache misses
msize	Current cache size

▫The <mcastupdate /> element contains information on cache usage during multicast updates.

The <mcastupdate /> element attributes:

Attribute	Description
bytes_in	Number of received data in bytes
bytes_out	Number of sent data in bytes
packets_in	Number of received packages
packets_out	Number of sent packages

▫The <repository /> element contains information on repository cache usage.

The <repository /> element attributes:

Attribute	Description
hit	Number of cache hits
max_msize	Maximum cache size
max_vsize	Maximum virtual cache size
missed	Number of cache misses
msize	Current cache size
vsize	Virtual cache size

•The <load-average /> element contains average load of a system for a certain period.

Nested elements of the <load-average /> element:

Element	Description
<load1 />	Percentage of system load for 1 minute
<load5 />	Percentage of system load for 5 minutes
<load15 />	Percentage of system load for 15 minutes

Average system load value is calculated for UNIX-based systems only. For Windows OS the "-1" value is returned.

•The <memory /> element contains information on operative memory of the computer on which the Server is installed.

Nested elements of the <memory /> element:

Element	Description
<total />	Total amount of operative memory
<free />	Amount of free operative memory
<used-by-server />	Amount of operative memory used by the Server

•The <fd /> element contains information about all open files on the Server.

The <fd /> element elements:

Element	Description
<opened />	Number of open files on the Server
<soft-limit />	Recommended open file number limit
<hard-limit />	Strict open file number limit

An open file number limit is relevant for UNIX-based systems only.

JSON Response

{ "head": {
"status": true,

"timestamp": 1558522035,

"api": {
"version": 40300,
"versionString": 4.3.0},

"server": {
"name": "192.168.1.1",

"version": "12.00.0.201909260",
"uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
"usage": {
"alert": {
"failed": 0,

"sent": 0,

"size": 0,
"total": 0},

"cache": {
"dns": {
"hit": 0,

"missed": 0},
"size": 0},

"file": {
"hit": 1136,

"max_msize": 249,

"max_vsize": 249,

"missed": 1,

"msize": 249,
"vsize": 249},

"mcastupdate": {
"bytes_in": 0,

"bytes_out": 0,

"packets_in": 0,
"packets_out": 0},

"repository": {
"hit": 619,

"max_msize": 3605106,

"max_vsize": 3615410,

"missed": 0,

"msize": 3605106,
"vsize": 3605106}},

"client": {
"agents": 0,

"consoles": 0,

"installs": 0,

"links": 0,

"newbies": 0,
"proxies": 0},

"cluster": {
"bytes_in": 0,

"bytes_out": 0,

"messages_in": 0,
"messages_out": 0},

"connect": {
"current": 0,

"maximum": 1,
"total": 1},

"db": {
"rows_read": 543261,

"rows_written": 51448,

"statements_fail": 0,

"statements_ok": 93305,

"transactions_comitted": 50865,
"transactions_rolledback": 1},

"fd": {
"hard_limit": 131170,

"opened": 97,
"soft_limit": 131170},

"load_average": {
"load1": 1.12,

"load15": 0.35,
"load5": 0.72},

"memory": {
"free": 311,

"total": 3944,
"used_by_server": 29},

"repository": {
"bytes_in": 0,

"bytes_out": 0,

"files_added": 0,

"files_deleted": 0,

"files_replaced": 0,

"http_fail": 0,
"http_ok": 0},

"vm": {
"context_switches": 98105,

"cpu_kernel": 552177500,

"cpu_user": 2671634000,

"page_faults": 35579,

"read_cnt": 0,

"threads": 36,

"virtual_memory": 384000000,

"working_set": 94928896,
"write_cnt": 1502632}}}}

Description of JSON Response Parameters

The usage block contains information on utilizing Server resources.

•The alert block contains information on the Server notifications.

The alert block elements:

Field name	Description
failed	Number of unsent notifications
sent	Number of successfully sent notifications
size	Total size of generated notifications
total	Total number of generated notifications

•The cache block contains information on a cache usage.

▫The dns block contains information on DNS cache usage.

The dns block elements:

Field name	Description
hit	Number of cache hits
missed	Number of cache misses
size	Current cache size

▫The file block contains information on usage of the file cache.

The file block elements:

Field name	Description
hit	Number of cache hits
max_msize	Maximum cache size
max_vsize	Maximum virtual cache size
missed	Number of cache misses
msize	Current cache size
vsize	Virtual cache size

▫The mcastupdate block contains information on cache usage during multicast updates.

The mcastupdate block elements:

Field name	Description
bytes_in	Number of received data in bytes
bytes_out	Number of sent data in bytes
packets_in	Number of received packages
packets_out	Number of sent packages

▫The repository block included into the cache block, contains information on repository cache usage.

The repository block elements:

Field name	Description
hit	Number of cache hits
max_msize	Maximum cache size
max_vsize	Maximum virtual cache size
missed	Number of cache misses
msize	Current cache size
vsize	Virtual cache size

•The client block contains information on the clients connected to the Server.

The client block elements:

Field name	Description
agents	Number of connected Agents
consoles	Number of connected Control Centers
installs	Number of the Agent installations currently running
links	Number of connected neighbor Servers
newbies	Number of newbies
proxies	Number of proxy servers

•The cluster block contains information on the Servers cluster.

The cluster block elements:

Field name	Description
bytes_in	Number of received data in bytes
bytes_out	Number of sent data in bytes
messages_in	Number of received messages
messages_out	Number of sent messages

•The connect block contains information on the Server network connections.

The connect block elements:

Field name	Description
current	Number of active connections at the moment
maximum	Fixed maximum of simultaneous connections
total	Total number of allowed connections

•The db block contains information on the Server database usage.

The db block elements:

Field name	Description
rows_read	Number of read rows
rows_written	Number of written rows
statements_fail	Number of failed statements
statements_ok	Number of succeeded statements
transactions_comitted	Number of committed transactions
transactions_rolledback	Number of rolled back transactions

•The fd block contains information about all open files on the Server.

The fd block elements:

Field name	Description
hard_limit	Strict open file number limit
opened	Number of open files on the Server
soft_limit	Recommended open file number limit

An open file number limit is relevant for UNIX-based systems only.

•The load_average block contains average load of a system for a certain period.

The load_average block elements:

Field name	Description
load1	Percentage of system load for 1 minute
load15	Percentage of system load for 15 minutes
load5	Percentage of system load for 5 minutes

Average system load value is calculated for UNIX-based systems only. For Windows OS the "-1" value is returned.

•The memory block contains information on operative memory of the computer on which the Server is installed.

The memory block elements:

Field name	Description
free	Amount of free operative memory
total	Total amount of operative memory
used_by_server	Amount of operative memory used by the Server

•The repository block contains information on the Server repository.

The repository block elements:

Field name	Description
bytes_in	Number of received data in bytes
bytes_out	Number of sent data in bytes
files_added	Number of new files added
files_deleted	Number of deleted files
files_replaced	Number of replaced files
http_fail	Number of failed HTTP requests
http_ok	Number of succeeded HTTP requests

•The vm block contains information on a usage of system resources on the computer with the Server installed.

The vm block elements:

Field name	Description
context_switches	Number of context switches
cpu_kernel	CPU operation time in the kernel mode
cpu_user	CPU operation time in the user mode
page_faults	Number of page faults
read_cnt	Number of memory read
threads	Number of running threads
virtual_memory	Virtual memory currently allocated to the Server
working_set	Working set
write_cnt	Number of memory write