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.5.tar.gz (36.8 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.5-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqtt_alerts-0.4.5.tar.gz
  • Upload date:
  • Size: 36.8 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.5.tar.gz
Algorithm Hash digest
SHA256 9f0906a576282fa82a3d8f507d3c799c92576d2cff880fd2f965db9bfe2e0ba9
MD5 f8c52d27320f315399e1ad773855468a
BLAKE2b-256 973e10cedc52928e2412cf0f7b67e9a673c9176be8716487a6c20b62d23c05b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtt_alerts-0.4.5.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.5-py3-none-any.whl.

File metadata

  • Download URL: mqtt_alerts-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 27.4 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9a5f03b89b18226f98e3d8a640013226c8c85b7f2a1cb4328e3e5d52ebbec06d
MD5 ff0f953d2940ec4ce6e818772eb5d8d3
BLAKE2b-256 2e85b29fa106d16556f7c2a3a603f76b9f29cbc4f5e649d38e075f9fb31ae4e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for mqtt_alerts-0.4.5-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