Настроить метрики web-сервисов

Docsvision позволяет настраивать и просматривать метрики в формате Prometheus для следующих web-сервисов:

  • Сервер приложений

  • Сервер Web-клиента

  • Основной процесс Управление процессами

  • Основной процесс Службы фоновых операций

Чтобы настроить метрики:
  1. Задайте настройку для метрик одним из поддерживаемых способов:

    • Откройте конфигурационный файл appsettings.json, например /usr/lib/docsvision/workerservice/appsettings.json для Linux и C:\Program Files\Docsvision\WorkerService\appsettings.json для Windows, и укажите следующие настройки:

      {
       "Metrics": {
          "Key": "secret-key"
        },
      }
      Если параметр отсутствует в конфигурационном файле, создайте его самостоятельно.
    • Только для Сервера приложений, Web-клиента и Управление процессами. На странице дополнительных настроек модуля в Консоли управления Docsvision укажите настройку Metrics__ApiKey.

  2. Метрики в формате Prometheus будут доступны по адресу https://адрес-сервиса:ПОРТ/metrics. В настройках подключения Prometheus к сервисам Docsvision должен быть указан заголовок X-Metrics-Key со значением ключа аутентификации из Metrics  Key в конфигурационном файле.