Получение статистики Сервера Dr.Web по использованию ресурсов

Параметры запроса

Запрос не имеет параметров.

Пример запроса

https://192.168.1.1:9081/api/server/usage.ds

Ниже представлены примеры ответов в формате XML и в формате JSON.

Ответ в формате XML

<drweb-es-api api_version="4.3.2" timestamp="1587044670" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">

  <usage>

    <alert total="3502" size="3135989" failed="0" sent="3502"/>

    <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"/>

    <connections total="0" current="0" maximum="0"/>

    <vm context_switches="766432" cpu_kernel="3674985100" cpu_user="14969789200" page_faults="1248460" read_cnt="8" write_cnt="977896" threads="41" virtual_memory="1180983296" working_set="100872192"/>

    <db rows_read="542526" rows_written="51448" statements_fail="0" statements_ok="93240" transactions_rolledback="1" transactions_comitted="50800"/>

    <repository bytes_in="1408068" bytes_out="543472" files_added="0" files_deleted="0" files_replaced="0" http_fail="1287" http_ok="0"/>

    <cache>

        <dns hit="198" missed="254" size="1"/>

        <file hit="2755" max_msize="386173" max_vsize="386173" vsize="249" missed="48" msize="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"/>

    </cache>

    <load-average>

        <load1>0.88</load1>

        <load5>0.57</load5>

        <load15>0.27</load15>

    </load-average>

    <memory>

        <total>3753</total>

        <free>827</free>

        <used-by-server>11</used-by-server>

    </memory>

    <fd>

        <opened>74</opened>

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

        <hard-limit>131170</hard-limit>

    </fd>

  </usage>

</drweb-es-api>

Описание параметров ответного XML

Элемент <usage /> содержит информацию по использованию ресурсов Сервера Dr.Web.

•Элемент <alert /> содержит информацию об уведомлениях Сервера Dr.Web.

Атрибуты элемента <alert />:

Атрибут

Описание

total

Общее количество сгенерированных уведомлений

size

Общий размер сгенерированных уведомлений (в килобайтах)

failed

Количество неотправленных уведомлений

sent

Количество успешно отправленных уведомлений

•Элемент <client /> содержит информацию о клиентах, подключенных к Серверу Dr.Web.

Атрибуты элемента <client />:

Атрибут

Описание

agents

Количество подключенных Агентов

consoles

Количество подключенных Центров управления

installs

Количество установок Агента, запущенных в данный момент

links

Количество связанных соседних Серверов Dr.Web

newbies

Количество новичков

proxies

Количество Прокси-серверов Dr.Web

•Элемент <cluster /> содержит информацию о кластере Серверов Dr.Web.

Атрибуты элемента <cluster />:

Атрибут

Описание

bytes_in

Количество принятых данных (в байтах)

bytes_out

Количество переданных данных (в байтах)

messages_in

Количество принятых сообщений

messages_out

Количество отправленных сообщений

•Элемент <connections /> содержит информацию о сетевых подключениях к Серверу Dr.Web.

Атрибуты элемента <connections />:

Атрибут

Описание

total

Общее количество разрешенных подключений

current

Количество активных подключений в данный момент

maximum

Зафиксированный максимум одновременных подключений

•Элемент <vm /> содержит информацию об использовании системных ресурсов на Сервере Dr.Web.

Атрибуты элемента <vm />:

Атрибут

Описание

context_switches

Количество переключений контекста

cpu_kernel

Время работы процессора в режиме ядра

cpu_user

Время работы процессора в режиме пользователя

page_faults

Количество ошибок страниц

read_cnt

Количество чтений из памяти

write_cnt

Количество записей в память

virtual_memory

Объем виртуальной памяти, выделенной для Сервера Dr.Web в данный момент (в мегабайтах)

threads

Количество запущенных потоков

working_set

Рабочий набор (в мегабайтах)

•Элемент <db /> содержит информацию об использовании базы данных Сервера Dr.Web.

Атрибуты элемента <db />:

Атрибут

Описание

rows_read

Количество прочитанных строк

rows_written

Количество записанных строк

statements_fail

Количество неуспешных операторов

statements_ok

Количество успешных операторов

transactions_rolledback

Количество отмененных транзакций

transactions_comitted

Количество завершенных транзакций

•Элемент <repository /> содержит информацию о репозитории Сервера Dr.Web.

Атрибуты элемента <repository />:

Атрибут

Описание

bytes_in

Количество принятых данных (в байтах)

bytes_out

Количество переданных данных (в байтах)

files_added

Количество новых файлов

files_deleted

Количество удаленных файлов

files_replaced

Количество замененных файлов

http_fail

Количество неуспешных HTTP-запросов

http_ok

Количество успешных HTTP-запросов

•Элемент <cache /> содержит информацию об использовании кеша.

▫Элемент <dns /> содержит информацию об использовании DNS-кеша.

