README.md

env_logger

This is a super simple project which aims to help out with setting up logging correctly in your project.

Currently it only supports logrus, but PR's are welcome to support additional loggers.

Usage

The project is fairly simple to use, you include it in your project as if it were a normal logging library. There are currently two ways to setup the log-library. The first is to simply call ConfigureDefaultLogger(). This will set everything up according to the rules specified below. The other is to pass in a preconfigured logger to the project via ConfigureLogger(logger *logrus.Logger) which will be used as the default logger.

The entire logging framework is configured via a single environment variable GOLANG_LOG. The variable is a comma delimited list of packages and their respective log-levels. (falling back to InfoLevel if not configured).

Examples

GOLANG_LOG=foo=debug,bar=warn go run

This configures the foo package at loglevel Debug, the bar package at loglevel Warn and the default/fallback logger at Info.

GOLANG_LOG=foo=info,debug,bar=warn go run

This is the same as the previous example, except foo is now at loglevel Info, and the default loglevel is Debug.

GOLANG_LOG=debug go run

This example sets everything to Debug.

TODO

• add an interface so that any logger can be injected as the canonical logger (currently only logrus is supported)

type Logger struct {
  New() -> Logger // used to instantiate a new logger
  Debug() // emit debug message
  Info()
  Warn()
  Panic()
}