Skip to main content

MQTT alert daemon with pluggable notification backends

Project description

mqtt-alerts

CI Docker Trivy PyPI version Python 3.10-3.13 License: MIT

mqtt-alerts logo

mqtt-alerts is a general-purpose MQTT alerting service. It subscribes to MQTT topics, evaluates threshold rules with hold times and hysteresis, persists alert state, and sends notifications through pluggable backends.

It works with mtr2mqtt, but it is not tied to mtr2mqtt. Any publisher that sends JSON payloads to MQTT can use this service.

Key Features

  • Multiple independent rules per sensor topic
  • Rule hold durations (for) and hysteresis support
  • Persistent alert lifecycle: pending, firing, acknowledged, resolved
  • SQLite-backed state and restart-safe acknowledgement tracking
  • Pluggable notification backends: telegram, ntfy, pushover
  • Automatic recovery notifications
  • Outbound-only acknowledgement polling (no public webhook required)

Supported Backends

  • telegram: push notifications with acknowledgement buttons (polled via Bot API)
  • ntfy: outbound push notifications
  • pushover: push notifications with emergency receipt acknowledgement support

Documentation

Quick Start

Install:

pip install mqtt-alerts

Run:

mqtt-alerts --config sample_config.yml

Container:

docker run --rm \
  -v "$(pwd)/sample_config.yml:/config/config.yml:ro" \
  -v "$(pwd)/state:/state" \
  tvallas/mqtt-alerts:latest \
  --config /config/config.yml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mqtt_alerts-0.4.1.tar.gz (35.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mqtt_alerts-0.4.1-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

Details for the file mqtt_alerts-0.4.1.tar.gz.

File metadata

  • Download URL: mqtt_alerts-0.4.1.tar.gz
  • Upload date:
  • Size: 35.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mqtt_alerts-0.4.1.tar.gz
Algorithm Hash digest
SHA256 8958e7144f4e3e252a65138436b9b8912f9981f44db1f491463199222e44d2d9
MD5 fabc56ae7fd6540fee738855fa478665
BLAKE2b-256 6a000a520e228d600f9c34b5d3a1ec89e5a8d9c2cc79ead39457f83a21ecad9e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtt_alerts-0.4.1.tar.gz:

Publisher: semantic_release.yml on tvallas/mqtt-alerts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mqtt_alerts-0.4.1-py3-none-any.whl.

File metadata

  • Download URL: mqtt_alerts-0.4.1-py3-none-any.whl
  • Upload date:
  • Size: 27.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mqtt_alerts-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3f48908dddac16005b6759917c87f8607ca27c42036fe0a19fea4c098e9d4a9b
MD5 fbd028be53fcc10ce4ce0a1339ebcaa7
BLAKE2b-256 3eec4e102a56af0d75b2168100f5db53b649f8ad49ad84edda3e0b2f1c42b72f

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtt_alerts-0.4.1-py3-none-any.whl:

Publisher: semantic_release.yml on tvallas/mqtt-alerts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page