refactor(log): require destination in calls to NewLogger

[mark-rushakoff]

Description

The previous implementation of log.NewLogger hardcoded the output to os.Stdout. This change updates the signature from NewLogger() to NewLogger(dest io.Writer), so that callers have to be explicit whether they want logs to go to stdout, stderr, or somewhere else.

This is useful particularly in client/pruning.Cmd(), where a new logger was instantiated; that logger is no longer hardcoded to os.Stdout, but instead to a (*cobra.Command).OutOrStdout() for more flexibility in tests that may use that command.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title
• added ! to the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• followed the guidelines for building modules
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• included comments for documenting Go code
• updated the relevant documentation or specification
• reviewed "Files changed" and left comments if necessary
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed ! in the type prefix if API or client breaking change
• confirmed all author checklist items have been addressed
• reviewed state machine logic
• reviewed API design and naming
• reviewed documentation is accurate
• reviewed tests and test coverage
• manually tested (if applicable)

[julienrbrt]

Does not make it too verbose?
The majority of time you want it to go to stdout anyway.
Cannot we have a new function that takes it as an argument?
Like NewLoggerWithOutput or something alike?
We have as well NewCustomLogger for this use case too right?

[mark-rushakoff]

Does not make it too verbose?

A new logger should be instantiated once in a main function and propagated down.

In tests, where we do instantiate many loggers, we have NewTestLogger(t *testing.T).

The majority of time you want it to go to stdout anyway.

No, logs go to stderr. stdout is for information that one would save to a file or pipe to another process. The choice to default logs to stdout is unusual.

We have as well NewCustomLogger for this use case too right?

The custom logger should be an exceptional case.

[mark-rushakoff]

Looks like I've missed a dependency update that I'll have to return to later. Putting this in draft mode until then.

[julienrbrt]

No, logs go to stderr. stdout is for information that one would save to a file or pipe to another process. The choice to default logs to stdout is unusual.

TIL, I am always used to pipe logs normally 🤔

In tests, where we do instantiate many loggers, we have NewTestLogger(t *testing.T).
...
The custom logger should be an exceptional case.

Yeah, my bad. this makes sense! Just noticed CMT logger as well let you choose where it writes too

[julienrbrt]

lgtm!