README
¶
Utility library for logs (Go)
This a very simple utility library to create configurable loggers that can be nested.
Installation
To install the library in your project, run:
go get github.com/AgustinSRG/glog
Usage
In the main function, create a root logger with the CreateRootLogger(config) function, passing the configuration as argument, which allows to enable or disable each specific level of log: ERROR, WARNING, INFO, DEBUG, TRACE.
You can then call the CreateChildLogger(prefix) on the root logger to create logger with the same configuration, but adding a prefix. For example, logs for the example function may have the [ExampleFunction] prefix to better locate the logs.
Once you have the logger, you may call its methods to add logs.
Example:
package main
import (
// Import the module
"github.com/AgustinSRG/glog"
)
func main() {
// Create a root logger
logger := glog.CreateRootLogger(glog.CreateLoggerConfigurationFromLevel(glog.INFO), glog.StandardLogFunction)
// Log messages
logger.Info("Example log message")
// You can also log with format
logger.Infof("Example log message: %v, %v, %v", 4, "example string", true)
// If you log a level that is not enabled, no logs will be made
logger.Debug("Example debug message")
// You can also check the config to prevent running the function if disabled
if logger.Config.DebugEnabled {
logger.Debug("Example debug message")
}
// You can create child loggers, to include prefixes
childLogger := logger.CreateChildLogger("[PREFIX] ")
// This will log: [PREFIX] Example log message
childLogger.Info("Example log message")
}
Build the library
To install dependencies, run:
go get .
To build the code, run:
go build .
Run linter
To run the code linter, run:
golangci-lint run
Run tests
In order to run the tests for this library, run:
go test -v
Documentation
¶
Index ¶
- Constants
- func LevelFromString(str string) (int, error)
- func LevelToString(level int) string
- func StandardLogFunction(level int, message string)
- type Logger
- func (logger *Logger) CreateChildLogger(prefix string) *Logger
- func (logger *Logger) Debug(message string)
- func (logger *Logger) Debugf(format string, a ...any)
- func (logger *Logger) Error(message string)
- func (logger *Logger) Errorf(format string, a ...any)
- func (logger *Logger) Info(message string)
- func (logger *Logger) Infof(format string, a ...any)
- func (logger *Logger) Log(level int, message string)
- func (logger *Logger) Trace(message string)
- func (logger *Logger) Tracef(format string, a ...any)
- func (logger *Logger) Warning(message string)
- func (logger *Logger) Warningf(format string, a ...any)
- type LoggerConfiguration
Constants ¶
const DEBUG int = 4
Debug level
const ERROR int = 1
Error level
const INFO int = 3
Info level
const SILENT int = 0
Silent level (no logs)
const TRACE int = 5
Trace level
const WARNING int = 2
Warning level
Variables ¶
This section is empty.
Functions ¶
func LevelFromString ¶
Parses level from string (case insensitive)
Parameters: - str: The string to parse
Returns the parsed level, or an error if the value has an invalid format
func LevelToString ¶
Turns level from int to string
Parameters: - level: The level
Returns the level as string
func StandardLogFunction ¶
Standard log function to log messages using the "log" package
Parameters: - level: The log level - message: The log message
Types ¶
type Logger ¶
type Logger struct {
// Logger configuration
Config LoggerConfiguration
// Prefix for logs
Prefix string
// Log function
LogFunc func(level int, message string)
}
Logger
func CreateRootLogger ¶
func CreateRootLogger(config LoggerConfiguration, logFunc func(level int, message string)) *Logger
Creates a root logger
Parameters: - config: The logger configuration - logFunc: The function to log the messages. By default, use glog.StandardLogFunction
Returns a Logger instance
func (*Logger) CreateChildLogger ¶
Creates child logger, adding a prefix to the logs of the parent logger
Parameters: - prefix: The prefix for the logs
Returns a Logger instance
func (*Logger) Debugf ¶
Logs an DEBUG message (with format)
Parameters: - format: The message format - a: The parameters to be used in the format
Example:
logger.Debugf("The value of the intermediate value is: %v", value)
func (*Logger) Errorf ¶
Logs an ERROR message (with format)
Parameters: - format: The message format - a: The parameters to be used in the format
Example:
logger.Errorf("An error happened in the request to %v | %v", url, error.Error())
func (*Logger) Infof ¶
Logs an INFO message (with format)
Parameters: - format: The message format - a: The parameters to be used in the format
Example:
logger.Infof("Received request from: %v", ip)
func (*Logger) Tracef ¶
Logs an TRACE message (with format)
Parameters: - format: The message format - a: The parameters to be used in the format
Example:
logger.Tracef("DB Query: %v", query)
type LoggerConfiguration ¶
type LoggerConfiguration struct {
// True to enable ERROR messages
ErrorEnabled bool
// True to enable WARNING messages
WarningEnabled bool
// True to enable INFO messages
InfoEnabled bool
// True to enable DEBUG messages
DebugEnabled bool
// True to enable TRACE messages
TraceEnabled bool
}
Logger configuration
func CreateLoggerConfigurationFromLevel ¶
func CreateLoggerConfigurationFromLevel(level int) LoggerConfiguration
Creates a configuration from a level
Parameters: - level: The lowest level to log
Returns a configuration with all the levels lower then the specified disabled
Source Files