feat: Initialize CryptPad Prometheus Exporter

Initialized a new Prometheus exporter for CryptPad with foundational setup including the creation of a `.gitignore` file, adding the MIT License, and a descriptive `README.md`. Developed the main functionality in `exporter.py` to expose the count of registered users as a Prometheus metric. Also, a `requirements.txt` file was set up with the necessary Python package.

This initial setup lays the groundwork for future enhancements and metrics to be added, making it easier to monitor CryptPad's usage. The decision to count registered users by their data folders mirrors CryptPad's own administrative dashboard approach, ensuring consistency in reported metrics.

The inclusion of the `.gitignore` file ensures that development environments remain clean, and by choosing the MIT License, the project is kept open and permissive for broad use and contribution.

2024-06-04 21:06:10 +02:00

755 B

Raw Blame History

CryptPad Prometheus Exporter

This is a simple Prometheus exporter for CryptPad. Currently it only exports the number of registered users, but it is still a work in progress.

Installation

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Usage

source venv/bin/activate
python exporter.py

Configuration

Currently, the exporter can only be configured by modifying the source code. The following variables can be changed:

PINS_DIR: The directory where the CryptPad pins are stored. Default: /srv/cryptpad/data/pins
PORT: The port the exporter listens on. Default: 8000

License

This project is licensed under the MIT License - see the LICENSE file for details.