В API V2 (V1) и V3 доступна группа методов для проверки состояния системы Health:

• GET /api/v2/health — метод позволяет проверить состояние работоспособности сервиса — в результате будет получено текущее состояние работоспособности системы и БД:
  • Status — состояние работоспособности:
    • Unknown — неизвестно
    • OK — ок
    • Error — ошибка
  • DbStatus — состояние работоспособности БД:
    • Unknown — неизвестно
    • OK — ок
    • Error — ошибка
• GET api/v3/health — метод позволяет проверить количество ошибок и предупреждений в global.log, а также собрать статистику по времени обработки запросов и учитывать ее при анализе состояния Системы:
  • Метод недоступен для просмотра в Swagger из-за технических ограничений, поскольку отличается способ реализации метода
  • В файле приложения appsettings.json в секции HealthChecks доступно задать настройки API проверки состояния Системы:

 {
  "HealthChecks": {
    ...                                     //Прочие настройки HealthCheck
    "RequestProcessingTimeSettings": {      //секция настроек HealthCheck по статистике ошибок и предупреждений
      "Tracking": false,                    //отслеживание времени выполнения запроса
      "Range": "01:00:00",                  //время хранения статистики проверки времени обработки запросов. По умолчанию "01:00:00" (1 час)
      "Step": "00:01:00",                   //временной отрезок, за который будет подсчитываться статистика. По умолчанию "00:01:00" (минута)
      "MaxExecutionTime": "00:01:00",       //максимальное время выполнения запроса. По умолчанию "00:01:00" (минута)
      "CountForDegraded": 100,              //кол-во запросов, необходимое для получения статуса Degraded. По умолчанию 100
    }
  }

Ответ метода GET api/v3/health имеет следующий формат:

{
  "status": "Healthy",                      //общий статус всех проверок
  "totalDuration": "00:00:03.9302856",      //общая продолжительность всех проверок
  "entries": {                              //список всех проверок
    ...                                     //Прочие HealthCheck'и
    "requestProcessingTime": {              //HealthCheck'а проверки времени обработки запросов
      "data": {
        "longRequestCount": 0,              //кол-во запросов, выполнение которых превысило время, заданное в параметре MaxExecutionTime
      },
      "duration": "00:00:03.9293789",       //продолжительность выполнения HealthCheck'а статистики
      "status": "Healthy"//статус HealthCheck'а, в зависимости от настроек в appsettings
    },
  }
}

В API V3 доступна группа методов для получение логов — Logs с помощью метода GET /api/v3/logs/Get, который позволяет получить файл логов выполнения сценария автоматизации по параметрам:

• Логи остаются разделенными по дням.
• В выгружаемых логах содержатся логи, формируемые методом console.log().
• Метод позволяет также скачать:
  • WorkflowTrace.log — лог работы сценариев, куда записывается информация обо всех сработавших сценариях и их выполненных шагах (необходимый уровень Trace)
  • CaseDotStar.ServicePackages.Common.Scripts.ScriptInterpreterLogger.log — лог интерпретатора JS-скриптов, в который записываются все ошибки, возникающие при выполнении JS-скриптов, а также записи в консоль выполненные командой console.log (необходимый уровень Info)