https://github.com/llaumgui/nextcloud2prom
Convert a Nextcloud monitoring in JSON to prom textfile
https://github.com/llaumgui/nextcloud2prom
nextcloud prometheus-metrics python python3 systemd systemd-service systemd-timer
Last synced: 28 days ago
JSON representation
Convert a Nextcloud monitoring in JSON to prom textfile
- Host: GitHub
- URL: https://github.com/llaumgui/nextcloud2prom
- Owner: llaumgui
- License: gpl-2.0
- Created: 2024-09-04T12:56:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-30T08:49:50.000Z (4 months ago)
- Last Synced: 2026-01-31T00:29:29.368Z (4 months ago)
- Topics: nextcloud, prometheus-metrics, python, python3, systemd, systemd-service, systemd-timer
- Language: Python
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Nextcloud to prom
> [!WARNING]
> Metrics is now a Nextcloud (>=33) feature. Please [use standard endpoint](https://docs.nextcloud.com/server/latest/admin_manual/configuration_monitoring/index.html).
[![Author][ico-bluesky]][link-bluesky]
[![Software License][ico-license]](LICENSE)
Get Nextcloud server's info in JSON and convert to [node_exporter textfile format](https://github.com/prometheus/node_exporter?tab=readme-ov-file#textfile-collector).
## Install
### On Nextcloud
* Make sur that application server info is enable:
```bash
https://domain.ltd/settings/admin/serverinfo
```
* Set a token:
```bash
occ config:app:set serverinfo token --value MY_TOKEN
```
### On your server
* Create folder /var/lib/prometheus/node-exporter
```bash
mkdir /var/lib/prometheus/node-exporter
chown prometheus:prometheus /var/lib/prometheus/node-exporter
```
* Allow collect textfiles from it:
```bash
cat /etc/default/node_exporter
NODE_EXPORTER_OPTS="--collector.textfile.directory=/var/lib/prometheus/node-exporter"
```
* Get scripts:
```bash
cd /tmp
git clone https://github.com/llaumgui/nextcloud2prom.git
cd nextcloud2prom
```
* Install requirements from `dnf`, `apt`, etc. Or use `pip`:
```bash
pip install -r requirements.txt
```
* Install scripts:
```bash
cp prom_nextcloud.py /usr/local/bin
chmod +x /usr/local/bin/prom_nextcloud.py
cp system.d/prom* /etc/systemd/system
```
* Edit /etc/systemd/system/prom-nextcloud.service with your `NC_URL` and `NC_TOKEN` informations.
* Check:
```bash
systemd-analyze verify /etc/systemd/system/prom-nextcloud*
systemctl start prom-nextcloud.service
```
* and start systemd:
```bash
systemctl start prom-nextcloud.timer
systemctl enable prom-nextcloud.timer
```
## Develop
```bash
python -m venv env
source env/bin/activate
pip install -r requirements.txt
```
[ico-bluesky]: https://img.shields.io/static/v1?label=Author&message=llaumgui&color=208bfe&logo=bluesky&style=flat-square
[link-bluesky]: https://bsky.app/profile/llaumgui.kulakowski.fr
[ico-version]: https://img.shields.io/docker/v/llaumgui/httpd?sort=semver&color=%2496ed&logo=docker&style=flat-square
[ico-license]: https://img.shields.io/github/license/llaumgui/nextcloud2prom?style=flat-square