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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,10 @@ Mirroring CPU and Memory, the trait `disk_warning_threshold` signifies when to f
### Disable Prometheus Metrics

There is a [known bug](https://github.com/jupyter-server/jupyter-resource-usage/issues/123) with Prometheus metrics which
causes "lag"/pauses in the UI. To workaround this you can disable Prometheus metric reporting using:

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=False
--ResourceUseDisplay.enable_prometheus_metrics=True
```

## Enable alternative frontend
Expand Down
2 changes: 1 addition & 1 deletion jupyter_resource_usage/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ def _disk_path_default(self):
).tag(config=True)

enable_prometheus_metrics = Bool(
default_value=True,
default_value=False,
help="""
Set to False in order to disable reporting of Prometheus style metrics.
""",
Expand Down
Loading