Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose prometheus metrics #2001

Open
scriptis opened this issue Nov 11, 2024 · 2 comments
Open

Expose prometheus metrics #2001

scriptis opened this issue Nov 11, 2024 · 2 comments
Assignees
Labels
Configuration Regarding the server setup JSON Feature Request Requested functionality Ready Issue ready to be addressed REST The JSON REST API for server control Security Issue pertaining to Authentication/Authorization or NTC (Never Trust the Client)
Milestone

Comments

@scriptis
Copy link

Is your feature request related to a problem? Please describe.

I like graphs. We all like graphs. And alerts, too! I use Grafana to make me graphs and scream at me when something is wrong. I use Prometheus to feed Grafana most of my crap and also maybe use it to scream at me when something is wrong. I'd love TGS to expose a metrics reporting endpoint so I can collect metrics and get yelled at on a regular basis when Dream Daemon runs out of memory.

Describe the solution you'd like
Allow TGS to bind to a second port/address that exposes a /metrics endpoint in line with the Prometheus documentation. Reporting memory usage is a must, but there's a lot of metrics that could get crammed into here so my ops can get alerted when's a good time to figure out who poured gasoline all over the server.

Describe alternatives you've considered
I could write a shim on my side to curl TGS and emit these metrics for me, but it might make sense to just build this endpoint directly into TGS since so many other routing/deployment/infrastructure daemons provide a similar feature.

Additional context

n/a

@scriptis scriptis added Backlog Issue to be scheduled for addressing Feature Request Requested functionality labels Nov 11, 2024
@Cyberboss Cyberboss added the REST The JSON REST API for server control label Nov 11, 2024
@Cyberboss Cyberboss self-assigned this Nov 11, 2024
@Cyberboss Cyberboss added Security Issue pertaining to Authentication/Authorization or NTC (Never Trust the Client) Configuration Regarding the server setup JSON labels Nov 11, 2024
@Cyberboss
Copy link
Member

Needs a config to either be accessible publicly or via an X-Auth-Token header

@Cyberboss
Copy link
Member

Cyberboss commented Nov 11, 2024 via email

@Cyberboss Cyberboss added this to the v6.13.0 milestone Dec 21, 2024
@Cyberboss Cyberboss added Ready Issue ready to be addressed and removed Backlog Issue to be scheduled for addressing labels Dec 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Configuration Regarding the server setup JSON Feature Request Requested functionality Ready Issue ready to be addressed REST The JSON REST API for server control Security Issue pertaining to Authentication/Authorization or NTC (Never Trust the Client)
Projects
None yet
Development

No branches or pull requests

2 participants