cli/debug: allow the user to refine which files get included

[knz]

First commit from #64071.
Fixes #54654.

We have observed in practice that the majority of the size of
generated debug zip outputs is attributable to the discrete files
retrieved from the server:

• log files
• goroutine dumps
• heap profiles

As clusters get larger and older, these files increase in number, and
the size of the debug zip output grows accordingly.

Meanwhile, in practice, there are many support cases where we know
ahead of running the debug zip command that only certain files are
going to be useful. Therefore, we wish to be able to restrict
which files get included / excluded from the generated archive.

Hence the functional change described below.

(Note: there is another expressed wish to limit the size of generated
archives based on a time or date range, not just file names /
types. This will be handled in a separate commit.)

Release note (cli change): It is now possible to fine tune which files
get retrieved from the server nodes by the debug zip command, using
the new flag --include-files and --exclude-files. These flags
take glob patterns that are applied to the file names server-side. For
example, to include only log files, use --include-files='*.log'.

The command cockroach debug list-files also accepts these flags and
can thus be used to experiment with the new flags before running the
debug zip command.

[cockroach-teamcity]

This change is 

[knz]

cc @thtruo

[stevendanna]

Reviewed 4 of 4 files at r1, 2 of 2 files at r2.
Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @knz and @stevendanna)

a discussion (no related file):
First commit reviewed over at #64071, apologies for not doing it all here.

Thanks for adding the missing tests!

This looks like a useful addition. I think the only blocker is the function name changes I mentioned in #64071 to get this building again.

---

---

pkg/cli/zip_per_node.go, line 388 at r3 (raw file):

				if err := zc.z.createRaw(nodePrinter.start("writing dump"), name, file.Contents); err != nil {
					return err
				}

It feels like there might be some room for a helper function or two in this file that would reduce some of the code duplication. But, that looks true of the existing code as well.

[knz]

Reviewable status: complete! 0 of 0 LGTMs obtained (waiting on @stevendanna)

a discussion (no related file):

Previously, stevendanna (Steven Danna) wrote…

First commit reviewed over at #64071, apologies for not doing it all here.

Thanks for adding the missing tests!

This looks like a useful addition. I think the only blocker is the function name changes I mentioned in #64071 to get this building again.

Thanks this seems to build now.

---

---

pkg/cli/zip_per_node.go, line 388 at r3 (raw file):

Previously, stevendanna (Steven Danna) wrote…

It feels like there might be some room for a helper function or two in this file that would reduce some of the code duplication. But, that looks true of the existing code as well.

This is going to be complicated until go provides us with generics. Every one of these blocks has a different mix of types and function signatures.

[knz]

@tbg reviewed this in #64128 (review)

Addressing these comments here: #64128 (review)