Documentation: std.logger: trace() not works by default

[denizzzka]

Unlike other logging methods, trace() doesn't outputs anything even if globalLogLevel is set without specifying this magic line:

(cast()sharedLog).logLevel = LogLevel.trace;

This is very deeply buried knowledge and I didn't find this in the documentation
Why is it designed by this way? Can anyone improve documentation at this direction?

[0xEAB]

@denizzzka
I believe this is documented here:

phobos/std/logger/package.d

Lines 61 to 63 in 12d8613

	The default `Logger` will by default log to `stderr` and has a default
	`LogLevel` of `LogLevel.info`. The default Logger can be accessed by
	using the property called `sharedLog`. This property is a reference to the

[0xEAB]

Why is it designed by this way?

It was decided that defaulting to a more liberal log level could potentially flood log outputs when third-party libraries (e.g. dependencies) come into play. Hence the default was changed.

See also: https://issues.dlang.org/show_bug.cgi?id=22532

I’m not exactly happy with status quo, but it is how it is.

[denizzzka]

I believe this is documented here:

It doesn’t seem to indicate that trace logger is null by default

I’m not exactly happy with status quo, but it is how it is.

Maybe comment as something like: pay attention, if you want the .trace to work don't forget to assign [and so on]

[0xEAB]

It doesn’t seem to indicate that trace logger is null by default

What do you mean?

[denizzzka]

What do you mean?

I don't see anything in that link that suggests the trace() needs to be pre-setted to use. Thus I assumed pointer to it is null by default, but that's not documented anywhere.

Overall, this whole situation is concerning, because when someone needs a trace, they don't have the time to figure out all these details.

[denizzzka]

If this is not a pointer, then what do we need globalLogLevel for? And why globalLogLevel.logLevel = LogLevel.trace not works as expected (by me)?

[Herringway]

If this is not a pointer, then what do we need globalLogLevel for? And why globalLogLevel.logLevel = LogLevel.trace not works as expected (by me)?

"Every log message with a LogLevel lower than the global LogLevel will be discarded before it reaches writeLogMessage method of any Logger. " - std.logger.core.globalLogLevel

On top of that, each logger may further set its own minimum log level. This is useful for a Logger instance that may only want to log errors, for example.

"The default Logger will by default log to stderr and has a default LogLevel of LogLevel.info." - std.logger