Сборка лог-журналов

Запросы

HTTP verb Endpoint Описание

GET

/api/monitor/v1/log/read

Получение списка лог файлов

GET

/api/monitor/v1/log/collect

Сбор логов ролей

GET

/api/monitor/v1/log/collect_multi

Сбор логов ролей (по списку)

Получение списка лог файлов

Тип домена: любой

Получение списка относительных путей до лог файлов по нодам. В мастер домене возвращает все доступные лог-файлы. В рабочем домене возвращает лог-файлы доступные для текущего домена.

Запрос

Table 1. Параметры запроса
Спецификация Описание

Имя: site
Тип: str
По умолчанию: все сайты

Фильтр по сайту.

Имя: node
Тип: str
По умолчанию: все ноды

Фильтр по ноде. Допускается указание полного имени (с адресом) или короткого имени (до @).

Имя: start
Тип: int
По умолчанию: 10

Количество минут в прошлое.

Имя: duration
Тип: int
По умолчанию: 10

Продолжительность лога для включения файла в список на выдачу. Возможные значения от 1 до 1440.

Пример запроса
GET /api/monitor/v1/log/read?site=central&node=b2bua1@192.168.0.84 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK

{
  "resultcode": 0,
  "resultmsg": "OK",
  "data": {
    "central": {
      "b2bua1@192.168.0.84": [ (1)
        "/configurator/cfg_2019-11-22.0000.log",
        "/env/env_2019-11-22.0000.log",
        "/env/wtc_2019-11-22.0000.log",
        "/error_logger/info_2019-11-22.0000.log",
        "/log/log_2019-11-22.0000.log",
        "/rpc/rpci_2019-11-22.0000.log",
        "/rpc/rpco_2019-11-22.0000.log",
        "/sip/callid_2019-11-22.0000.log",
        "/sip/cdr_2019-11-22.0000.log",
        "/sip/media_2019-11-22.0000.log",
        "/sip/mgct_2019-11-22.0000.log",
        "/sip/sip_2019-11-22.0000.log",
        "/sip/trn_2019-11-22.0000.log"
      ],
      "logstore": [ (2)
        "/conf1@192.168.0.84.node/log/sip/sip_2019-11-21.0000.log"
      ]
    }
  }
}
1 – список путей до лог файлов на запрашиваемой ноде.
2 <logstore> – список логов в хранилище logstore.

Сбор логов ролей

Тип домена: любой

Сбор логов по указанной маске. В мастер домене доступны все лог-файлы, в рабочем только относящиеся к домену.

Запрос

Table 2. Параметры запроса
Спецификация Описание

Имя: logs
Тип: str

Маска запрашиваемых логов в формате <Нода>/<Категория лога>/<Тип лога>.

  • <node> – нода. Допускается указание полного имени (с адресом) или короткого имени (до @).

  • <log_category> – категория логов, каталог в котором хранятся непосредственно лог-файлы.

  • <log_type> – тип лога, префикс в имени лог-файла

В качестве каждого из элементов маски можно подставить *, в этом случае будут собраны все логи подходящие под указанный фильтр.
Например: */*/* - сбор всех логов со всех ролей системы.
Чем шире фильтр, тем дольше процесс сборки и больше размер файла логов.

Имя: site
Тип: str
По умолчанию: все сайты

Фильтр по сайту.

Имя: start
Тип: int
По умолчанию: 10

Количество минут в прошлое.

Имя: duration
Тип: int
По умолчанию: 10

Продолжительность лога для сборки в минутах. Возможные значения от 1 до 1440.

Пример запроса
GET /api/monitor/v1/log/collect?site=central&logs=b2bua1@192.168.0.84/sip/trn&start=15&duration=5 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK

<content> (1)
1 <content> – результат в формате *.zip, который содержит лог файлы.

Сбор логов ролей (по списку)

Тип домена: любой

Сбор логов по указанному списку. В мастер домене доступны все лог-файлы, в рабочем только относящиеся к домену.

Запрос

Table 3. Параметры запроса
Спецификация Описание

Имя: logs
Тип: array<str>

Список запрашиваемых логов в формате <Нода>/<Категория лога>/<Тип лога>.

  • <node> – нода. Допускается указание полного имени (с адресом) или короткого имени (до @).

  • <log_category> – категория логов, каталог в котором хранятся непосредственно лог-файлы.

  • <log_type> – тип лога, префикс в имени лог-файла

В качестве каждого из элементов маски можно подставить *, в этом случае будут собраны все логи подходящие под указанный фильтр.
Например: */*/* - сбор всех логов со всех ролей системы.
Чем шире фильтр, тем дольше процесс сборки и больше размер файла логов.

Имя: site
Тип: str
По умолчанию: все сайты

Фильтр по сайту.

Имя: start
Тип: int
По умолчанию: 10

Количество минут в прошлое.

Имя: duration
Тип: int
По умолчанию: 10

Продолжительность лога для сборки в минутах. Возможные значения от 1 до 1440.

Пример запроса
GET /api/monitor/v1/log/collect?site=central&logs=["b2bua1@192.168.0.84/sip/trn","b2bua1/env/env"]&start=15&duration=5 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 200 OK

<content> (1)
1 <content> – результат в формате *.zip, который содержит лог файлы.