Progress written when logging to file

[nirs]

Description

When converting qcow2 image to raw, we log nice progress bar, but it is not very helpful when the log is redirected to file:

% _output/bin/limactl start --log-format json --plain --vm-type vz --tty=false 2>start.log

% tail -f start.log
...
{"level":"info","msg":"Converting \"/Users/nsoffer/.lima/default/basedisk\" (qcow2) to a raw disk \"/Users/nsoffer/.lima/default/diffdisk\"","time":"2024-09-02T04:38:43+03:00"}
97.00 MiB / 3.50 GiB [->___________________________________________] 2.71% ? p/s231.00 MiB / 3.50 GiB [-->_________________________________________] 6.45% ? p/s252.00 MiB / 3.50 GiB [--->________________________________________] 7.03% ? p/s270.00 MiB / 3.50 GiB [-->__________________________________] 7.53% 287.86 MiB/s295.00 MiB / 3.50 GiB [--->_________________________________] 8.23% 287.86 MiB/s424.00 MiB / 3.50 GiB [---->_______________________________] 11.83% 287.86 MiB/s569.00 MiB / 3.50 GiB [----->______________________________] 15.88% 301.46 MiB/s714.00 MiB / 3.50 GiB [------->____________________________] 19.92% 301.46 MiB/s860.00 MiB / 3.50 GiB [-------->___________________________] 24.00% 301.46 MiB/s1005.00 MiB / 3.50 GiB [--------->_________________________] 28.04% 328.93 MiB/s1.07 GiB / 3.50 GiB [----------->__________________________] 30.55% 328.93 MiB/s1.15 GiB / 3.50 GiB [------------>_________________________] 32.92% 328.93 MiB/s1.19 GiB / 3.50 GiB [------------>_________________________] 34.12% 331.12 MiB/s1.21 GiB / 3.50 GiB [------------->________________________] 34.65% 331.12 MiB/s1.23 GiB / 3.50 GiB [------------->________________________] 35.21% 331.12 MiB/s1.25 GiB / 3.50 GiB [------------->________________________] 35.77% 316.10 MiB/s1.27 GiB / 3.50 GiB [------------->________________________] 36.19% 316.10 MiB/s1.29 GiB / 3.50 GiB [------------->________________________] 36.75% 316.10 MiB/s1.31 GiB / 3.50 GiB [-------------->_______________________] 37.33% 301.73 MiB/s1.33 GiB / 3.50 GiB [-------------->_______________________] 37.92% 301.73 MiB/s1.35 GiB / 3.50 GiB [-------------->_______________________] 38.50% 301.73 MiB/s1.37 GiB / 3.50 GiB [-------------->_______________________] 39.26% 289.68 MiB/s1.39 GiB / 3.50 GiB [--------------->______________________] 39.79% 289.68 MiB/s1.41 GiB / 3.50 GiB [--------------->______________________] 40.29% 289.68 MiB/s1.43 GiB / 3.50 GiB [--------------->______________________] 40.85% 277.12 MiB/s1.45 GiB / 3.50 GiB [--------------->______________________] 41.41% 277.12 MiB/s1.47 GiB / 3.50 GiB [--------------->______________________] 41.88% 277.12 MiB/s1.48 GiB / 3.50 GiB [---------------->_____________________] 42.38% 265.16 MiB/s1.50 GiB / 3.50 GiB [---------------->_____________________] 42.89% 265.16 MiB/s1.52 GiB / 3.50 GiB [---------------->_____________________] 43.47% 265.16 MiB/s1.54 GiB / 3.50 GiB [---------------->_____________________] 44.06% 254.50 MiB/s1.57 GiB / 3.50 GiB [----------------->____________________] 44.84% 254.50 MiB/s1.59 GiB / 3.50 GiB [----------------->____________________] 45.48% 254.50 MiB/s1.62 GiB / 3.50 GiB [----------------->____________________] 46.21% 246.36 MiB/s1.64 GiB / 3.50 GiB [----------------->____________________] 46.90% 246.36 MiB/s1.66 GiB / 3.50 GiB [------------------>___________________] 47.46% 246.36 MiB/s1.68 GiB / 3.50 GiB [------------------>___________________] 48.05% 237.56 MiB/s1.70 GiB / 3.50 GiB [------------------>___________________] 48.66% 237.56 MiB/s1.72 GiB / 3.50 GiB [------------------>___________________] 49.25% 237.56 MiB/s1.75 GiB / 3.50 GiB [------------------>___________________] 49.86% 229.23 MiB/s1.77 GiB / 3.50 GiB [------------------->__________________] 50.50% 229.23 MiB/s1.79 GiB / 3.50 GiB [------------------->__________________] 51.20% 229.23 MiB/s1.81 GiB / 3.50 GiB [------------------->__________________] 51.59% 221.10 MiB/s1.82 GiB / 3.50 GiB [------------------->__________________] 52.04% 221.10 MiB/s1.84 GiB / 3.50 GiB [------------------->__________________] 52.48% 221.10 MiB/s1.87 GiB / 3.50 GiB [-------------------->_________________] 53.32% 213.51 MiB/s1.89 GiB / 3.50 GiB [-------------------->_________________] 53.93% 213.51 MiB/s1.91 GiB / 3.50 GiB [-------------------->_________________] 54.60% 213.51 MiB/s1.93 GiB / 3.50 GiB [-------------------->_________________] 55.11% 206.61 MiB/s1.95 GiB / 3.50 GiB [--------------------->________________] 55.69% 206.61 MiB/s1.97 GiB / 3.50 GiB [--------------------->________________] 56.22% 206.61 MiB/s1.99 GiB / 3.50 GiB [--------------------->________________] 56.78% 199.74 MiB/s2.02 GiB / 3.50 GiB [--------------------->________________] 57.62% 199.74 MiB/s2.06 GiB / 3.50 GiB [---------------------->_______________] 58.98% 199.74 MiB/s2.09 GiB / 3.50 GiB [---------------------->_______________] 59.71% 198.14 MiB/s2.11 GiB / 3.50 GiB [---------------------->_______________] 60.24% 198.14 MiB/s2.13 GiB / 3.50 GiB [----------------------->______________] 60.77% 198.14 MiB/s2.14 GiB / 3.50 GiB [----------------------->______________] 61.24% 191.27 MiB/s2.16 GiB / 3.50 GiB [----------------------->______________] 61.75% 191.27 MiB/s2.18 GiB / 3.50 GiB [----------------------->______________] 62.33% 191.27 MiB/s2.20 GiB / 3.50 GiB [----------------------->______________] 62.86% 185.17 MiB/s2.22 GiB / 3.50 GiB [------------------------>_____________] 63.36% 185.17 MiB/s2.24 GiB / 3.50 GiB [------------------------>_____________] 63.92% 185.17 MiB/s2.26 GiB / 3.50 GiB [------------------------>_____________] 64.56% 179.78 MiB/s2.28 GiB / 3.50 GiB [------------------------>_____________] 65.15% 179.78 MiB/s2.30 GiB / 3.50 GiB [------------------------>_____________] 65.71% 179.78 MiB/s2.32 GiB / 3.50 GiB [------------------------->____________] 66.29% 174.85 MiB/s2.34 GiB / 3.50 GiB [------------------------->____________] 66.94% 174.85 MiB/s2.37 GiB / 3.50 GiB [------------------------->____________] 67.66% 174.85 MiB/s2.39 GiB / 3.50 GiB [------------------------->____________] 68.19% 170.89 MiB/s2.40 GiB / 3.50 GiB [-------------------------->___________] 68.58% 170.89 MiB/s2.40 GiB / 3.50 GiB [-------------------------->___________] 68.58% 170.89 MiB/s2.40 GiB / 3.50 GiB [-------------------------->___________] 68.58% 161.37 MiB/s2.42 GiB / 3.50 GiB [-------------------------->___________] 69.06% 161.37 MiB/s2.44 GiB / 3.50 GiB [-------------------------->___________] 69.64% 161.37 MiB/s2.46 GiB / 3.50 GiB [-------------------------->___________] 70.28% 157.52 MiB/s2.48 GiB / 3.50 GiB [-------------------------->___________] 70.95% 157.52 MiB/s2.50 GiB / 3.50 GiB [--------------------------->__________] 71.57% 157.52 MiB/s2.54 GiB / 3.50 GiB [--------------------------->__________] 72.43% 155.63 MiB/s2.56 GiB / 3.50 GiB [--------------------------->__________] 73.16% 155.63 MiB/s2.58 GiB / 3.50 GiB [---------------------------->_________] 73.74% 155.63 MiB/s2.60 GiB / 3.50 GiB [---------------------------->_________] 74.39% 153.12 MiB/s2.63 GiB / 3.50 GiB [---------------------------->_________] 75.14% 153.12 MiB/s2.66 GiB / 3.50 GiB [---------------------------->_________] 76.00% 153.12 MiB/s2.68 GiB / 3.50 GiB [----------------------------->________] 76.59% 151.74 MiB/s2.71 GiB / 3.50 GiB [----------------------------->________] 77.37% 151.74 MiB/s2.75 GiB / 3.50 GiB [----------------------------->________] 78.63% 151.74 MiB/s2.88 GiB / 3.50 GiB [------------------------------->______] 82.14% 163.34 MiB/s3.02 GiB / 3.50 GiB [-------------------------------->_____] 86.19% 163.34 MiB/s3.16 GiB / 3.50 GiB [---------------------------------->___] 90.26% 163.34 MiB/s3.30 GiB / 3.50 GiB [----------------------------------->__] 94.31% 199.69 MiB/s3.44 GiB / 3.50 GiB [------------------------------------->] 98.38% 199.69 MiB/s3.50 GiB / 3.50 GiB [-------------------------------------] 100.00% 196.06 MiB/s{"level":"info","msg":"Expanding to 100GiB","time":"2024-09-02T04:39:01+03:00"}

