Описание сервиса
Eltex-Bob - RESTful API сервис, предназначенный для выгрузки информации о ТД в формате JSON в систему мониторинга. По умолчанию, к сервису можно обратиться по порту 9190, выполнив GET-запрос.
Для получения информации о количестве и состоянии устройств, требуется доступ до БД MYSQL.
Для защиты от DDoS, сервис имеет собственный кеш, который позволяет не нагружать БД, список ТД сервис запрашивает раз в 1 час. Информация о доступности устройств, обновляется раз в минуту.
Доступные методы API:
- http://<<ip_address>>:<<port>>/GetAPList Список ТД в формате JSON
- http://<<ip_address>>:<<port>>/GetAPDetail/{MAC_ADDRESS} - Детализация информации по ТД
- http://<<ip_address>>:<<port>>/GetAPAvailable/{MAC_ADDRESS} - Доступность ТД
- http://<<ip_address>>:<<port>>/GetAPPerformance/{MAC_ADDRESS} - Метрики по ТД
Управление сервисом
Настройка Профиля юридических лиц в EMS
- В GUI EMS перейдите в таблицу Администрирование→Права и Пользователи→Профили юридических лиц и создайте новый профиль:
- В новом профиле укажите описание профиля клиента:
- Укажите параметры профиля клиента (для примера, ClientName) аналогично скриншоту.
- Перейдите в таблицу в таблицу Администрирование→Права и Пользователи→Домены и привяжите данный профиль к нужному вам домену, заполнив параметр ClientName, который будет отдаваться сервисом eltex-bob по запросу ТД в данном домене:
GetAPList
Предоставляет список ТД в формате JSON, который содержит:
- apID - MAC-адрес устройства;
- apName - имя устройства;
- grCity - город;
- grRegion - область/регион;
- vspAddress - адрес расположения ТД;
- apGroup - сформированное по справочнику месторасположение ТД;
- apRtcGroup - домен , в котором располагается устройство;
- Остальные параметры задаются в настройках профиля юридических лиц в EMS.
Пример:
{ "data": [ { "ClientName": "Тестовый офис" #Параметр клиента, настроенный в профиле юридических лиц для данного клиента "apGroup": "Какой-то банк/Такая-то область/Доп.офис №XXXX-XXXXX", "apID": "a8-f9-4b-b5-a4-a0", "grCity": "г.Волгоград, Какой-то район", "apRtcGroup": "Ug/Volgogradskiy_filial/Volgogradskaya_obl/Volgograd/Test_bank/XXXX-XXXX_pr-XXXXXXX_1X", "vspAddress": "4XXXX7, г.XXXXX, пр.XXXXXX, 1X", "apName": "test_ap_name_XXXX-XXXX_a8:f9:4b:b5:XX:XX", "grRegion": "Такая-то область" }, ] }
Возможные параметры запроса
- Стандартный запрос:
curl -L http://localhost:9190/GetAPList
- grTB - фильтр по полю grTB. При указании этого параметра в ответе от eltex-bob будут содержаться только те объекты, значение grTB которых совпадает с указанным. Если значение параметра пустое, фильтр будет игнорироваться.
пример запроса:
curl -L http://localhost:9190/GetAPList?grTB='Какой-то банк'
GetAPDetail
Детализация информации по ТД , которая содержит :
"ip" - IP-адрес устройства;
"city" - город для найденного ВСП из справочника;
"firmware-version" - версия ПО;
"serial-number" - серийный номер устройства;
"full-address" - полный адрес для найденного ВСП из справочника.
Остальные параметры задаются в настройках профиля юридических лиц в EMS.
Запрос:
curl -L http://localhost:9190/GetAPDetail/00:00:00:00:00:00
Ответ:
{ "ip": "192.168.6.18", "city": "г.Березовский", "firmware-version": "1.16.0.163", "serial-number": "WP010001XX", "full-address": "67XXXX, г.Олекминск, ул.XXXXXX, XXXXX", "ClientName": "Тестовый офис" #Параметр клиента, настроенный в профиле юридических лиц для данного клиента }
GetAPAvailable
Доступность ТД, которая содержит:
"available" - доступность ТД, где 0 - ТД доступна, 1 - ТД недоступна;
"uptime" - время доступности ТД, в секундах.
Запрос:
curl -L http://localhost:9190/GetAPAvailable/00:00:00:00:00:00
Ответ:
{ "available": 0, "uptime": 67370 }
GetAPPerformance
Метрики ТД, которые содержат:
"wifi_users" - количество подключенных пользователей.
Запрос:
curl -L http://localhost:9190/GetAPPerformance/00:00:00:00:00:00
Ответ:
{ "wifi_users": "5" }
Настройки
Для авторизации в сервисе доступно 2 способа:
- http-basic авторизация, включается в настройках сервиса;
- ACL-список в настройках конфигурации nginx, включается в конфигурационном файле nginx.
nginx и ACL
Для ограничения доступа к сервису по IP-адресу, можно выполнить настройку nginx сервера с помощью ACL. Access Control List добавляется в конфигурационный файл nginx, пример :
location /api { allow 192.168.1.3/24; allow 127.0.0.1; deny all; }
deny - IP-address, с которого запрещен доступ;
allow - IP-address, с которого разрешен доступ.
В примере, доступ с IP-адреса 192.168.1.3 и 127.0.0.1 разрешен, остальным запрещен.
Eсли используется nginx для доступа к сервису eltex-bob, то следует настроить проксирование:
server { listen 80; server_name bob; location /api/ { proxy_pass http://localhost:9190/; proxy_set_header Host $host; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Real-IP $remote_addr; proxy_redirect default; } }
/etc/eltex-bob/application.properties
Основной конфигурационный файл:
- Подключение к БД:
spring.datasource.url=r2dbc:mysql://localhost:3306/eltex_ems?useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC spring.datasource.username=javauser spring.datasource.password=javapassword
- Количество коннектов к БД. По умолчанию, сервис использует 10 коннектов до БД, при необходимости можно увеличить.
spring.datasource.hikari.maximum-pool-size=20
- Разделители октетов в мак-адресе (по умолчанию ":"):
mac.splitter=:
- Включение авторизации по логин-паролю, false - выключено:
auth.enabled=true
- Логин/пароль, для авторизации на сервисе bob:
auth.username=user auth.password=password
- Порт, который слушает сервис
server.port=9190
/etc/default/eltex-bob
Файл инициализации сервиса.
Параметры | Описание |
---|---|
JAVA_INIT_HEAP | Количество памяти, выделяемое на работу сервиса при старте. Рекомендуется выставлять равное JAVA_MAX_HEAP. |
JAVA_MAX_HEAP | Максимальное количество памяти, которое может зарезервировать сервис |
JAVA_OPTS | Дополнительные опции для запуска jvm |
/etc/eltex-bob/log4j2.xml
Настройки логирования сервиса.
- Максимально допустимый размер файла (при его превышении создается новый файл. а старый архивируется):
<Property name="maxSize" value="5MB"/>
- Максимальное количество архивных файлов, при его превышении наиболее старые файлы будут перезаписываться:
<Property name="maxCount" value="7"/>
- Базовая директория хранения логов:
<Property name="logDir" value="/var/log/eltex-bob"/>
- Блок настройки перенаправления логов в Graylog (уровень логирования, адрес, порт):
<Property name="gelfLevel">${env:GELF_LEVEL:-OFF}</Property> <Property name="gelfHost">${env:GELF_HOST:-udp:lab3-test.eltex.loc}</Property> <Property name="gelfPort">${env:GELF_PORT:-12201}</Property>
- Уровень логирования
<Root level="error">
Докеризация сервиса
Сервис может быть запущен в docker-контейнере. Для этого необходимо подготовить файл с переменными окружения .env и docker-compose.yml.
version: "3" services: bob: image: hub.eltex-co.ru/softwlc/eltex-bob:1.19-<tag> network_mode: host ports: - 9190:9190 volumes: - "/etc/eltex-bob/log4j2.xml:/etc/eltex-bob/log4j2.xml" - "/var/log/eltex-bob:/var/log/eltex-bob" environment: - spring.datasource.url=${BOB_DB_URL} - spring.datasource.username=${BOB_DB_USERNAME} - spring.datasource.password=${BOB_DB_PASSWORD} - service.profile.id=${BOB_CLIENT_PROFILE} - service.profile.fields=${BOB_CLIENT_PROFILE_FIELDS}
# common bob params BOB_DB_URL=r2dbc:mysql://<IP-address>:3306/eltex_ems?useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC #Адрес БД MySQL BOB_DB_USERNAME=javauser BOB_DB_PASSWORD=javapassword BOB_CLIENT_PROFILE=4 #ID профиля юридических лиц в EMS BOB_CLIENT_PROFILE_FIELDS=NewClient #Параметр клиента, настроенный в профиле юридических лиц для данного клиента
Файлы .env и docker-compose.yml должны находиться в одной папке. Контейнер запускается командой:
docker-compose up
Описание переменных (environment)
Звауск сервиса
- BOB_PORT - порт, на котором сервис будет работать внутри контейнера;
Подключение к БД (MySQL)
- BOB_DB_URL - URL для подключекния к БД MySQL;
- BOB_DB_USERNAME - Логин подключения к БД;
- BOB_DB_PASSWORD - Пароль подключения к БД;
- BOB_CLIENT_PROFILE - ID профиля юридических лиц в EMS;
- BOB_CLIENT_PROFILE_FIELDS - араметр клиента, настроенный в профиле юридических лиц для данного клиента.