A small end-to-end prober and Prometheus stats exporter for a Matrix homeserver
  • Perl 91.4%
  • Dockerfile 8.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2023-10-26 11:00:35 +01:00
.github/workflows Remove PUSH 2023-10-26 11:00:35 +01:00
.dockerignore Use perl:5 base image 2019-09-03 18:38:32 +03:00
.gitignore Add Dockerfile and some readme instructions 2019-09-03 11:13:43 +03:00
cpanfile Add IO::Async::SSL to dependencies 2019-07-24 16:07:49 +03:00
Dockerfile Revert back to dockerhub 2023-10-24 11:21:39 +01:00
install-deps.pl Fix reference to cpanfile in install-deps.pl 2019-07-24 16:08:16 +03:00
LICENSE Create LICENSE 2019-08-29 11:36:34 +03:00
mon.pl Room version 6 enforces canonical json for events where JSON numbers must be integers. The CS spec also suggests that txIds should be strings 2020-11-18 15:32:17 +00:00
mon.yaml.example Allow using access_token 2020-02-25 12:53:09 +02:00
README.md Revert changes 2023-10-24 11:28:49 +01:00

matrixmon

A small end-to-end prober and Prometheus stats exporter for a Matrix homeserver.

Running

Make a copy of the configuration template:

cp mon.yaml.example mon.yaml

Edit mon.yaml with the correct details regarding your homeserver, monitor user, access token and room ID.

Optionally edit the port and other values, if needed.

By default, Matrixmon expects the config file to be found in the same path where it runs. A custom config file location (full path to file including file name) can be set with the environment variable MATRIXMON_CONFIG_PATH.

Using Docker

docker run -ti matrixdotorg/matrixmon -v $PWD/mon.yaml:/app/mon.yaml -p 9091:9091

Manually

On Debian/Ubuntu, example:

To build:

sudo apt-get install perl cpanminus build-essential libssl-dev zlib1g-dev
./install-deps.pl

To run:

perl mon.pl

Metrics

Prometheus metrics are by default exposed at http://localhost:9091/metrics.

License

Apache 2.0