logger

README

Logger for Go

Install

go get -u github.com/fitv/go-logger

Usage

package main

import (
    "github.com/fitv/go-logger"
)

func main() {
    fileWriter := logger.NewFileWriter(&logger.Option{
        Path:  "/app/web.log",
        Daily: true,
        Days:  7,
    })
    defer fileWriter.Close()

    log := logger.New()
    log.SetOutput(fileWriter)
    log.SetLevel(logger.DebugLevel)

    log.Debug("debug")
    log.Info("info")
    log.Warn("warn")
    log.Error("error")
    log.Panic("panic")
    log.Fatal("fatal")
}

Documentation

Index

• Constants
• Variables
• type FileWriter
  • func NewFileWriter(opt *Option) *FileWriter
  • func (l *FileWriter) Close() error
  • func (l *FileWriter) Write(p []byte) (n int, err error)
• type Level
  • func (l Level) String() string
• type Logger
  • func New() *Logger
  • func (l *Logger) Debug(args ...any)
  • func (l *Logger) Error(args ...any)
  • func (l *Logger) Fatal(args ...any)
  • func (l *Logger) Info(args ...any)
  • func (l *Logger) Log(level Level, args ...any)
  • func (l *Logger) Panic(args ...any)
  • func (l *Logger) SetLevel(level Level)
  • func (l *Logger) SetOutput(out io.Writer)
  • func (l *Logger) SetTimeLayout(layout string)
  • func (l *Logger) Warn(args ...any)
  • func (l *Logger) Write(p []byte) (n int, err error)
• type Option

Constants

const (
	DebugLevel = Level(iota)
	InfoLevel
	WarnLevel
	ErrorLevel
	PanicLevel
	FatalLevel
)

Variables

var LevelMap = map[Level]string{
	DebugLevel: "debug",
	InfoLevel:  "info",
	WarnLevel:  "warn",
	ErrorLevel: "error",
	PanicLevel: "panic",
	FatalLevel: "fatal",
}

LevelMap maps a level to a string.

Types

type FileWriter

type FileWriter struct {
	// contains filtered or unexported fields
}

func NewFileWriter

func NewFileWriter(opt *Option) *FileWriter

NewFileWriter creates a new FileWriter.

func (*FileWriter) Close

func (l *FileWriter) Close() error

Close closes the logger.

func (*FileWriter) Write

func (l *FileWriter) Write(p []byte) (n int, err error)

Write writes the log message.

type Level

type Level int

func (Level) String

func (l Level) String() string

String returns the string representation of the level.

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

func New

func New() *Logger

New creates a new Logger.

func (*Logger) Debug

func (l *Logger) Debug(args ...any)

Debug writes a message to the log using the DEBUG level.

func (*Logger) Error

func (l *Logger) Error(args ...any)

Error writes a message to the log using the ERROR level.

func (*Logger) Fatal

func (l *Logger) Fatal(args ...any)

Fatal writes a message to the log using the FATAL level. The process will exit with status set to 1.

func (*Logger) Info

func (l *Logger) Info(args ...any)

Info writes a message to the log using the INFO level.

func (*Logger) Log

func (l *Logger) Log(level Level, args ...any)

Log writes a message to the log using the given level.

func (*Logger) Panic

func (l *Logger) Panic(args ...any)

Panic writes a message to the log using the PANIC level. The process will panic after writing the message.

func (*Logger) SetLevel

func (l *Logger) SetLevel(level Level)

SetLevel sets the logger level.

func (*Logger) SetOutput

func (l *Logger) SetOutput(out io.Writer)

SetOutput sets the output writer.

func (*Logger) SetTimeLayout

func (l *Logger) SetTimeLayout(layout string)

SetTimeLayout sets the time layout.

func (*Logger) Warn

func (l *Logger) Warn(args ...any)

Warn writes a message to the log using the WARN level.

func (*Logger) Write

func (l *Logger) Write(p []byte) (n int, err error)

type Option

type Option struct {
	// Path of the log file. eg: /logs/app.log
	Path string

	// Whether to create a new file every day.
	Daily bool

	// Days is the number of days to keep log files.
	Days int
}