# logit **Repository Path**: xianlei211/logit ## Basic Information - **Project Name**: logit - **Description**: 使用 Go 编写的高性能可扩展的日志库 - A high-performance and extensible logging foundation for Go applications - **Primary Language**: Go - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 14 - **Created**: 2023-04-19 - **Last Updated**: 2023-04-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # 📝 logit [![Go Doc](_icons/godoc.svg)](https://pkg.go.dev/github.com/FishGoddess/logit) [![License](_icons/license.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) [![Coverage](_icons/coverage.svg)](_icons/coverage.svg) ![Test](https://github.com/FishGoddess/logit/actions/workflows/test.yml/badge.svg) **logit** is a level-based, high-performance and pure-structured logger for all [GoLang](https://golang.org) applications. [阅读中文版的 Read me](./README.md) ### 🥇 Features * Modularization design, easy to extend your logger with appender and writer. * Level-based logging, and there are five levels to use: debug, info, warn, error, print, off. * Key-Value structured log supports, also supporting format. * Support logging as Text/Json string, by using provided appender. * Asynchronous write back supports, providing high-performance Buffer writer to avoid IO accessing. * Provide global optimized settings, let some settings feet your business. * Every level has its own appender and writer, separating process error logs is recommended. * Context binding supports, using logger is more elegant. * Configuration plugins supports, ex: yaml plugin can create logger from yaml configuration file. * Interceptor supports which can inject values from context. * Error handling supports which can let you count errors and report them. * Rotate file supports, clean automatically if files are aged or too many. * Config file supports, such as json/yaml/toml/bson. _Check [HISTORY.md](./HISTORY.md) and [FUTURE.md](./FUTURE.md) to know about more information._ ### 🚀 Installation ```bash $ go get -u github.com/FishGoddess/logit ``` ### 📖 Examples ```go package main import ( "context" "io" "os" "github.com/FishGoddess/logit" ) func main() { // Create a new logger for use. // Default level is debug, so all logs will be logged. // Invoke Close() isn't necessary in all situations. // If logger's writer has buffer or something like that, it's better to invoke Close() for syncing buffer or something else. logger := logit.NewLogger() //defer logger.Close() // Then, you can log anything you want. // Remember, logs will be ignored if their level is smaller than logger's level. // Log() will do some finishing work, so this invocation is necessary. logger.Debug("This is a debug message").Log() logger.Info("This is an info message").Log() logger.Warn("This is a warn message").Log() logger.Error(nil, "This is an error message").Log() logger.Error(nil, "This is a %s message, with format", "error").Log() // Format with params. // As you know, we provide some levels: debug, info, warn, error, off. // The lowest is debug and the highest is off. // If you want to change the level of your logger, do it at creating. logger = logit.NewLogger(logit.Options().WithWarnLevel()) logger.Debug("This is a debug message, but ignored").Log() logger.Info("This is an info message, but ignored").Log() logger.Warn("This is a warn message, not ignored").Log() logger.Error(nil, "This is an error message, not ignored").Log() // Also, we provide some "old school" log method :) // (Don't mistake~ I love old school~) logger.Printf("This is a log %s, and it's for compatibility", "printed") logger.Print("This is a log printed, and it's for compatibility", 123) logger.Println("This is a log printed, and it's for compatibility", 666) // If you want to log with some fields, try this: user := struct { ID int64 `json:"id"` Name string `json:"name"` Age int `json:"age"` }{ ID: 666, Name: "FishGoddess", Age: 3, } logger.Warn("This is a structured message").Any("user", user).Json("userJson", user).Log() logger.Error(io.EOF, "This is a structured message").Int("trace", 123).Log() // You may notice logit.Options() which returns an options list. // Here is some of them: options := logit.Options() options.WithCaller() // Let logs carry caller information. options.WithLevelKey("lvl") // Change logger's level key to "lvl". options.WithWriter(os.Stderr) // Change logger's writer to os.Stderr without buffer or batch. options.WithBufferWriter(os.Stderr) // Change logger's writer to os.Stderr with buffer. options.WithBatchWriter(os.Stderr) // Change logger's writer to os.Stderr with batch. options.WithErrorWriter(os.Stderr) // Change logger's error writer to os.Stderr without buffer or batch. options.WithTimeFormat("2006-01-02 15:04:05") // Change the format of time (Only the log's time will apply it). // You can bind context with logger and use it as long as you can get the context. ctx := logit.NewContext(context.Background(), logger) logger = logit.FromContext(ctx) logger.Info("Logger from context").Log() // You can initialize the global logger if you don't want to use an independent logger. logger = logit.NewLogger() logit.SetGlobal(logger) logit.Info("Info from logit").Log() // Actually, we recommend you to call logger.SetToGlobal to set one logger to global if you need. logger = logit.NewLogger().SetToGlobal() logit.Println("Println from logit") } ``` _More examples can be found in [_examples](./_examples)._ ### 🔥 Benchmarks ```bash $ make bench $ make benchfile ``` | test case(output to memory) | times ran (large is better) | ns/op (small is better) | B/op | allocs/op | |-----------------------------|-----------------------------|-------------------------|---------------------------------|-------------------------------| | **logit** | **707851** | **  1704 ns/op** | **      0 B/op** | **    0 allocs/op** | | zerolog | 706714 |   1585 ns/op |       0 B/op |     0 allocs/op | | zap | 389608 |   4688 ns/op |   865 B/op |     8 allocs/op | | logrus |   69789 | 17142 ns/op | 8885 B/op | 136 allocs/op | | test case(output to file) | times ran (large is better) | ns/op (small is better) | B/op | allocs/op | |---------------------------|-----------------------------|-------------------------|---------------------------------|-------------------------------------------| | **logit** | **636033** | **  1822 ns/op** | **      0 B/op** | **    0 allocs/op** | | **logit-withoutBuffer** | **354542** | **  3502 ns/op** | **      0 B/op** | **    0 allows/op** | | zerolog | 354676 |   3440 ns/op |       0 B/op |     0 allocs/op | | zap | 195354 |   6843 ns/op |   865 B/op |     8 allocs/op | | logrus |   58030 | 21088 ns/op | 8885 B/op | 136 allocs/op | > Benchmark file：[_examples/performance_test.go](./_examples/performance_test.go) > > Environment：R7-5800X CPU@3.8GHZ, 32GB RAM, 512GB SSD, Linux/Manjaro ### 👥 Contributing If you find that something is not working as expected please open an _**issue**_. ### 📦 Projects using logit | Project | Author | Description | link | |---------|-------------|-------------------------------------------------|-----------------------------------------------------------------------------------------------| | postar | avino-plan | An easy-to-use and low-coupling email service | [Github](https://github.com/avino-plan/postar) / [Gitee](https://gitee.com/avino-plan/postar) | | kafo | FishGoddess | An easy-to-use and distributed cache middleware | [Github](https://github.com/FishGoddess/kafo) / [Gitee](https://gitee.com/FishGoddess/kafo) | At last, I want to thank JetBrains for **free JetBrains Open Source license(s)**, because `logit` is developed with Idea / GoLand under it.