logit

README

📝 logit

logit 是一个简单易用并且是基于级别控制的日志库，可以应用于所有的 GoLang 应用程序中。

Read me in English.

🥇 功能特性

• 支持日志级别控制，目前一共有四个日志级别
• 支持开启或者关闭日志功能，线上环境可以关闭或调高日志级别

🚀 安装方式

唯一需要的依赖就是 Golang 运行环境.

Go modules

$ go get -u github.com/FishGoddess/logit

您也可以直接编辑 go.mod 文件，然后执行 go build。

module your_project_name

go 1.14

require (
    github.com/FishGoddess/logit v0.0.3
)

Go path

$ go get -u github.com/FishGoddess/logit

logit 没有任何其他额外的依赖，纯使用 Golang 标准库 完成。

package main

import (
    "github.com/FishGoddess/logit"
)

func main() {
    
    // Log as you want.
    logit.Debug("I am a debug message! But I will not be logged in default level!")
    logit.Info("I am an info message!")
    logit.Warning("I am a warning message!")
    logit.Error("I am an error message!")
    
    // Change log level.
    logit.ChangeLevelTo(logit.DebugLevel)

    // If you want format your message, just add arguments!
    logit.Info("format info message! id = %d, content = %s", 1, "info!")
}

📖 参考案例

• basic
• logger
• enable_disable
• change_log_level

更多使用案例请查看 _examples 目录。

🔥 性能测试

$ go test -v -bench=. -benchtime=20s

测试	单位时间内运行次数 (large is better)	ns/op (small is better)	B/op (small is better)	allocs/op (small is better)
logit	4300000	5600 ns/op	904 B/op	12 allocs/op
Golang log	5150000	4769 ns/op	920 B/op	12 allocs/op

测试环境：I7-6700HQ CPU @ 2.6 GHZ，16 GB RAM

由于目前的 logit 是基于 Golang log 的，所以成绩相比更差，后续会重新设计内部日志输出模块，所以当前成绩仅供参考！

👥 贡献者

如果您觉得 logit 缺少您需要的功能，请不要犹豫，马上参与进来，发起一个 issue。

📦 使用 logit 的项目

项目	作者	描述

Documentation

Overview

Package logit provides an easy way to use foundation for your logging operations.

1. The basic usage:

// Log messages with four levels.
// Notice that the default level is info, so first line of debug message
// will not be logged! If you want to change level, see logit.ChangeLevelTo
logit.Debug("I am a debug message! But I will not be logged in default level!")
logit.Info("I am an info message!")
logit.Warning("I am a warning message!")
logit.Error("I am an error message!")

// Also, you can create a new independent Logger to use. See logit.NewLogger.

// If you want format your message, just add arguments!
logit.Info("format info message! id = %d, content = %s", 1, "info!")

2. logger:

// NewStdoutLogger creates a new Logger holder to standard output, generally a terminal or a console.
logger := logit.NewStdoutLogger(logit.DebugLevel)

// Then you will be easy to log!
logger.Debug("this is a debug message!")
logger.Info("this is a info message!")
logger.Warning("this is a warning message!")
logger.Error("this is a error message!")

// NewLogger creates a new Logger holder.
// The first parameter "os.Stdout" is a writer for logging.
// As you know, file also can be written, just replace "os.Stdout" with your file!
// The second parameter "logit.DebugLevel" is the level of this Logger.
logger = logit.NewLogger(os.Stdout, logit.DebugLevel)

// If you want format your message, just add arguments!
logger.Info("format info message! id = %d, content = %s", 1, "info!")

3. enable or disable:

// Every new Logger is running.
logger := logit.NewLogger(os.Stdout, logit.DebugLevel)
logger.Info("I am running!")

// Shutdown the Logger.
// So the info message next line will not be logged!
logger.Disable()
logger.Info("I will not be logged!")

// Enable the Logger.
// The info message next line will be logged again!
logger.Enable()
logger.Info("I am running again!")

4. change log level:

logit.Debug("Default log level is info, so debug message will not be logged!")

// Change log level to debug level.
logit.ChangeLevelTo(logit.DebugLevel)

logit.Debug("Now debug message will be logged!")

Index

• Constants
• func ChangeLevelTo(level LogLevel)
• func Debug(msg string, args ...interface{})
• func Disable()
• func Enable()
• func Error(msg string, args ...interface{})
• func Info(msg string, args ...interface{})
• func Warning(msg string, args ...interface{})
• type LogLevel
• type Logger
  • func NewLogger(out io.Writer, level LogLevel) *Logger
  • func NewStdoutLogger(level LogLevel) *Logger
  • func (l *Logger) ChangeLevelTo(newLevel LogLevel)
  • func (l *Logger) Debug(msg string, args ...interface{})
  • func (l *Logger) Disable()
  • func (l *Logger) Enable()
  • func (l *Logger) Error(msg string, args ...interface{})
  • func (l *Logger) Info(msg string, args ...interface{})
  • func (l *Logger) Warning(msg string, args ...interface{})

Constants

const Version = "0.0.3"

Version is the version string representation of the "logit" package.

Functions

func ChangeLevelTo

func ChangeLevelTo(level LogLevel)

ChangeLevelTo will change the level of logit to newLevel.

func Debug

func Debug(msg string, args ...interface{})

Debug will output msg as a debug message.

func Disable

func Disable()

Disable sets logit on shutdown status.

func Enable

func Enable()

Enable sets logit on running status.

func Error

func Error(msg string, args ...interface{})

Error will output msg as an error message.

func Info

func Info(msg string, args ...interface{})

Info will output msg as an info message.

func Warning

func Warning(msg string, args ...interface{})

Warning will output msg as a warning message.

Types

type LogLevel

type LogLevel uint8

LogLevel is the type representation of the level.

const (
	DebugLevel LogLevel = iota
	InfoLevel
	WarningLevel
	ErrorLevel
)

Constants about log level.

type Logger

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

Logger is a struct based on "log.Logger".

func NewLogger

func NewLogger(out io.Writer, level LogLevel) *Logger

NewLogger create one Logger with given out and level. The first parameter out is a writer for logging. The second parameter level is the level of this Logger. It returns a new running Logger holder.

func NewStdoutLogger

func NewStdoutLogger(level LogLevel) *Logger

NewStdoutLogger returns a Logger holder with given log level.

func (*Logger) ChangeLevelTo

func (l *Logger) ChangeLevelTo(newLevel LogLevel)

ChangeLevelTo will change the level of current Logger to newLevel.

func (*Logger) Debug

func (l *Logger) Debug(msg string, args ...interface{})

Debug will output msg as a debug message.

func (*Logger) Disable

func (l *Logger) Disable()

Disable sets l on shutdown status.

func (*Logger) Enable

func (l *Logger) Enable()

Enable sets l on running status.

func (*Logger) Error

func (l *Logger) Error(msg string, args ...interface{})

Error will output msg as an error message.

func (*Logger) Info

func (l *Logger) Info(msg string, args ...interface{})

Info will output msg as an info message.

func (*Logger) Warning

func (l *Logger) Warning(msg string, args ...interface{})

Warning will output msg as a warning message.