Skip to content

opt-in for enable_prometheus_metrics #243

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

jhgoebbert
Copy link

I would suggest to change that to an opt-in.

At the moment jupyter-resource-usage is overloading tornado's task-pool for the prometheus-feature without taking into account that this will result in less (or even worst) performance for the critical webserver.

More details can be found here: #242

@jtpio
Copy link
Member

jtpio commented Mar 13, 2025

Thanks @jhgoebbert.

Should the README also be updated to reflect the new default? https://github.com/jupyter-server/jupyter-resource-usage?tab=readme-ov-file#disable-prometheus-metrics

@jhgoebbert
Copy link
Author

Hi @jtpio
I updated the README.md now too. Let me know if this would be fine for you:


There is a #123 with Prometheus metrics which causes "lag"/pauses in the UI. Hence, the Prometheus metric reporting is disabled by default (for all versions > 1.1.1).
If you want to use the Prometheus metric reporting you need to enable it with:

--ResourceUseDisplay.enable_prometheus_metrics=True

@jtpio
Copy link
Member

jtpio commented Mar 13, 2025

Thanks, looks like the file needs a quick lint pass.

@jhgoebbert
Copy link
Author

Hmm ... from the details I do not see that this is related to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants