https://github.com/matrix-org/matrixmon

A small end-to-end prober and Prometheus stats exporter for a Matrix homeserver
https://github.com/matrix-org/matrixmon

bot matrix monitoring prometheus

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/matrix-org/matrixmon
• Owner: matrix-org
• License: apache-2.0
• Created: 2016-01-19T19:14:13.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-26T10:01:16.000Z (about 1 year ago)
• Last Synced: 2024-11-04T07:48:12.375Z (about 1 month ago)
• Topics: bot, matrix, monitoring, prometheus
• Language: Perl
• Size: 41 KB
• Stars: 11
• Watchers: 30
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - matrix-org/matrixmon - A small end-to-end prober and Prometheus stats exporter for a Matrix homeserver (monitoring)

README

        
# matrixmon

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

## Running

Make a copy of the configuration template:

```bash

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

```bash

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

```

### Manually

On Debian/Ubuntu, example:

To build:

```bash

sudo apt-get install perl cpanminus build-essential libssl-dev zlib1g-dev

./install-deps.pl

``` 

To run:

```bash

perl mon.pl

```

## Metrics

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

## License

Apache 2.0