[Gitpod CLI] New command gp top - Display workspace used/available resources

[andreafalzetti]

Description

Introducing a new command for gitpod-cli: $ gp top

Command line interface for Gitpod

Usage:
  gp [command]

Available Commands:
...
  top                 Display workspace resource (CPU/Memory usage)

This command similarly to gp ports list and gp tasks list use colors. It's a best practice for CLI tools to be accessible and allow disabling colors in certain circumstances.

I've followd this approach, which seems to be very common and community sanctioned:

I've enclosed this logic in a utility so that, if we like it, we can re-use it also for the other commands.

Without disabling colors, running watch gp top it would display the following:

By detecting if the CLI is being used without any wrapper or being piped into a command, it disables the colors and it looks good:

Related Issue(s)

Fixes #9521

How to test

1. Start this workspace in prev env: https://afalz-9521-gp-top.preview.gitpod-dev.com/#https://github.com/andreafalzetti/gitpod-experiments-c
2. Run gp top, observe the cpu/memory usage
3. Try disabling colors with the following options:
   • gp top --no-color
   • NO_COLOR=1 gp top
   • GP_NO_COLOR=1 gp top
   • TERM=dumb gp top

Optionally, to test the colors based on usage:
4. To stress the CPU, run: yes > /dev/null & multiple times
5. Run gp top again and obsere the CPU usage
6. To get the CPU back to a lower value, run: killall yes
7. To stress the Memory, run cat /dev/zero | head -c 5G | tail once or twice

In prev env, it easily hangs before you can actually test gp top for this, I've also attached some screenshots taken from my dev branch in gitpod.io.

Release Notes

Added a new command to gitpod-cli: "gp top" which displays workspace resources (CPU/Memory usage)

Documentation

https://github.com/gitpod-io/website/pull/2207

[akosyakov]

/lgtm

/hold
if you want to make any small adjustments, otherwise it looks good

[filiptronicek]

Thanks a lot @andreafalzetti 🚀!

I just have two questions:

1. Would it be a common use case for users to run this with watch? Maybe we could add a way to run continuously to behave more like top?
2. Is there a way to consume the info via other means? Can I use these values in my app somehow? I would like to for instance output JSON so it can be consumed by tools like https://github.com/akosyakov/gitpod-monitor (still the best VS Code extension there is).

[andreafalzetti]

Thanks a lot @andreafalzetti 🚀!

I just have two questions:

1. Would it be a common use case for users to run this with `watch`? Maybe we could add a way to run continuously to behave more like `top`?

2. Is there a way to consume the info via other means? Can I use these values in my app somehow? I would like to for instance output JSON so it can be consumed by tools like https://github.com/akosyakov/gitpod-monitor (still the best VS Code extension there is).

These are good points, I've also mentioned them in this PR - see: 1 and 2 :)

[filiptronicek]

These are good points, I've also mentioned them in this PR - see: #10570 (comment) and #10570 (comment) :)

Thanks for the pointers, @andreafalzetti, I have tried the command and it LGTM ✅.

[andreafalzetti]

Thanks @akosyakov and @filiptronicek

There was a typo in the OSS header (2020 -> 2022). Fixed and pushed. Waiting for the build to finish and it will be merged 🙏

/unhold