starred/ntfy

Fork 0

mirror of https://github.com/binwiederhier/ntfy.git synced 2026-05-09 08:26:00 +02:00

stats` API #626

New issue

Closed

opened 2026-05-07 00:26:01 +02:00 by BreizhHardware · 5 comments

BreizhHardware commented

2026-05-07 00:26:01 +02:00

Owner

Originally created by @kevinlutzer on GitHub (Sep 17, 2023).
Original GitHub issue: https://github.com/binwiederhier/ntfy/issues/885

💡 Idea
I want to expose the total subscriptions and topics on the /v1/stats API. The data will be consumed by some of the analytics tools I use to manage my Kubernetes cluster, as well as I want to display these metrics on my Heimdall Dashboard

Looks like the total topics lives on the server struct. Subscriptions would need to be computed in the API based on the Topic.Stats() method pointer.

💻 Target components

ntfy server

Originally created by @kevinlutzer on GitHub (Sep 17, 2023). Original GitHub issue: https://github.com/binwiederhier/ntfy/issues/885  :bulb: **Idea** I want to expose the total subscriptions and topics on the /v1/stats API. The data will be consumed by some of the analytics tools I use to manage my Kubernetes cluster, as well as I want to display these metrics on my [Heimdall](https://heimdall.site/) Dashboard  Looks like the total topics lives on the server struct. Subscriptions would need to be computed in the API based on the `Topic.Stats()` method pointer. :computer: **Target components**   ntfy server

BreizhHardware

2026-05-07 00:26:01 +02:00

closed this issue
added the
enhancement
label

BreizhHardware commented

2026-05-07 00:26:01 +02:00

Author

Owner

@binwiederhier commented on GitHub (Sep 24, 2023):

My apologies for not responding earlier, but I do not thing that this info should be exposed in a public endpoint due to security concerts. It leaks info. I realize that the number of messages is already questionable, but I need that to display the nice counter on the website.

@binwiederhier commented on GitHub (Sep 24, 2023): My apologies for not responding earlier, but I do not thing that this info should be exposed in a public endpoint due to security concerts. It leaks info. I realize that the number of messages is already questionable, but I need that to display the nice counter on the website.

BreizhHardware commented

2026-05-07 00:26:01 +02:00

Author

Owner

@kevinlutzer commented on GitHub (Sep 24, 2023):

Thanks for your response!

Ahh okay no worries! Ya I thought that if you were comfortable with the total message quantity and message rate metrics being exposed via API that there wouldn't be an issue with showing the total number of topics, subscriptions etc.

Is there another way it would be possible to expose these metrics? Maybe behind an auth'd API?

@kevinlutzer commented on GitHub (Sep 24, 2023): Thanks for your response! Ahh okay no worries! Ya I thought that if you were comfortable with the total message quantity and message rate metrics being exposed via API that there wouldn't be an issue with showing the total number of topics, subscriptions etc. Is there another way it would be possible to expose these metrics? Maybe behind an auth'd API?

BreizhHardware commented

2026-05-07 00:26:01 +02:00

Author

Owner

@binwiederhier commented on GitHub (Sep 24, 2023):

I could see the stats API returning more stats when queried by an admin user, which should be relatively easy to achieve. Basically return the same stuff that the metrics endpoint would.

@binwiederhier commented on GitHub (Sep 24, 2023): I could see the stats API returning more stats when queried by an admin user, which should be relatively easy to achieve. Basically return the same stuff that the metrics endpoint would.

BreizhHardware commented

2026-05-07 00:26:02 +02:00

Author

Owner

@kevinlutzer commented on GitHub (Sep 24, 2023):

Are you referring to this file as the "metrics endpoint" -> https://github.com/binwiederhier/ntfy/blob/main/server/server_metrics.go

@kevinlutzer commented on GitHub (Sep 24, 2023): Are you referring to this file as the "metrics endpoint" -> https://github.com/binwiederhier/ntfy/blob/main/server/server_metrics.go

BreizhHardware commented

2026-05-07 00:26:02 +02:00

Author

Owner

@binwiederhier commented on GitHub (Sep 24, 2023):

Yeah, the prometheus endpoint is how you'd usually get metrics. It's pretty awesome.

@binwiederhier commented on GitHub (Sep 24, 2023): Yeah, the prometheus endpoint is how you'd usually get metrics. It's pretty awesome. ![image](https://github.com/binwiederhier/ntfy/assets/664597/b2476942-c7eb-4724-859b-3ea955cde28f)

BreizhHardware referenced this issue

2026-05-07 01:01:45 +02:00

[PR #626] [MERGED] Add nlog-ntfy integration to docs #1357