feat(cli): add `coder stat` command #8005

johnstcn · 2023-06-13T16:34:56Z

Adds a coder stat command that emits resource information about the current workspace host or container.

$ coder stat
HOST CPU        HOST MEMORY     HOME DISK         CONTAINER CPU   CONTAINER MEMORY  
7.5/64.0 cores  246.5/251.4 GB  1225.8/3050.4 GB  0.1/64.0 cores  4.6/15.4 GB   

$ coder stat cpu
0.7/8.0 cores

$ coder stat cpu --host
0.1/16.0 cores

$ coder stat disk --path $HOME --prefix Ti
0.3/0.9 TiB

$ coder stat disk --path $HOME 
308.3/926.4 GiB

Usage in agent metadata:

  metadata {
    display_name = "Host CPU"
    interval     = 1
    timeout      = 1
    key          = "0_host_cpu"
    script       = "coder stat cpu --host"
  }

  metadata {
    display_name = "Host Memory"
    interval     = 1
    timeout      = 1
    key          = "1_host_mem"
    script       = "coder stat mem --host"
  }

  metadata {
    display_name = "Home Disk"
    interval     = 1
    timeout      = 1
    key          = "2_home_disk"
    script       = "coder stat disk --path $${HOME}"
  }

  metadata {
    display_name = "Container CPU"
    interval     = 1
    timeout      = 1
    key          = "3_container_cpu"
    script       = "coder stat cpu"
  }

  metadata {
    display_name = "Container Memory"
    interval     = 1
    timeout      = 1
    key          = "4_container_cpu"
    script       = "coder stat mem"
  }

What this looks like in practice:

Also updated docs and sample docker/kubernetes templates with example usage.

~~Open question: would it make sense to break the stat command into individual sub-commands (coder stat cpu, coder stat container_mem)?~~

~~Partially repairs~~ Fixes #7076

…acted out the filesystem

ammario

In the style of v1, I think we should show percentages alongside the resource values
To make room for percentages and reduce noise, I think we should show at most 3 levels of precision

So 246.5/251.4 GB would be 246 / 251 GB (90%)

ammario · 2023-06-14T18:17:14Z

cli/clistat/cgroup.go

Happy that you split a lot of this logic into its own package.

cli/clistat/container.go

cli/clistat/stat.go

bpmct · 2023-06-14T18:54:09Z

This is AWESOME! How does coder stat work if run on a VM?

johnstcn · 2023-06-14T18:58:43Z

In the style of v1, I think we should show percentages alongside the resource values
To make room for percentages and reduce noise, I think we should show at most 3 levels of precision
So 246.5/251.4 GB would be 246 / 251 GB (90%)

Isn't that 0 levels of precision?
For quantities that are genenerally in the region of 10^1 - 10^2 (such as cores), such precision isn't really useful. For example, 2/8 cores (36%).

I'm in favour of percentages, agree with limiting precision up to a point.

johnstcn · 2023-06-14T19:00:24Z

This is AWESOME! How does coder stat work if run on a VM?

There's no difference from its perspective between running in a VM and running on a real piece of metal.

ammario · 2023-06-14T19:19:02Z

2. For quantities that are genenerally in the region of 10^1 - 10^2 (such as cores), such precision isn't really useful. For example, 2/8 cores (36%).

Precision may not be the right word, I guess I just mean the number of numbers shown. 2.23 223 or 22.3 would all be fine.

matifali · 2023-06-15T04:52:37Z

For quantities that are genenerally in the region of 10^1 - 10^2 (such as cores), such precision isn't really useful. For example, 2/8 cores (36%).

Precision may not be the right word, I guess I just mean the number of numbers shown. 2.23 223 or 22.3 would all be fine.

The number of significant figures. I agree with showing 3 at max. for cores that can be limited to 2.

johnstcn · 2023-06-15T15:30:22Z

cli/clistat/stat.go

+	// If the unit prefixes of the used and total values are different,
+	// display the used value's prefix to avoid confusion.
+	if usedPrefix != totalPrefix || totalDisplay == "" {
+		_, _ = sb.WriteString(" ")
+		_, _ = sb.WriteString(usedPrefix)
+		_, _ = sb.WriteString(r.Unit)
+	}


review: this means you will see output like 16.7 mcores/64 cores (0%) or 1 B/100 TB (0%). I investigated scaling to use the same units, but this was non-trivial.

I don't have enough time today to give the code a good review

mtojek

Good job!

bpmct · 2023-06-19T18:19:28Z

Partially repairs #7076

Is there more to be done after this PR?

johnstcn · 2023-06-20T09:12:06Z

