Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trazfr/prometheus-nextcloud-exporter
Monitoring of a Nextcloud instance using the servinfo plugin
https://github.com/trazfr/prometheus-nextcloud-exporter
nextcloud prometheus prometheus-exporter
Last synced: 2 months ago
JSON representation
Monitoring of a Nextcloud instance using the servinfo plugin
- Host: GitHub
- URL: https://github.com/trazfr/prometheus-nextcloud-exporter
- Owner: trazfr
- License: mit
- Created: 2020-02-23T22:06:35.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T18:57:18.000Z (7 months ago)
- Last Synced: 2024-10-15T14:21:53.683Z (2 months ago)
- Topics: nextcloud, prometheus, prometheus-exporter
- Language: Go
- Homepage:
- Size: 79.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# prometheus-nextcloud-exporter
Monitoring of a Nextcloud instance using the servinfo plugin
## Purpose
This repository has been made to monitor a Nextcloud instance using Prometheus through the serverinfo plugin.
## Install
Having a working Golang environment:
```bash
go install github.com/trazfr/prometheus-nextcloud-exporter@latest
```
## Use
This program is configured through a JSON configuration file.
To run, just `prometheus-nextcloud-exporter config.json`
## Examples of configuration file
This configuration file sets the exporter:
- With a timeout of 20 seconds for each requests (default=`5`)
- To Listen to the port `9092` (default value=`:9091`)
- To connect to a Nextcloud instance:
- using HTTPS (you may also use `http`)
- with credentials: user is `myuser` and the password is `mypassword`
- the server is `cloud.example.com`
- it is using the default path for the serverinfo plugin: `/ocs/v2.php/apps/serverinfo/api/v1/info`
- and pass the 2 parameters `skipApps` and `skipUpdate` set to `false`
```json
{
"timeout": 20,
"nextcloud_url": "https://myuser:[email protected]",
"skip_apps": false,
"skip_update": false,
"listen": ":9092"
}
```
Another example where the Nextcloud is installed in the path `/mynextcloud`:
```json
{
"nextcloud_url": "https://anotheruser:[email protected]/mynextcloud"
}
```
Your server may have an exotic configuration and the serverinfo endpoints may be behind another path.
For instance if you have a reverse proxy which rewrites `/serverinfo` into `/ocs/v2.php/apps/serverinfo/api/v1/info`:
```json
{
"nextcloud_url": "https://anotheruser:[email protected]/serverinfo",
"append_default_serverinfo_path": false
}
```