Categorygithub.com/withmandala/go-log
modulepackage
0.1.0
Repository: https://github.com/withmandala/go-log.git
Documentation: pkg.go.dev

# README

Golang Logging Library

The colorful and simple logging library for Golang.

What is this

Opinionated logging library that able to output to io.Reader with file descriptors (os.Stdout, os.Stderr, regular file, etc.) with automatic terminal color support.

The log serverity and behavior can be described as follows:

SeverityDescriptionCaller Info
FatalUnrecoverable error and automatically exit after loggingYes
ErrorRecoverable error but need attentionYes
WarnMinor error and does not output the caller infoNo
InfoInformational messageNo
DebugDebug message, only shown when debug enabledYes
TraceTrace message, only shown when debug enabledNo

Getting started

Add the go-log package using

go get github.com/withmandala/go-log

And import it to your package by

import (
    "github.com/withmandala/go-log"
)

Use the go-log package with

logger := log.New(os.Stderr)
logger.Info("Hi, this is your logger")

Color support

The library will try to automatically detect the io.Reader file descriptor when calling log.New() for color support. But, if you insist to use or not to use color, you can add .WithColor() or .WithoutColor() respectively.

// With color
logger := log.New(os.Stderr).WithColor()

// Without color
logger := log.New(os.Stderr).WithoutColor()

Debug output

The log library will suppress the .Debug() and .Trace() output by default. To enable or disable the debug output, call (Logger).WithDebug() or (Logger).WithoutDebug() respectively.

// Enable debugging
logger := log.New(os.Stderr).WithDebug()
// Print debug output
logger.Debug("Test debug output")
// Disable debug output
logger.WithoutDebug()
logger.Debug("Test debug output") // This message will not be printed

Be Quiet

If somehow the log is annoying to you, just shush it by calling (Logger).Quiet() and ALL log output will be disappear, although .Fatal() will silently quit the program with error. To re-enable the log output use (Logger).NoQuiet().

# Packages

No description provided by the author
No description provided by the author

# Functions

New returns new Logger instance with predefined writer output and automatically detect terminal coloring support.

# Variables

DebugPrefix show info prefix.
ErrorPrefix show error prefix.
FatalPrefix show fatal prefix.
InfoPrefix show info prefix.
TracePrefix show info prefix.
WarnPrefix show warn prefix.

# Structs

Logger struct define the underlying storage for single logger.
Prefix struct define plain and color byte.

# Interfaces

FdWriter interface extends existing io.Writer with file descriptor function support.