Partially repairs #7076

Is there more to be done after this PR?

I was originally intending to update the templates and documentation separately, but eneded up doing it here. So, no.

mtojek · 2023-06-20T09:16:46Z

I synced with @johnstcn today. I'm going to merge this PR.

johnstcn and others added 27 commits June 13, 2023 17:33

add stat command

5db9006

cpu working on mac

d6029b4

add stat memory

18f4942

support values with no total

251fdda

move clistats to its own package

4c081dc

fix container detection to work with sysbox containers

2ba7392

add cross-platform declaration for IsContainerized()

0e1c96a

add a sync.Once to IsContainerized()

0f9859e

make uptime minutes

a220c7f

lint

89f7e8d

extract nproc to variable

c51e245

add skeleton of cgroup stuff

3528c00

initial cgroupv2 cpu implementation

7108c6e

fix disk_windows

4ef5f24

add tests for clistats

f0f7b6a

improve testing

6a878b9

remove unnecessary os-specific implementations now that we have abstr…

be7ba72

…acted out the filesystem

remove uptime stat as it is trivial to implement in bash

3643407

implement cgroupv1 cpu

1c8943e

unskip container memory tests

95b8d1f

flesh out tests

495b5b0

cgroupv1 memory

fa0c4c6

improve tests to allow testing cpu used

70ef79b

refactor cpu usage calc

7eeefc1

fix tests

305675f

fix off-by-10 error

d1bb322

remove --sample-interval and collect CPU stats in parallel

eb2bcf6

johnstcn self-assigned this Jun 13, 2023

johnstcn added 2 commits June 13, 2023 18:02

fmt; gen

44edcf3

make default_cols consistent to avoid ci surprises

0f3254a

ammario mentioned this pull request Jun 14, 2023

agent metadata: use magic format to render values nicely #8038

Closed

ammario previously requested changes Jun 14, 2023

View reviewed changes

johnstcn added 11 commits June 15, 2023 13:49

add percentages

482db10

remove outdated comments

0775082

handle counter reset

73debf8

add test for large difference between used and total

d0c992a

auto-scale precision, limiting to 3 digits

ef7460a

automatically scale precision, remove --prefix arg

bec527f

make gen

08adba7

improve cli tests

78f76e7

update go.mod

9a82882

Merge remote-tracking branch 'origin/main' into cj/coder-stat

19c8a80

update go.sum

eab2530

johnstcn commented Jun 15, 2023

View reviewed changes

johnstcn requested a review from ammario June 15, 2023 15:30

mtojek self-requested a review June 19, 2023 11:03

mtojek approved these changes Jun 19, 2023

View reviewed changes

ammario removed their request for review June 19, 2023 19:21

mtojek merged commit d6f8bd7 into main Jun 20, 2023

mtojek deleted the cj/coder-stat branch June 20, 2023 09:16

github-actions bot locked and limited conversation to collaborators Jun 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cli): add `coder stat` command #8005

feat(cli): add `coder stat` command #8005

johnstcn commented Jun 13, 2023 •

edited

Loading

ammario left a comment

ammario Jun 14, 2023

bpmct commented Jun 14, 2023

johnstcn commented Jun 14, 2023 •

edited

Loading

johnstcn commented Jun 14, 2023

ammario commented Jun 14, 2023 •

edited

Loading

matifali commented Jun 15, 2023

johnstcn Jun 15, 2023

mtojek left a comment

bpmct commented Jun 19, 2023

johnstcn commented Jun 20, 2023

mtojek commented Jun 20, 2023

feat(cli): add coder stat command #8005

feat(cli): add coder stat command #8005

Conversation

johnstcn commented Jun 13, 2023 • edited Loading

ammario left a comment

Choose a reason for hiding this comment

ammario Jun 14, 2023

Choose a reason for hiding this comment

bpmct commented Jun 14, 2023

johnstcn commented Jun 14, 2023 • edited Loading

johnstcn commented Jun 14, 2023

ammario commented Jun 14, 2023 • edited Loading

matifali commented Jun 15, 2023

johnstcn Jun 15, 2023

Choose a reason for hiding this comment

mtojek left a comment

Choose a reason for hiding this comment

bpmct commented Jun 19, 2023

johnstcn commented Jun 20, 2023

mtojek commented Jun 20, 2023

feat(cli): add `coder stat` command #8005

feat(cli): add `coder stat` command #8005

johnstcn commented Jun 13, 2023 •

edited

Loading

johnstcn commented Jun 14, 2023 •

edited

Loading

ammario commented Jun 14, 2023 •

edited

Loading