Адаптер InfluxDB ProLogger для ioBroker
Гибкий регистратор данных InfluxDB v2 с настраиваемыми группами логирования, поддержкой нескольких сегментов, триггерами на основе cron и триггерами при изменении.
Важно: Этот адаптер является регистратором данных только для записи . Он отправляет значения состояния ioBroker в InfluxDB v2 — он не считывает исторические данные обратно в ioBroker и не реализует стандартный интерфейс адаптера истории ioBroker. Если вам необходимо запросить сохраненные исторические данные в ioBroker (например, для графиков или скриптов) через
getHistoryВместо этого используйте официальный адаптер ioBroker InfluxDB .Цель этого адаптера — предоставить вам больше гибкости в способе записи данных в InfluxDB: вы можете определять несколько групп логирования с различными сегментами, типами триггеров (cron или on change), пользовательскими именами измерений, ключами полей и тегами — независимо от встроенной системы истории ioBroker.
Функции
- Несколько групп логирования — определите отдельные группы с различными сегментами InfluxDB и типами триггеров.
- Логирование на основе Cron — периодический сбор и пакетная запись данных (например, каждые 15 минут).
- Журналирование изменений — мгновенная запись данных в InfluxDB при изменении значения состояния (спонтанные записи).
- Несколько сегментов — каждая группа логирования может записывать данные в свой собственный сегмент InfluxDB.
- Протокол InfluxDB v2 Line Protocol — запись данных через собственный HTTP API с использованием протокола InfluxDB Line Protocol.
- Повторная попытка с экспоненциальной задержкой — настраиваемая логика повторных попыток при неудачных операциях записи.
- Зашифрованное хранение токенов — API-токен хранится в зашифрованном виде в базе данных ioBroker.
- Проверка соединения — проверьте подключение к InfluxDB непосредственно из административного интерфейса.
- Административный интерфейс — полностью настраивается через административный интерфейс ioBroker (конфигурация в формате JSON).
Требования
- ioBroker с js-controller >= 6.0.11
- ioBroker Admin >= 7.0.23
- Node.js >= 20
- Экземпляр InfluxDB v2
Конфигурация
1. Вкладка «Подключение»
Настройте подключение к InfluxDB v2:
| Параметр | Описание |
|---|---|
| Протокол | HTTP или HTTPS |
| Хозяин | Имя хоста или IP-адрес сервера InfluxDB (например,192.168.10.191 ) |
| Порт | Порт сервера InfluxDB (по умолчанию:8086 ) |
| Организация | Название вашей организации в InfluxDB |
| API-токен | API-токен InfluxDB (хранится в зашифрованном виде) |
Воспользуйтесь кнопкой «Проверить соединение» , чтобы убедиться в наличии подключения.
2. Вкладка «Группы журналов»
Определите одну или несколько групп ведения журналов. Каждая группа включает в себя:
| Параметр | Описание |
|---|---|
| Включено | Включить/отключить эту группу |
| Название группы | Уникальное название для этой группы (указанной в данных). |
| Ведро | Корзина InfluxDB для записи. |
| Тип триггера | Cron (periodic) илиOn Change |
| Выражение Cron | Расписание Cron (только для групп cron), например:*/15 * * * * |
| Партия | Включить пакетную запись (для групп cron) |
Примеры групп:
| Имя | Ведро | Курок | Крон |
|---|---|---|---|
| Betriebsstunden | iobroker | Крон | */15 * * * * |
| Спонтанверте | iob_spontanwerte | О переменах | - |
3. Вкладка «Точки данных»
Настройте, какие состояния ioBroker следует регистрировать. Каждая точка данных должна ссылаться на группу логирования:
| Параметр | Описание |
|---|---|
| Включено | Включить/отключить эту точку данных |
| Группа | Название группы для ведения журналов (должно совпадать с группой из вкладки 2). |
| Идентификатор объекта | Состояние ioBroker для чтения (используйте обозреватель объектов) |
| Измерение | Название измерения InfluxDB |
| Поле | Название поля InfluxDB |
| Теги | Теги InfluxDB вkey=value формат (например,area=kitchen,floor=eg ) |
Примеры точек данных:
| Группа | Идентификатор объекта | Измерение | Поле | Теги |
|---|---|---|---|---|
| Betriebsstunden | 0_userdata.0.Heizkessel | betriebssekunden | zaehlerstand | area=heizkessel |
| Спонтанверте | shelly.1.EM0.TotalActivePower | энергия | elektrische_leistung_haus | area=gesamtenergiebedarf |
4. Вкладка «Дополнительно»
| Параметр | Описание |
|---|---|
| Таймаут записи | Время ожидания HTTP-запроса в мс (по умолчанию: 5000) |
| Повторить попытку при ошибке | Повторная попытка записи с ошибками с экспоненциальной задержкой. |
| Максимальное количество повторных попыток | Максимальное количество попыток повтора (по умолчанию: 3) |
| Ведение отладочного журнала | Включить подробное отладочное логирование |
Как это работает
Группы Cron (периодическое логирование)
- С каждым интервалом cron адаптер считывает все настроенные значения состояния в группе.
- Значения отформатированы в соответствии с протоколом InfluxDB.
- Все строки записываются в InfluxDB пакетом за один HTTP POST-запрос.
Группы изменений (спонтанная регистрация)
- Адаптер подписывается на состояние ioBroker каждой точки данных.
- При изменении значения состояния новое значение немедленно записывается в InfluxDB.
- Каждое изменение запускает отдельный HTTP POST-запрос.
Протокол InfluxDB
Данные записываются с использованием протокола InfluxDB v2:
measurement,tag1=value1,tag2=value2 field=value
Пример:
betriebssekunden,area=heizkessel zaehlerstand=12345.6
energie,area=gesamtenergiebedarf elektrische_leistung_haus=4521.3
Миграция со скриптов ioBroker
Если вы в настоящее время используете JavaScript-скрипты ioBroker для ведения логов в InfluxDB, вы можете перейти на этот адаптер:
- Установите адаптер
- Настройте подключение к InfluxDB (используйте тот же хост, порт, организацию и токен).
- Создайте группы логирования, соответствующие настройкам вашего скрипта:
- Скрипты, использующие
on({ id: ..., val: true })с состоянием триггера -> Создать группу Cron - Скрипты, использующие
on({ id: objectId })Для каждого штата -> Создайте группу « При изменении»
- Скрипты, использующие
- Добавьте все точки данных из вашего
loggingTemplateмассивы - Отключите старые скрипты
- Убедитесь, что данные поступают в InfluxDB.
Скрипты вpackage.json
| Название скрипта | Описание |
|---|---|
build | Скомпилируйте исходный код TypeScript. |
watch | Скомпилируйте исходный код TypeScript и следите за изменениями. |
test:ts | Выполните тесты, определенные в*.test.ts файлы |
test:package | Гарантироватьpackage.json иio-package.json являются действительными |
test | Выполните минимальный тестовый запуск файлов пакета и ваших тестов. |
check | Выполните проверку типов вашего кода (без компиляции). |
lint | Запустите ESLint, чтобы проверить код на наличие ошибок форматирования и потенциальных багов. |
translate | Переведите тексты в адаптере на все необходимые языки. |
release | Создать новый релиз |
Changelog
1.1.0 (2026-06-26)
- (ioBroker-Bot) Adapter requires admin >= 7.8.23 now.
- (Simon Prosen) Reduced excess spacing in the admin UI header by keeping configuration tab labels on a single line
- (Simon Prosen) Spontaneous (on-change) writes are now buffered with a configurable flush window (default 5000ms, adjustable per bucket)
1.0.1 (2026-04-13)
- (Simon Prosen) Fixed ack handling for on-change writes so acknowledged updates are processed correctly
- (Simon Prosen) Improved admin UI responsiveness on small screens with scrollable tabs and more flexible layouts
- (Simon Prosen) Removed the batch-write toggle from the admin UI and enforce batching based on trigger type
- (Simon Prosen) Added and improved translations for additional languages in the admin UI
- (Simon Prosen) Moved admin UI packages to
devDependenciesand consolidated the project package setup - (Simon Prosen) Updated admin logo assets and added an SVG variant
- (Simon Prosen) Refreshed build, test, TypeScript, and dependency configuration from the current template and dependency updates
1.0.0 (2026-03-21)
- (Simon Prosen) InfluxDB v2.x support via native HTTP API with token-based authentication
- (Simon Prosen) Dual-mode logging: cron-based periodic collection and on-change real-time writes
- (Simon Prosen) Multiple logging groups with independent bucket, trigger type, and cron schedule
- (Simon Prosen) Configurable data points with custom measurement names, field keys, and InfluxDB tags
- (Simon Prosen) InfluxDB line protocol formatting with proper type handling for strings, booleans, and numbers
- (Simon Prosen) Batch writing for cron groups combining all data points into a single HTTP request
- (Simon Prosen) Exponential backoff retry logic with smart classification (4xx no-retry, 429/5xx retry)
- (Simon Prosen) Configurable write timeout and retry attempts
- (Simon Prosen) Encrypted API token storage using ioBroker's native encryption
- (Simon Prosen) Connection health check on startup with
info.connectionstate indicator - (Simon Prosen) Admin UI with Connection, Logging Groups, Data Points, and Advanced tabs
- (Simon Prosen) Object browser for visual ioBroker state selection in admin UI
- (Simon Prosen) Connection test button for validating InfluxDB connectivity from admin UI
- (Simon Prosen) Cascading group rename updates across all referencing data points
- (Simon Prosen) Startup validation with warnings for missing or misconfigured groups and data points
- (Simon Prosen) Graceful shutdown with cron job cleanup and subscription removal
- (Simon Prosen) Debug logging mode for troubleshooting
- (Simon Prosen) English and German translations
0.0.1 (2026-03-20)
- (Simon Prosen) initial release
License
MIT License
Copyright (c) 2026 Simon Prosen simon@prosen.dev
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.