Skip to content

Справочник параметров событий, вебхуков и MQTT ​

Секции events, webhooks и mqtt в файле config.yaml управляют отправкой уведомлений в реальном времени и публикацией телеметрии в IoT-брокеры.


1. Блок параметров событий и уведомлений ​

yaml
# Настройки исходящих вебхуков
webhooks:
  enabled: true
  endpoints:
    - url: "https://api.example.com/v1/ruseon-webhook"
      secret: "replace_with_webhook_hmac_secret_key"
      events:
        - "camera.online"
        - "camera.offline"
        - "recording.segment_closed"
        - "ai.detection"
      timeout: "5s"
      max_retries: 3
      circuit_breaker:
        failure_threshold: 5
        cooldown_period: "60s"

# Настройки публикации телеметрии в MQTT
mqtt:
  enabled: true
  broker: "tcp://broker.emqx.io:1883"
  client_id: "ruseon_server_prod"
  topic_prefix: "ruseon"
  username: "mqtt_user"
  password: "mqtt_password"
  qos: 1
  retain_status: true
  queue_capacity: 5000
  tls:
    enabled: false
    ca_file: "/etc/ruseon/certs/ca.crt"
    cert_file: "/etc/ruseon/certs/client.crt"
    key_file: "/etc/ruseon/certs/client.key"

2. Таблица параметров вебхуков и MQTT ​

ПараметрТипПо умолчаниюОписание
webhooks.enabledbooleanfalseВключение отправки HTTP POST вебхуков
webhooks.endpoints[].urlstringОбязательноАдрес целевого HTTP/HTTPS сервера приёма
webhooks.endpoints[].secretstring""Ключ для подписи X-Ruseon-Signature HMAC-SHA256
webhooks.endpoints[].circuit_breakerobject—Защитный автомат для изоляции сбойных эндпоинтов
mqtt.enabledbooleanfalseВключение публикации телеметрии по MQTT
mqtt.brokerstring""Адрес брокера (tcp://... или ssl://...)
mqtt.qosinteger1Уровень доставки сообщений (0, 1 или 2)

Связанная документация ​

Released under the MIT License.