Skip to content

feat(openmetrics): introduce OpenMetrics exporter - #57165

Merged
Altahrim merged 4 commits into
masterfrom
feat/openmetrics
Jan 7, 2026
Merged

feat(openmetrics): introduce OpenMetrics exporter#57165
Altahrim merged 4 commits into
masterfrom
feat/openmetrics

Conversation

@Altahrim

@AltahrimAltahrim commented Dec 18, 2025•
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

Introduce OpenMetrics endpoint featuring Nextcloud metrics.

It allows to get statistics about the Nextcloud instance but not about hardware (some exporters are already doing that very well). For example: number of files, shares or active users.

It's extensible so every app will be able to expose it's own metrics.

Test

Access it on /metrics (or index.php/metrics depending of configuration)

TODO

  • OpenAPI extractor

Checklist

@AltahrimAltahrim added this to the Nextcloud 33 milestone Dec 18, 2025
@AltahrimAltahrim self-assigned this Dec 18, 2025
@AltahrimAltahrim added 2. developing Work in progress php Pull requests that update Php code feature: monitoring Features related to observability labels Dec 18, 2025
@github-project-automationgithub-project-automationBot moved this to 🏗️ In progress in 📁 Files teamDec 18, 2025
@AltahrimAltahrim mentioned this pull request Dec 18, 2025
Merged
@AltahrimAltahrim mentioned this pull request Dec 18, 2025
Open
@Altahrim
Altahrimforce-pushed the feat/openmetrics branch 2 times, most recently from 9e91442 to 30dd586CompareDecember 19, 2025 08:44
@Altahrim
Altahrimforce-pushed the feat/openmetrics branch 4 times, most recently from f043ff3 to 56d654bCompareJanuary 6, 2026 09:59
come-nc
come-nc reviewed Jan 6, 2026
View reviewed changes
Comment threadapps/comments/appinfo/info.xml Outdated
Comment threadlib/public/OpenMetrics/MetricTypes.php Outdated
Comment threadapps/comments/lib/OpenMetrics/Comments.php Outdated
Comment threadapps/files_sharing/appinfo/info.xml Outdated
Comment threadapps/files_sharing/lib/OpenMetrics/SharesCount.php Outdated
Comment threadcore/Controller/OpenMetricsController.php Outdated
Comment threadlib/private/OpenMetrics/Exporter.php Outdated
Comment threadlib/private/OpenMetrics/Exporters/ActiveUsers.php Outdated
Comment threadlib/private/OpenMetrics/Exporters/Cached.php Outdated
Comment threadlib/private/OpenMetrics/Exporters/Maintenance.php
@AltahrimAltahrim added 3. to review Waiting for reviews and removed 2. developing Work in progress labels Jan 6, 2026
@Altahrim
Altahrim marked this pull request as ready for review January 6, 2026 13:48
@Altahrim
Altahrim requested review from salmart-dev and yemkareems and removed request for a teamJanuary 6, 2026 13:48
@icewind1991

icewind1991 commented Jan 6, 2026

Copy link
Copy Markdown
Member

Some of these (counting files) are going to have a non-trivial cost, might be worth having a way to toggle individual metrics.

@Altahrim

Altahrim commented Jan 6, 2026

Copy link
Copy Markdown
CollaboratorAuthor

Some of these (counting files) are going to have a non-trivial cost, might be worth having a way to toggle individual metrics.

You are right :) That's why I added a way to disable a metric with openmetrics_skipped_classes and also the Cached exporter. I hope both mechanisms will be enough (maybe cached exporter will need to be configurable to run only once per hour or even less)

@icewind1991

icewind1991 commented Jan 6, 2026

Copy link
Copy Markdown
Member

Some of these (counting files) are going to have a non-trivial cost, might be worth having a way to toggle individual metrics.

You are right :) That's why I added a way to disable a metric with openmetrics_skipped_classes and also the Cached exporter. I hope both mechanisms will be enough (maybe cached exporter will need to be configurable to run only once per hour or even less)

Ok, missed that when skimming over the changes 🙈

