How should client apps properly mute log message emitted by your package?

[atc0005]

I'm fairly new to Go still, so there is probably an obvious way to handle this, but is there an easy way to mute log messages generated by your package when errors are encountered?

For example:

go-teams-notify/send.go

Lines 49 to 54 in feea812

	// do the request
	res, err := c.httpClient.Do(req)
	if err != nil {
	log.Println(err)
	return err
	}

Here the message is both logged and returned to the caller. From my app I've got the error message that was returned, but I also get the log output.

To work around that I've used an approach like this to temporarily mute all log output:

    log.SetOutput(ioutil.Discard)
    if err := sendMessage(webhook.WebhookURL, msgCard); err != nil {
        // our error handling here
    }
    log.SetOutput(os.Stdout)

Is this the recommended approach, or is there a way to more directly target log messages generated by this package?

Thanks in advance for your time.

[dasrick]

You are right. This package should only return an error instead of doing both (logging and returning).
I will take it into one of the next changes ...

[atc0005]

Awesome, thank you.

I did some digging last night to see if Go handles this in the same way as Python does and got back mixed information. One example I did find common to both was setting up a package level (exported) logger instance/object and setting its output to disabled by default. The package user could then opt to enable the package-level logger if they need to see relevant troubleshooting/verbose details from the package. Not sure if that's overkill for this package or if it would be "freeing" in a sense to allow for more potential logging.

I think I might be rambling at this point, so I'll leave off here.

[dasrick]

solved in versions

• v1.3.1 (remove log or error, dep update #8)
• v2.0.0 (v2 #9)