Атрибуты элемента <dns />:

Атрибут

Описание

hit

Количество попаданий кеша

missed

Количество промахов кеша

size

Текущий размер кеша

▫Элемент <file /> содержит информацию об использовании файлового кеша.

Атрибуты элемента <file />:

Атрибут

Описание

hit

Количество попаданий кеша

max_msize

Максимальный размер кеша (в килобайтах)

max_vsize

Максимальный виртуальный размер кеша (в килобайтах)

vsize

Виртуальный размер кеша (в килобайтах)

missed

Количество промахов кеша

msize

Текущий размер кеша (в килобайтах)

▫Элемент <mcastupdate /> содержит информацию об использовании кеша при передаче групповых обновлений.

Атрибуты элемента <mcastupdate />:

Атрибут

Описание

bytes_in

Количество принятых данных (в байтах)

bytes_out

Количество переданных данных (в байтах)

packets_in

Количество принятых пакетов

packets_out

Количество переданных пакетов

▫Элемент <repository /> содержит информацию об использовании кеша репозитория.

Атрибуты элемента <repository />:

Атрибут

Описание

hit

Количество попаданий кеша

max_msize

Максимальный размер кеша

max_vsize

Максимальный виртуальный размер кеша

missed

Количество промахов кеша

msize

Текущий размер кеша

vsize

Виртуальный размер кеша

•Элемент <load-average /> содержит среднее значение загрузки системы за определенный период.

▫Вложенные элементы элемента <load-average />:

Элемент

Описание

<load1 />

Процент загрузки системы за 1 минуту

<load5 />

Процент загрузки системы за 5 минут

<load15 />

Процент загрузки системы за 15 минут

Среднее значение загрузки системы вычисляется только для устройств под управлением UNIX-подобных операционных систем. Для операционной системы Windows всегда возвращается значение "-1".

•Элемент <memory /> содержит информацию об оперативной памяти на Сервере Dr.Web.

▫Вложенные элементы элемента <memory />:

Элемент

Описание

<total />

Общий объем оперативной памяти (в мегабайтах)

<free />

Объем свободной оперативной памяти (в мегабайтах)

<used-by-server />

Объем оперативной памяти, используемой Сервером Dr.Web (в мегабайтах)

•Элемент <fd /> содержит информацию об открытых файлах на Сервере Dr.Web.

▫Вложенные элементы элемента <fd />:

Элемент

Описание

<opened />

Количество открытых файлов на Сервере Dr.Web

<soft-limit />

Рекомендуемое ограничение количества открытых файлов

<hard-limit />

Жесткое ограничение количества открытых файлов

Ограничения количества открытых файлов актуальны только для устройств под управлением UNIX-подобных операционных систем.

Ответ в формате JSON

