Jupyter Resource Usage Roadmap

Let’s keep discussions on what to do next with nbresuse in this meta issue.

---

• Restore the /metrics endpoint to keep backward compatibility for the 0.3.x releases: #45
• Decide where the repo should live: keep under yuvipanda or more to another GitHub organization (or move to Jupyter Server)? https://github.com/yuvipanda/nbresuse/issues/24 -> moved to https://github.com/jupyter-server/jupyter-resource-usage
• Keep the /metrics endpoint for the 0.3.x releases to not break backward compatibility with the lab status bar and other extensions that rely on nbresuse.
• ~Drop~ Deprecate the /metrics endpoint in 0.4.x so it doesn’t shadow the Prometheus endpoint anymore: https://github.com/yuvipanda/nbresuse/pull/68
• Either in a 0.3.x release or in 0.4.x: add a new /api/metrics/v1 endpoint to retrieve the metrics as JSON (just like the current /metrics endpoint). However the format of the response is still to be defined - https://github.com/yuvipanda/nbresuse/issues/52 - new endpoint added in https://github.com/yuvipanda/nbresuse/pull/68
• ~Change the endpoint used in the JupyterLab status bar: https://github.com/jupyterlab/jupyterlab/blob/4fe4dcfe5c9dc329bed2dcf2602f569ddef8a8a0/packages/statusbar/src/defaults/memoryUsage.tsx#L291~ -> remove from core lab and create a federated lab extension for nbresuse: https://github.com/yuvipanda/nbresuse/pull/69
• Drop the deprecated /metrics endpoint: https://github.com/jupyter-server/jupyter-resource-usage/issues/75
• Add kernel metrics: https://github.com/yuvipanda/nbresuse/issues/31
• Add more metrics (Network I/O or other metrics supported by psutil).
• Switch to event stream? https://github.com/yuvipanda/nbresuse/issues/7. This will change the way frontends consume the API and will be a breaking change
• Add tests: https://github.com/yuvipanda/nbresuse/issues/49
• Document the nbresuse API: https://github.com/yuvipanda/nbresuse/issues/48
• Document the Prometheus metrics: https://github.com/yuvipanda/nbresuse/issues/51

[jtpio]

Decide where the repo should live: keep under yuvipanda or more to another GitHub organization (or move to Jupyter Server)? #24

A candidate for now could be the recent jupyter-server organization, as a new home for this repo?

[mlucool]

+1 for baking this into jupyter_server. Feels like a great feature to have out of the box, especially if it includes per kernel!