Eltex-Bob - RESTful API сервис, предназначенный для выгрузки информации о ТД в формате JSON в систему мониторинга. По умолчанию, к сервису можно обратиться по порту 9190, выполнив GET-запрос.
Для получения информации о количестве и состоянии устройств, требуется доступ до БД MYSQL.
Для защиты от DDoS, сервис имеет собственный кеш, который позволяет не нагружать БД, список ТД сервис запрашивает раз в 1 час. Информация о доступности устройств, обновляется раз в минуту.
Доступные методы API:
Предоставляет список ТД в формате JSON, который содержит:
Пример:
{ "data": [ { "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 |
curl -L http://localhost:9190/GetAPList?grTB='Какой-то банк' |
Детализация информации по ТД , которая содержит :
"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" } |
Доступность ТД, которая содержит:
"available" - доступность ТД, где 0 - ТД доступна, 1 - ТД недоступна;
"uptime" - время доступности ТД, в секундах.
Запрос:
curl -L http://localhost:9190/GetAPAvailable/00:00:00:00:00:00 |
Ответ:
{ "available": 0, "uptime": 67370 } |
Метрики ТД, которые содержат:
"wifi_users" - количество подключенных пользователей.
Запрос:
curl -L http://localhost:9190/GetAPPerformance/00:00:00:00:00:00 |
Ответ:
{ "wifi_users": "5" } |
Для авторизации в сервисе доступно 2 способа:
Для ограничения доступа к сервису по 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; } } |
Основной конфигурационный файл:
# The Datasource Mysql properties spring.application.name=bob 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 spring.datasource.hikari.maximum-pool-size=20 service.profile.id=3 service.profile.fields=office,company spring.mvc.favicon.enabled=false mac.splitter=: auth.enabled=false auth.username=user auth.password=password server.port=9190 |
spring.datasource.url=jdbc:mysql://localhost:3306/eltex_ems?useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC spring.datasource.username=javauser spring.datasource.password=javapassword |
spring.datasource.hikari.maximum-pool-size=20 |
mac.splitter=: |
auth.enabled=true |
auth.username=user auth.password=password |
server.port=9190 |
Файл инициализации сервиса.
# AP Monitoring service # Initial size of Java heap JAVA_INIT_HEAP=128m # Maximum size of Java heap JAVA_MAX_HEAP=256m # Additional arguments to pass to java JAVA_OPTS="-XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=/var/log/eltex-bob" |
Параметры | Описание |
---|---|
JAVA_INIT_HEAP | Количество памяти, выделяемое на работу сервиса при старте. Рекомендуется выставлять равное JAVA_MAX_HEAP. |
JAVA_MAX_HEAP | Максимальное количество памяти, которое может зарезервировать сервис |
JAVA_OPTS | Дополнительные опции для запуска jvm |
Настройки логирования сервиса.
<?xml version="1.0" encoding="UTF-8"?> <Configuration> <Properties> <Property name="maxSize" value="5MB"/> <Property name="maxCount" value="7"/> <Property name="logDir" value="/var/log/eltex-bob"/> <Property name="defaultPattern" value="%d{ISO8601} [%t] %-5p %logger{1} %C{1}.%M(line:%L). %m%n"/> <Property name="gelfHost" value="udp:lab3-test.eltex.loc"/> <Property name="gelfPort" value="12201"/> <Property name="gelfLevel" value="OFF"/> <Property name="filenamePrefix" value="eltex-bob"/> </Properties> <Appenders> <Console name="STDOUT" target="SYSTEM_OUT"> <PatternLayout> <Pattern>${defaultPattern}</Pattern> </PatternLayout> </Console> <RollingFile name="SPRING-INFO" fileName="${logDir}/${filenamePrefix}-spring.log" filePattern="${logDir}/%d{yyyyMMdd}.%i.log"> <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/> <PatternLayout> <pattern>${defaultPattern}</pattern> </PatternLayout> <Policies> <SizeBasedTriggeringPolicy size="${maxSize}"/> </Policies> <DefaultRolloverStrategy max="${maxCount}"/> </RollingFile> <RollingFile name="SERVICE-ERROR" fileName="${logDir}/${filenamePrefix}-error.log" filePattern="${logDir}/%d{yyyyMMdd}.%i.log"> <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/> <PatternLayout> <pattern>${defaultPattern}</pattern> </PatternLayout> <Policies> <SizeBasedTriggeringPolicy size="${maxSize}"/> </Policies> <DefaultRolloverStrategy max="${maxCount}"/> </RollingFile> <RollingFile name="SERVICE-INFO" fileName="${logDir}/${filenamePrefix}-info.log" filePattern="${logDir}/%d{yyyyMMdd}.%i.log"> <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY"/> <PatternLayout> <pattern>${defaultPattern}</pattern> </PatternLayout> <Policies> <SizeBasedTriggeringPolicy size="${maxSize}"/> </Policies> <DefaultRolloverStrategy max="${maxCount}"/> </RollingFile> <Gelf name="Gelf" host="${gelfHost}" port="${gelfPort}" version="1.1" facility="${filenamePrefix}" extractStackTrace="true" originHost="%host{fqdn}" maximumMessageSize="8192" > <Field name="thread" pattern="%t" /> <Field name="level" pattern="%level" /> <Field name="severity" pattern="%-5level" /> <Field name="logger" pattern="%logger{1}" /> <Field name="location" pattern="%C{1}.%M(line:%L)" /> </Gelf> </Appenders> <Loggers> <Logger name="org.springframework" level="info" additivity="false"> <AppenderRef ref="SPRING-INFO"/> </Logger> <Logger name="org.eltex.softwlc.bob" level="error" additivity="false"> <AppenderRef ref="SERVICE-ERROR"/> </Logger> <Logger name="org.eltex.softwlc.bob" level="info" additivity="false"> <AppenderRef ref="SERVICE-INFO"/> </Logger> <Root level="error"> <AppenderRef ref="Gelf" level="${gelfLevel}"/> </Root> </Loggers> </Configuration> |
<Property name="maxSize" value="5MB"/> |
<Property name="maxCount" value="7"/> |
<Property name="logDir" value="/var/log/eltex-bob"/> |
<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} |
Вместо <tag> необходимо указать актуальную версию, которую можно посмотреть по ссылке. |
# common bob params BOB_DB_URL=jdbc:mysql://<IP-address>:3306/eltex_ems?useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=UTC BOB_DB_USERNAME=javauser BOB_DB_PASSWORD=javapassword BOB_CLIENT_PROFILE=3 BOB_CLIENT_PROFILE_FIELDS=office,company |
Файлы .env и docker-compose.yml должны находиться в одной папке. Контейнер запускается командой:
docker-compose up |