Add LoggerColorBehavior

[maryamariyan]

Fixes: #37421

cc: @eerhardt @davidfowl @tarekgh

[ghost]

Tagging subscribers to this area: @maryamariyan
See info in area-owners.md if you want to be subscribed.

[Dotnet-GitSync-Bot]

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, to please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

[eerhardt]

Looks good. Just a few minor clean ups and I think this is ready to merge.

[tarekgh]

I put a little suggestions, other than that LGTM.

[maryamariyan]

Note on LoggerColorBehavior usage:

The intention behind LoggerColorBehavior is to provide formatters with a way to configure when ANSI color encoding is allowed to get padded around logged messages.

Therefore, if the log message itself contains some ANSI color codes, that gets logged as-is and LoggerColorBehavior is NOT designed/meant to remove that.

Sample usage:

The gist sample here implements a custom formatter that does color formatting conditioned by LoggerColorBehavior. Compare that against the built-in implementation of SimpleConsoleFormatter, which skips color coding for log level here:

runtime/src/libraries/Microsoft.Extensions.Logging.Console/src/SimpleConsoleFormatter.cs

Lines 150 to 155 in 0f4ec15

	bool disableColors = (FormatterOptions.ColorBehavior == LoggerColorBehavior.Disabled) ||
	(FormatterOptions.ColorBehavior == LoggerColorBehavior.Default && System.Console.IsOutputRedirected);
	if (disableColors)
	{
	return new ConsoleColors(null, null);
	}

Hence, color coding logic within either formatters may be disabled using LoggerColorBehavior, but a call like:

logger.LogInformation("Random log \x1B[42mwith green background\x1B[49m message");

using either loggers will not strip out the padded color codes "\x1B[42m" and "\x1B[49m" within the message itself.