Document the soft-deprecated endpoint

[jtpio]

#68 switches the main endpoint to /api/metrics/v1, but keeps the original /metrics under a flag.

This should be documented, for example in a new CHANGELOG.md.

Also previous releases of JupyterLab 1.x and 2.x include a status bar item that requests metrics from the deprecated /metrics endpoint. It can be tricky to understand which versions of lab and nbresuse are compatible. However #69 should help with this in the long run.

This is less problematic for classic notebook users since the frontend ships with nbresuse (#69 would do the same for the lab frontend)

[Gsbreddy]

@jtpio I have some notes that can help for older versions of nbreuse if you want to include in CHANGELOG.

01.0

• Initial Commits for mem usage display

0.2.0

• Configurable memory usage warnings
• More configurability via traitlets
• Document memory limit behavior
• Add screenshot for memory usage warning
• Change 'Mem' prefix in display to less cryptic 'Memory'
• Fix primary screenshot to show memory limit too
• Consolidate code into single file

0.3.0

• Automatically install & enable extensions
• Put nbextension / serverextension enables in different places
• Put nbresuse js files in appropriate path

0.3.1

• Don't poll in background, since user does not see it
• Poll instantly once page is foregrounded

This should reduce the number of /metrics requests massively,
with minimal interruption to user experience.

0.3.2

• Require authentication for /metrics API Handler

0.3.3

• Made memory limit possibly dynamic via passing a callable in the config.
• Track CPU usage (Track CPU usage #21)

0.3.4

• report the memory usage metrics as prometheus metrics
• Add section about CPU usage to the README
• Autoformatting and documentation
• Make psutil optional dependency of NBResuse

[jtpio]

Thanks a lot @Gsbreddy!

Would you like to open a PR to create CHANGELOG.md with this content?

Also we'll probably want to:

• Sort in descending order
• Include 0.3.5 and 0.3.6 too

[Gsbreddy]

Sure thing. Let me do that and get back to you.

…

On Fri, 20 Nov 2020 at 3:08 PM, Jeremy Tuloup ***@***.***> wrote: Thanks a lot @Gsbreddy <https://github.com/Gsbreddy>! Would you like to open a PR to create CHANGELOG.md with this content? Also we'll probably want to: - Sort in descending order - Include 0.3.5 and 0.3.6 too — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#70 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AB26ANN3HTIBARXRWDMV373SQY2HPANCNFSM4T3X737A> .

[jtpio]

FYI @Gsbreddy #71 adds the CHANGELOG.md, but only lists 0.4.0.

[Gsbreddy]

Sure, I will add other versions by EOD.

[Gsbreddy]

@jtpio Updated older versions in #72