{ "head": {

    "status": true,

    "timestamp": 1587044649,

    "api": {

      "version": 40302,

      "versionString": "4.3.2"},

    "server": {

      "name": "192.168.10.126",

      "version": "13.00.1.202310121",

      "uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},

"data": {

    "usage": {

      "alert": {

          "failed": 0,

          "sent": 3502,

          "size": 3135989,

          "total": 3502},

      "cache": {

          "dns": {

            "hit": 198,

            "missed": 254},

             "size": 1},

          "file": {

            "hit": 2754,

            "max_msize": 386713,

            "max_vsize": 386713,

            "missed": 48,

            "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": 75,

          "soft_limit": 131170},

      "load_average": {

          "load1": 1.12,

          "load15": 0.35,

          "load5": 0.72},

      "memory": {

          "free": 827,

          "total": 3753,

          "used_by_server": 11},

      "repository": {

          "bytes_in": 1408068,

          "bytes_out": 543472,

          "files_added": 0,

          "files_deleted": 0,

          "files_replaced": 0,

          "http_fail": 1287,

          "http_ok": 0},

      "vm": {

          "context_switches": 76622,

          "cpu_kernel": 3667637600,

          "cpu_user": 14959185200,

          "page_faults": 1248427,

          "read_cnt": 8,

          "threads": 48,

          "virtual_memory": 1180983296,

          "working_set": 100864000,

          "write_cnt": 977744}}}}

Описание параметров ответного JSON

Блок usage содержит информацию по использованию ресурсов Сервера Dr.Web.

Элементы блока usage:

Название поля

Описание

alert

Блок с информацией об уведомлениях Сервера Dr.Web

cache

Блок с информацией об использовании кеша

client

Блок с информацией о клиентах, подключенных к Серверу Dr.Web

cluster

Блок с информацией о кластере Серверов Dr.Web

connect

Блок с информацией о сетевых подключениях к Серверу Dr.Web

db

Блок с информацией об использовании базы данных Сервера Dr.Web

fd

Блок с информацией об открытых файлах на Сервере Dr.Web

load_average

Блок с информацией о среднем значении загрузки системы за определенный период

memory

Блок с информацией об оперативной памяти на Сервере Dr.Web

repository

Блок с информацией о репозитории Сервера Dr.Web

vm

Блок с информацией об использовании системных ресурсов на Сервере Dr.Web

•Элементы блока alert:

Название поля

Описание

failed

Количество неотправленных уведомлений

sent

Количество успешно отправленных уведомлений

size

Общий размер сгенерированных уведомлений (в килобайтах)

total

Общее количество сгенерированных уведомлений

•Элементы блока cache:

Название поля

Описание

dns

Блок с информацией об использовании DNS-кеша

file

Блок с информацией об использовании файлового кеша

mcastupdate

Блок с информацией об использовании кеша при передаче групповых обновлений

repository

Блок с информацией об использовании кеша репозитория

▫Элементы блока dns:

Название поля

Описание

hit

Количество попаданий кеша

missed

Количество промахов кеша

size

Текущий размер кеша

▫Элементы блока file:

Название поля

Описание

hit

Количество попаданий кеша

max_msize

Максимальный размер кеша (в килобайтах)

max_vsize

Максимальный виртуальный размер кеша (в килобайтах)

missed

Количество промахов кеша

msize

Текущий размер кеша (в килобайтах)

vsize

Виртуальный размер кеша (в килобайтах)

▫Элементы блока mcastupdate:

Название поля

Описание

bytes_in

Количество принятых данных (в байтах)

bytes_out

Количество переданных данных (в байтах)

packets_in

Количество принятых пакетов

packets_out

Количество переданных пакетов

▫Элементы блока repository:

Название поля

Описание

hit

Количество попаданий кеша

max_msize

Максимальный размер кеша

max_vsize

Максимальный виртуальный размер кеша

missed

Количество промахов кеша

msize

Текущий размер кеша

vsize

Виртуальный размер кеша

•Элементы блока client:

Название поля

Описание

agents

Количество подключенных Агентов

consoles

Количество подключенных Центров управления

installs

Количество установок Агента, запущенных в данный момент

links

Количество связанных соседних Серверов Dr.Web

newbies

Количество новичков

proxies

Количество Прокси-серверов Dr.Web

•Элементы блока cluster:

Название поля

Описание

bytes_in

Количество принятых данных (в байтах)

bytes_out

Количество переданных данных (в байтах)

messages_in

Количество принятых сообщений

messages_out

Количество отправленных сообщений

•Элементы блока connect:

Название поля

Описание

current

Количество активных подключений в данный момент

maximum

Зафиксированный максимум одновременных подключений

total

Общее количество разрешенных подключений

•Элементы блока db:

Название поля

Описание

rows_read

Количество прочитанных строк

rows_written

Количество записанных строк

statements_fail

Количество неуспешных операторов

statements_ok

Количество успешных операторов

transactions_comitted

Количество завершенных транзакций

transactions_rolledback

Количество отмененных транзакций

•Элементы блока fd:

Название поля

Описание

hard_limit

Жесткое ограничение количества открытых файлов

opened

Количество открытых файлов на Сервере Dr.Web

soft_limit

Рекомендуемое ограничение количества открытых файлов

Ограничения количества открытых файлов актуальны только для устройств под управлением UNIX-подобных операционных систем.

•Элементы блока load_average:

Название поля

Описание

load1

Процент загрузки системы за 1 минуту

load15

Процент загрузки системы за 15 минут

load5

Процент загрузки системы за 5 минут

Среднее значение загрузки системы вычисляется только для устройств под управлением UNIX-подобных операционных систем. Для операционной системы Windows всегда возвращается значение "-1".

•Элементы блока memory:

Название поля

Описание

free

Объем свободной оперативной памяти (в мегабайтах)

total

Общий объем оперативной памяти (в мегабайтах)

used_by_server

Объем оперативной памяти, используемой Сервером Dr.Web (в мегабайтах)

•Элементы блока repository:

Название поля

Описание

bytes_in

Количество принятых данных (в байтах)

bytes_out

Количество переданных данных (в байтах)

files_added

Количество новых файлов

files_deleted

Количество удаленных файлов

files_replaced

Количество замененных файлов

http_fail

Количество неуспешных HTTP-запросов

http_ok

Количество успешных HTTP-запросов

•Элементы блока vm:

Название поля

Описание

context_switches

Количество переключений контекста

cpu_kernel

Время работы процессора в режиме ядра

cpu_user

Время работы процессора в режиме пользователя

page_faults

Количество ошибок страниц

read_cnt

Количество чтений из памяти

threads

Количество запущенных потоков

virtual_memory

Объем виртуальной памяти, выделенной для Сервера Dr.Web в данный момент (в мегабайтах)

working_set

Рабочий набор (в мегабайтах)

write_cnt

Количество записей в память