Fix:

• quick: disable the progress when log output is not a tty
• later: support json progress

Example json progress:

{"level":"info","msg":"[hostagent] Converting image","done":0,"total":10000000,"time":"2024-09-02T04:37:18+03:00"}
{"level":"info","msg":"[hostagent] Converting image","done":1000000,"total":10000000,"time":"2024-09-02T04:37:19+03:00"}

A program can use the progress line to show a progress bar.

[afbjorklund]

The progress is not supposed to be written to a file, so that sounds like a bug (specific to qcow2?)

There is some additional work on json and machine-readable progress output, in the issue #1316

EDIT: My bad it actually is written every 5 seconds, guess the other progress was "too fast"

        if isatty.IsTerminal(os.Stdout.Fd()) || isatty.IsCygwinTerminal(os.Stdout.Fd()) {
                bar.SetTemplateString(`{{counters . }} {{bar . | green }} {{percent .}} {{speed . "%s/s"}}`)
                bar.SetRefreshRate(200 * time.Millisecond)
        } else {
                bar.Set(pb.Terminal, false)
                bar.Set(pb.ReturnSymbol, "\n")
                bar.SetTemplateString(`{{counters . }} ({{percent .}}) {{speed . "%s/s"}}`)
                bar.SetRefreshRate(5 * time.Second)
        }