@Altahrim
Altahrimforce-pushed the feat/openmetrics branch 3 times, most recently from f494623 to 292a77aCompareJanuary 7, 2026 08:30
@Altahrim
feat(openmetrics): introduce OpenMetrics exporter
c57c484
Expose a `/metrics` endpoint with some basic metrics
Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
@Altahrim
feat(comments): add basic OpenMetrics exporter
47de164
Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
@Altahrim
feat(files_sharing): add basic OpenMetrics exporter for files shares
6ee8325
Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
@Altahrim
feat(openapi): add OpenMetrics controller into OpenAPI
71fa593
Signed-off-by: Benjamin Gaussorgues <benjamin.gaussorgues@nextcloud.com>
@Altahrim
Altahrim merged commit 62513df into masterJan 7, 2026
202 of 208 checks passed
@Altahrim
Altahrim deleted the feat/openmetrics branch January 7, 2026 09:43
@AltahrimAltahrim removed the 3. to review Waiting for reviews label Jan 7, 2026
@nextcloud-botnextcloud-bot mentioned this pull request Jan 7, 2026
Merged
@AndyScherzingerAndyScherzinger moved this from 🏗️ In progress to ☑️ Done in 📁 Files teamJan 7, 2026
tcitworld
tcitworld reviewed Jan 8, 2026
View reviewed changes
Comment threadapps/comments/lib/OpenMetrics/CommentsCountMetric.php
namespace OCA\Comments\OpenMetrics;

use Generator;
use OC\DB\Connection;

@tcitworldtcitworldJan 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be OCP\IDBConnection

Comment threadlib/private/OpenMetrics/ExporterManager.php

public function __construct(
private IAppManager $appManager,
private PsrLoggerAdapter $logger,

@tcitworldtcitworldJan 8, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not LoggerInterface ?

@AltahrimAltahrimJan 8, 2026

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right for both, thank you. I'll do a follow-up PR :)

@AltahrimAltahrim mentioned this pull request Jan 8, 2026
Merged
@SystemKeeperSystemKeeper mentioned this pull request Jan 23, 2026
Closed
@rizlas

rizlas commented Jan 27, 2026

Copy link
Copy Markdown

Hi,
sorry for bother, but am I wrong or haven't any metrics regarding groups been implemented?

@Altahrim

Altahrim commented Jan 28, 2026

Copy link
Copy Markdown
CollaboratorAuthor

@rizlas You are right, there isn't any for now but the exporter can be extended.
What kind of metric do you have in mind?

@susnuxsusnux added the pending documentation This pull request needs an associated documentation update label Jan 28, 2026
@susnux

susnux commented Jan 28, 2026

Copy link
Copy Markdown
Contributor

New public API needs mention here:
https://github.com/nextcloud/documentation/blob/1a0415c8bf1541e90ae0b4da487a362a51a1cfe2/developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_33.rst?plain=1#L184

@rizlas

rizlas commented Jan 28, 2026

Copy link
Copy Markdown

@Altahrim Thanks! I was basically thinking about the number of groups and users per group.
It would be nice to also extend https://github.com/nextcloud/groupquota (as specified here https://docs.nextcloud.com/server/latest/developer_manual//digging_deeper/openmetrics.html#implement-a-new-exporter) with: quota per group, quota used per group and free quota per group.

@Altahrim

Altahrim commented Jan 29, 2026

Copy link
Copy Markdown
CollaboratorAuthor

@rizlas Number of groups and number of users per group can be added in Nextcloud, but I am afraid we don't have any straightforward way to get the metrics.
For the number of users per group, I don't know what would be the best statistic. Maybe min/max/avg size or a histogram…

All metrics related to quota must be added in groupquota app as you mentioned :)

@AltahrimAltahrim mentioned this pull request Jan 29, 2026
Merged
@wrenixwrenix mentioned this pull request Feb 23, 2026
Open
@joshtrichardsjoshtrichards removed the pending documentation This pull request needs an associated documentation update label Mar 29, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tcitworldtcitworldtcitworld left review comments
@CarlSchwanCarlSchwanCarlSchwan approved these changes
@come-nccome-nccome-nc approved these changes
@provokateurinprovokateurinAwaiting requested review from provokateurinprovokateurin is a code owner
@skjnldsvskjnldsvAwaiting requested review from skjnldsvskjnldsv is a code owner
@edward-lyedward-lyAwaiting requested review from edward-lyedward-ly is a code owner
@sorbaughsorbaughAwaiting requested review from sorbaughsorbaugh is a code owner
@salmart-devsalmart-devAwaiting requested review from salmart-devsalmart-dev is a code owner automatically assigned from nextcloud/server-backend
@yemkareemsyemkareemsAwaiting requested review from yemkareemsyemkareems is a code owner automatically assigned from nextcloud/server-backend

Assignees

@AltahrimAltahrim

Labels

feature: monitoringFeatures related to observabilityphpPull requests that update Php code

Projects

📁 Files team
Status: ☑️ Done

Milestone

Nextcloud 33

Development

Successfully merging this pull request may close these issues.

9 participants

@Altahrim@icewind1991@rizlas@susnux@tcitworld@CarlSchwan@come-nc@AndyScherzinger@joshtrichards