nextcloud / nextcloud/serverinfo
Export more metrics via ocs/v2.php/apps/serverinfo/api/v1/info
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 130
- Forks
- 64
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 49
Description
How to use GitHub
- Please use the 👍 reaction to show that you are interested into the same feature.
- Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
- Subscribe to receive notifications on status change and new comments.
Is your feature request related to a problem? Please describe.
I want to have a general overview of Nextcloud usage via Grafana/Prometheus + nextcloud-exporter.
But the data coming from the API /ocs/v2.php/apps/serverinfo/api/v1/info lak at least one very useful information : the storage used, even if primary storage is on an external S3 system.
I don't know if it's possible to go further and add storage by user (perhaps not in that general API but associated with the app https://apps.nextcloud.com/apps/user_usage_report)
Perhaps that's what should be in the actual num_storages_other metric ?
Describe the solution you'd like
I'd like to see global storage usage in /ocs/v2.php/apps/serverinfo/api/v1/info, not only for local storage.
Describe alternatives you've considered
I'm in the process of trying an SQL query Prometheus exporter (https://github.com/albertodonato/query-exporter), to see if I can get total and user usage in my Grafana Dashboard.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the serverinfo endpoint at /ocs/v2.php/apps/serverinfo/api/v1/info and review how its current storage metrics are produced. Compare the requested global usage, including external S3 storage, with the possible per-user scope and the user_usage_report app; done means the endpoint exposes the agreed global storage metric and its behavior is verifiable in a monitoring dashboard.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grafana, javascript, prometheus
- Domain
- api, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100