pion / logging Goto Github PK

pion/logging has been really useful for me, and using a lot for debugging.
@Sean-Der expressed his concern about its performance, and I'd agree, that is a concern...

For example, if you have this statement:

	logger.Debug("received data %s", pkt.String())

It looks alright, and it is just a debug log that only prints out when it is enabled with PION_LOG_DEBUG...

BUT! What if pkt.String() was an expensive routine? This is evaluated no matter what, consuming CPU time in production as well... Unfortunately, go has no compile-time options like C has (#ifdef etc.)

One obvious solution would be to use a callback like this:

	logger.Debug(func (p *LoggerPad) {
		p.Format("received data %s", pkt.String())
	})

The Debug function can be designed in a way that the callback function passed in it won't be called if it is not set to DEBUG level. You will need to type a lot more but it saves a lot of CPU time!

Summary

Provide a way to disable logging completely.

Motivation

Default logging is currently set to ERROR. In order to disable logging completely, we need to use API to configure a custom logger factory.

Describe alternatives you've considered

Set the default logging level to "disabled"

If we were to keep the default logging level as Error and allow users to use env vars by default, then we should provide a way to disable the logging completely with the env var.

diff --git a/logger.go b/logger.go
index d3c0156..3e07cdd 100644
--- a/logger.go
+++ b/logger.go
@@ -181,11 +181,12 @@ func NewDefaultLoggerFactory() *DefaultLoggerFactory {
        factory.Writer = os.Stdout

        logLevels := map[string]LogLevel{
-               "ERROR": LogLevelError,
-               "WARN":  LogLevelWarn,
-               "INFO":  LogLevelInfo,
-               "DEBUG": LogLevelDebug,
-               "TRACE": LogLevelTrace,
+               "DISABLED": LogLevelDisabled,
+               "ERROR":    LogLevelError,
+               "WARN":     LogLevelWarn,
+               "INFO":     LogLevelInfo,
+               "DEBUG":    LogLevelDebug,
+               "TRACE":    LogLevelTrace,
        }

        for name, level := range logLevels {

Ideally, we should set the default level to "Disabled" IMO. (keep the current default)

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: undefined. Note: this is a nested preset so please contact the preset author if you are unable to fix it yourself.

This issue provides visibility into Renovate updates and their statuses. Learn more

This repository currently has no open or pending branches.

• Check this box to trigger a request for Renovate to run again on this repository

I think it may be as easy as a File writer instead of stdout, but in that case we need to document it in
an example

Summary

Avoid using globals & init and enable the corresponding linters.