golog

README

Golog

Introduction

Golog is a very simple logging library for Go. It is designed to be simple to use and to be easy to integrate into existing projects.

---

Installation

To install Golog, simply run the following command:

go get github.com/AndreGKruger/golog

---

Usage

To use Golog, simply import the package into your project:

import "github.com/AndreGKruger/golog"

Then, to create a new logger, simply call the New function:

logger := golog.New()

To log a debug message, simply call the Debug function:

logger.Debug("This is a debug message")

or logger.Debug("This is a debug message with arguments", arg1, arg2, arg3)

To log an info message, simply call the Info function:

logger.Info("Hello, world!")

or logger.Info("Hello, world! with arguments", arg1, arg2, arg3)

To log a warning message, simply call the Warn function:

logger.Warn("Hello, world!")

or logger.Warn("Hello, world! with arguments", arg1, arg2, arg3)

To log an error message, simply call the Error function:

logger.Error("Hello, world!")

or logger.Error("Hello, world! with arguments", arg1, arg2, arg3)

---

Example output

Input

log := New()
    cnf := Config{
        LogEnvironment: CONFIG_ENV_DEVELOPMENT,
        LogFileName:    "test.log",
        OutputFormat:   CONFIG_OUTPUT_FORMAT_JSON,
        LogTo:          CONFIG_LOG_TO_FILE,
    }
    log.Debug("sample log message", cnf)

Output

[ 2022/09/20 17:07:07 ] - [ENV:development] - [DEBUG]: sample log message  - [ARGS]: [{LogTo:4 OutputFormat:1 LogFileName:test.log LogEnvironment:development writer:<nil>}]

---

Configuration

Golog can be configured to log to a file, to log to the console, or both. To configure Golog, simply call the Configure function:

ok, err := logger.Configure(golog.Config{
    LogEnvironment: golog.CONFIG_ENV_DEVELOPMENT,
    LogFileName:    "log.txt",
    LogTo:          golog.CONFIG_LOG_TO_CONSOLE,
    OutputFormat:   golog.CONFIG_OUTPUT_FORMAT_TEXT,
})

Json Output Format can be configured by passing the OUTPUT_FORMAT_JSON constant to the OutputFormat field of the Config struct:

OutputFormat: golog.CONFIG_OUTPUT_FORMAT_JSON,

---

Environment logging

By default Golog will use the environment variable GOLOG_ENV to determine the log level. The following values are supported:

GOLOG_ENV=development
GOLOG_ENV=staging
GOLOG_ENV=production

The GOLOG_ENV will override the environment variable that is set during the SetEnvironment function: logger.SetEnvironment(golog.DEVELOPMENT)

---

Log Levels

Golog supports the following log levels:

CONFIG_LOG_LEVEL_DEBUG
CONFIG_LOG_LEVEL_INFO
CONFIG_LOG_LEVEL_WARN
CONFIG_LOG_LEVEL_ERROR

By default the following matrix of log levels and environments is used:

CONFIG_LOG_LEVEL_DEBUG: development
CONFIG_LOG_LEVEL_INFO: development, staging
CONFIG_LOG_LEVEL_WARN: development, staging, production
CONFIG_LOG_LEVEL_ERROR: development, staging, production

---

Contributing

If you would like to contribute to Golog, please fork the repository and submit a pull request.

---

License

GNU General Public License v3.0 or later A copy of the license is available in the repository's LICENSE file.

---

Documentation

Index

• Constants
• type Config
• type Log
  • func New() Log

Constants

const (
	CONFIG_ENV_DEVELOPMENT = "development"
	CONFIG_ENV_STAGING     = "staging"
	CONFIG_ENV_PRODUCTION  = "production"
)

Supported GOLOG_ENV values

const (
	// OutputFormat constants
	CONFIG_OUTPUT_FORMAT_JSON = iota + 1
	CONFIG_OUTPUT_FORMAT_TEXT
	// LogTo constants
	CONFIG_LOG_TO_CONSOLE
	CONFIG_LOG_TO_FILE
	// Supported LogLevels
	CONFIG_LOG_LEVEL_DEBUG
	CONFIG_LOG_LEVEL_INFO
	CONFIG_LOG_LEVEL_WARN
	CONFIG_LOG_LEVEL_ERROR
)

Types

type Config

type Config struct {
	LogTo          uint
	OutputFormat   uint
	LogFileName    string
	LogEnvironment string
	// contains filtered or unexported fields
}

type Log

type Log interface {
	Debug(message string, args ...any)
	Info(message string, args ...any)
	Warn(message string, args ...any)
	Error(message string, args ...any)
	Configure(*Config) (bool, error)
}

func New

func New() Log

Returns a new Log instance with default configuration