Сервер WNAM QoW отвечает за сбор и отображение информации, полученной в процессе взаимодействия с сенсорами. Настройки содержатся в файле application.properties, обычно расположенном в каталоге home/qow , указать расположение файла можно при запуске сервера при помощи параметра -Dspring.config.location.. При реализации сервера использована платформа spring.boot , ряд стандартных настроек обрабатывается и WNAM QoW, однако использовать их следует в строгом соответствии с инструкцией или с участием представителя WNAM,
Настраиваемые параметры
| Параметр | Значение по умолчанию | Описание |
|---|---|---|
spring.data.mongodb.host | localhost | Путь к серверу БД |
spring.data.mongodb.port | 27017 | Порт БД на сервере |
spring.data.mongodb.database | qow | Название схемы MongoDB, используемой WNAM QoW |
spring.web.locale | ru_RU | Локаль (не только язык, но и настройки форматов времени, даты, числовых разделителей) |
spring.web.locale-resolver | ||
spring.servlet.multipart.max-file-size | 10MB | Максимальный размер загружаемого файла |
spring.servlet.multipart.max-request-size | 10MB | Максимальный размер HTTP-запроса при загрузке файлов (multipart request) |
netams.deviceType | qos | qos, |
netams.licenseKey | Лицензионный ключ | |
netams.remoteToken | token для API-вызовов | |
netams.serverUri | URL сервера (может использоваться в автоматически сформированных адресах ссылок на страницах, в сообщения и т.п.) | |
netams.createDefaultAdmin | true | Создавать ли пользовательскую запись администратора с настройками по умолчанию |
netams.mqtt.serverUri | URL сервера Mosquitto (очереди) | |
netams.mqtt.clientId | Mosquitto clientId для подключения к очередям | |
netams.mqtt.handler.enabled | true/false - включен ли обработчик сообщений очереди | |
netams.mqtt.handler.doNotResponse | true/false - отдавать ли ответы в очередь | |
следующие 4 параметра носят служебный характер и нужны для тонкой настройки или определения проблем взаимодействия с MQTT | ||
| netams.mqtt.keep-alive-interval | 60 | Секунды. Определяет максимальный интервал, в течение которого между клиентом и сервером должны проходить сообщения для признания соединения действующим. Позволяет определить отсутствие связи не дожидаясь таймаута сетевого соединения. Если в течение этого периода сообщений не было, клиент отправит короткий ping, чтобы убедиться в доступности сервера. В случае установки значения 0, эта функция будет отключена. |
| netams.mqtt.connection-timeout | 20 | Секунды. Таймаут соединения. В случае установки в 0 - ожидание до момента обрыва соединения. |
| netams.mqtt.client.check-connect.initial-delay | 60000 | Милисекунды. Первоначальная задержка до начала опроса очереди сообщений. |
| netams.mqtt.client.check-connect.fixed-delay | 60000 | Милисекунды. Период проверки доступности очереди сообщений. |
spring.mail.host | SMTP host для электронной почты | |
spring.mail.port | SMTP port для электронной почты | |
spring.mail.username | SMTP user для электронной почты | |
spring.mail.password | SMTP пароль для электронной почты | |
spring.mail.properties.mail.smtp.auth | ||
spring.mail.properties.mail.smtp.starttls.enable | ||
netams.mail.from | обратный адрес для писем отправленных сервером по SMTP | |
netams.sms.provider | dummy, smsc | |
netams.sms.smsc.login | ||
netams.sms.smsc.password | ||
scheduled.health.check.devices.period | 15000 | Период вычисления состояния устройств (сенсоры и ТД) на основании данных пришедших от устройств. Не инициирует запросов напрямую устройствам, т.е. периодичность |
netams.initial.runInitialTasks | true | Запускать инициализацию данных при старте. Сервер умеет выполнять некоторые инициализационные задачи при старте, используется для автоматизации сервисных задач и обновления версий (актуализации данных в соответствие с программным кодом) |
com.netams.qos.initialize.tasks.create-collection-indexes.run-on-failed | true | Выполнять инициализационную задачу повторно при запуске сервера в случае ошибочного предыдущего исполнения (дать "второй шанс" упавшей задаче) |
netams.qos.report.pdf.filesBasePath | /home/qow/reports/pdf/ | Временный каталог для размещения файлов PDF-отчетов |
netams.mqtt.client.check-connect.initial-delay | 60000 | ms, первичная задержка проверки доступности MQTT (Очереди) |
netams.mqtt.client.check-connect.fixed-delay | 60000 | ms периодичность проверки доступности MQTT (Очереди) |
com.netams.database.ttl.seconds | null | На странице статистики БД есть возможность пересоздания TTL (time to live, глубина хранения), индексов для коллекций БД. Если задать этот параметр, вместо рекомендованных различных значений для разных коллекций, будет использовано это значение |
com.netams.qos.ntf.metric-notification.initial-delay | 60000 | Параметры для тонкой настройки периодов отправки оповещений о событиях (email, sms, telegram) |
com.netams.qos.ntf.metric-notification.fixed-delay | 20000 | Параметры для тонкой настройки периодов отправки оповещений о событиях (email, sms, telegram) |
netams.qos.measurements.metrics.dynamic.ping.disable | false | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Выставление этого значения в true отключит эту функцию. |
netams.qos.measurements.metrics.dynamic.ping.jitter.ok.max | 10 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать максимальное порог нормального значения динамической метрики для ping.jitter. |
netams.qos.measurements.metrics.dynamic.ping.jitter.warn.max | 100 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать максимальное порог "тревожного" значения динамической метрики для ping.jitter. |
netams.qos.measurements.metrics.dynamic.ping.jitter.fail.min | 100 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать минимальный порог "ошибочного" значения динамической метрики для ping.jitter. |
netams.qos.measurements.metrics.dynamic.ping.delay.ok.max | 50 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать максимальный порог нормального значения динамической метрики для ping.delay. |
netams.qos.measurements.metrics.dynamic.ping.delay.warn.max | 200 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать максимальный порог "тревожного" значения динамической метрики для ping.delay. |
netams.qos.measurements.metrics.dynamic.ping.delay.fail.min | 200 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать минимальный порог "ошибочного" значения динамической метрики для ping.delay. |
netams.qos.measurements.metrics.dynamic.ping.loss.ok.max | 1 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать максимальный порог нормального значения динамической метрики для ping.loss. |
netams.qos.measurements.metrics.dynamic.ping.loss.warn.max | 10 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать максимальный порог "тревожного" значения динамической метрики для ping.loss. |
netams.qos.measurements.metrics.dynamic.ping.loss.fail.min | 10 | При получении результатов измерений состояния сетей (WifiQuality, Quality) на основании данных из блока ping будут динамически добавлены метрики с префиксом "ping_" в названии. Данная настройка позволяет задать минимальный порог "ошибочного" значения динамической метрики для ping.loss. |
| netams.qos.distributives.filesBasePath | /home/qow/firmware/ | Путь для хранения файлов с ПО для сенсоров |
| com.netams.database.ttl.schedule.cron | - | CRON-выражение для планировщика, запускающего очистку "устаревших" данных. Время жизни данных настраивается на странице "Статистика БД" ссылкой в столбце "Глубина хранения". Примеры:
|
Настройки SSO на примере Yandex Id в качестве oauth-провайдера. При создании нескольких провайдеров (google, okta, github) тот же набор параметров с соответствующими названиями добавится для каждого сервера авторизации (см. Spring Security oauth2). | ||
| spring.security.oauth2.client.registration.yandex.provider | yandex | Идентификатор провайдера (сервера авторизации) |
| spring.security.oauth2.client.registration.yandex.client-id | Идентификатор клиента, выданный сервером авторизации при регистрации приложения | |
| spring.security.oauth2.client.registration.yandex.client-secret | Секретный код клиента, выданный сервером авторизации при регистрации приложения | |
| spring.security.oauth2.client.registration.yandex.redirect-uri | [your_https_URL]/login/oauth2/code/[provider] - URL для обратного вызова с сервера авторизации в процессе выдачи токена доступа | |
| spring.security.oauth2.client.registration.yandex.authorization-grant-type | authorization_code | Должно быть authorization_code. Остальные authorization flows не проверялись и не поддерживаются. |
| spring.security.oauth2.client.registration.yandex.client-name | Yandex | Название провайдера (сервера авторизации), отображаемое на странице логина |
| spring.security.oauth2.client.provider.yandex.authorization-uri | URL сервера авторизации (для Яндекса - https://oauth.yandex.ru/authorize) | |
| spring.security.oauth2.client.provider.yandex.token-uri | URL для получения токенов доступа (для Яндекса - https://oauth.yandex.ru/token) | |
| spring.security.oauth2.client.provider.yandex.user-name-attribute | default_email | Название атрибута oauth или OpenIDC , который будет использован в качестве идентификатора пользователя QoW. Со стороны QoW должен совпасть с логином или email-ом. |
| spring.security.oauth2.client.provider.yandex.user-info-uri | URL для получения атрибутов авторизованного пользователя (для Яндекса - https://login.yandex.ru/info) | |
| netams.qos.logfiles.filesBasePath | /home/qow/logs/ | Путь к каталогу с файлами логов на сервере QoW. Используется для доступа к файлам логов через UI сервера. |