Skip to main content

Reticulum Monitoring Daemon

Project description

RNMon - Reticulum Application Monitoring Daemon

RNMon is a simple monitoring daemon designed to monitor the status of multiple RNS applications and push the metrics over http using the influx line protocol.

Supported Applications

  • Reticulum Transport Nodes (Also some metrics for non transport nodes)
  • LXMF Propagation Nodes

Installing

Package

The package is available in PyPI, install it with your python package manager of choice.

I recommend using uv since it cleanly manages an environment if you run or install it as a tool:

Execute it simply: uvx rnmon

Install it globally (but in its own environment): uv tool install rnmon and run rnmon

Container

There is a container image available at ghcr.io/lbataha/rnmon. You can use the latest tag, or specify the version matching the git tag you want, there are also image builds available in github actions.

The repo contains a Dockerfile and an example docker-compose.yml, but you can run it simply with:

docker run --name rnmon -v /path/to/config:/config ghcr.io/lbataha/rnmon:latest

Configuration

Configure the daemon via scraping.yaml, the example config has comments explaining the options.

The configuration for reticulum is auto-discovered, but you can specify the location of the configuration directory using the --rns-config argument.

Operational principles

The metric pusher and all targets are executed in their own thread. The main thread starts a new RNS instance, and closes it on exit.

A link is established for each scrape target to reduce network overhead. If a link is broken for any reason, the thread is terminated and restarted - this avoids having to deal with the built-in RNS link retry mechanisms, their associated timeouts and any edge cases caused by using shared RNS intances. This might be changed in the future if RNS fixes the issues particular to this use case.

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

rnmon-0.3.4.tar.gz (37.0 kB view details)

Uploaded Source

Built Distribution

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

rnmon-0.3.4-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file rnmon-0.3.4.tar.gz.

File metadata

  • Download URL: rnmon-0.3.4.tar.gz
  • Upload date:
  • Size: 37.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.21

File hashes

Hashes for rnmon-0.3.4.tar.gz
Algorithm Hash digest
SHA256 bf72f95530a102e7b3ba9f23040ee600f3026832f13ce441ac8716f50bf443a1
MD5 1369826f06d20db84257789a29084ca2
BLAKE2b-256 ff76f2f8ac12b3a18df1f18901007b051ca578f497df05bccd1d79295cffff7b

See more details on using hashes here.

File details

Details for the file rnmon-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: rnmon-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.21

File hashes

Hashes for rnmon-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ff567cfff7afec9e9e50224c7b579ba11f2138a22e71140c43c3e88e9295068a
MD5 f0b5d42080aedd24e7dd9454c95c6ab2
BLAKE2b-256 d53405b1e04e57d0b62e937207a80c5b0627fedac911b5ecb5a9b1cc1716bd79

See more details on using hashes here.

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