Skip to content

opt-in for enable_prometheus_metrics#243

Open
jhgoebbert wants to merge 3 commits into
jupyter-server:mainfrom
jhgoebbert:master
Open

opt-in for enable_prometheus_metrics#243
jhgoebbert wants to merge 3 commits into
jupyter-server:mainfrom
jhgoebbert:master

Conversation

@jhgoebbert

Copy link
Copy Markdown

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

jtpio commented Mar 13, 2025

Copy link
Copy Markdown
Member

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
Copy Markdown
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

jtpio commented Mar 13, 2025

Copy link
Copy Markdown
Member

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

@jhgoebbert

Copy link
Copy Markdown
Author

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

@krassowski

Copy link
Copy Markdown
Collaborator

It looks like the lint failure is related, it wants to slightly reformat the changes in README.md.

@jhgoebbert

jhgoebbert commented Aug 19, 2025

Copy link
Copy Markdown
Author

@krassowski Thanks. It is fixed now.

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.

3 participants