Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/auula/sprout
Golang logging library supporting log retrieval.
https://github.com/auula/sprout
color file golang golang-library golang-package linux log logfile logger logging websoket windows
Last synced: 2 months ago
JSON representation
Golang logging library supporting log retrieval.
- Host: GitHub
- URL: https://github.com/auula/sprout
- Owner: auula
- License: mit
- Created: 2020-04-17T08:10:18.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-05T12:02:31.000Z (over 3 years ago)
- Last Synced: 2024-04-17T15:20:02.277Z (10 months ago)
- Topics: color, file, golang, golang-library, golang-package, linux, log, logfile, logger, logging, websoket, windows
- Language: Go
- Homepage:
- Size: 119 KB
- Stars: 82
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
### ⚠️ 本库是本人在入坑go一个星期的时候写出来的，代码质量有点差，谨慎使用！，后面有空将会重构。
LogKer
LogKer It's a log Library of Golang. It's easy to use.👨💻
📚中文说明 |
🤩Document |
👨💻 Release
---
## Video link
- [哔哩哔哩](https://www.bilibili.com/video/BV1WZ4y1s7zD?t=2)
## Features
- Support file backup.
- Simple and easy to use.
- Support file storage log.
- Support console color printing.
- Custom log file storage location.
- Support setting time and time zone.
- Support log file size for split storage.
- Error level output to specified file separately.
- Four levels of `debug` `info` `error` `warning` are supported.
- `Future support: The remote computer stores the socket output🙏.`
- `The project is constantly maintained and updated. I like 😍A kind of Please click star Thanks♪(･ω･)ﾉ!`
- Is this you?😜
## Upgrade List
- [v1.1.5](https://github.com/Higker/logker/releases/tag/v1.1.5) Support for custom message formats.(SerialVersion) [issues1](https://github.com/Higker/logker/issues/1)
- [v1.1.8](https://github.com/Higker/logker/releases/tag/v1.1.8) Support coroutine to record logs,The code base is smaller and lighter(AsynchronousProcessingVersion).
## Historical Documents
> The Documents version is v1.1.8
- [PPT](https://www.kdocs.cn/l/sGu6KjnJW)
- [v1.1.5 Doc](https://github.com/Higker/logker/blob/master/readme_v1.1.5.md)
## Installation
🔝 The minimum requirement of Go version is **1.11**.
🔝 Your project also uses go module!!!
```shell script
go get github.com/higker/logker
```
OR
```shell script
go get -u github.com/higker/logker
```
command add `-u` flag to update in the future.
## Use Example
#### 1. File Logger
```go
package main
import (
klog "github.com/higker/logker"
"time"
)
func main() {
// Specify file location! Create folder in advance!!
dir := "/Users/ding/Documents/test_log"
// New file logger
// File Max size : You can also use built-in constants
// klog.GB1 = 1GB
// klog.MB10 = 10MB
// klog.MB100 = 100MB
format := "{level} - DATE {time} - POS {position} - MSG {message}" //This version was modified from v 1.1.5
//Create Log Buffer
task := InitAsync(Qs1w)
flog,e := klog.NewFlog(klog.DEBUG, true, klog.Shanghai, dir, "log", 10*1024, 0777,format,task)
if e != nil{
.... //Custom Operation
}
// Analog output log
for {
flog.Debug("DEBUG : %d + %d = %d",1,2,1+2)
flog.Error("ERROR")
flog.Warning("WARNING %p",flog)
flog.Info("INFO %s","Hello LogKer.")
time.Sleep(2 * time.Second)
}
}
```
> 👆Parameter note List:
```go
// Build File logger
// Args note
// logLevel: lev, \\ logging level
// wheError: wheErr, \\ whether enable error alone file
// directory: dir, \\ logging file save directory
// fileName: fileName, \\ logging save file name
// timeZone: zone, \\ load time zone format
// power: power, \\ file system power
// fileMaxSize: size, \\ logging alone file max size
// task := InitAsync(Qs1w) \\ createsABufferForCoroutineLogProcessing
// format :
// Now upgrade to version v 1.1.5 to customize the message output format ~
// TheCustomTagNameMustBe {level} {time} {position} {message}
// The location of the custom label is the location
// where the program outputs the corresponding log message at run time！！！！
// forExampleHereIsMyCustom
// 1. //format := "{level} - {time} - {position} - {message}"
```
#### 2. Console Logger
```go
package main
import (
"github.com/higker/logker"
"strings"
)
//type Formatting string
// logKer library Test
func main() {
// Now upgrade to version v 1.1.5 to customize the message output format ~
// TheCustomTagNameMustBe {level} {time} {position} {message}
// The location of the custom label is the location
// where the program outputs the corresponding log message at run time！！！！
// forExampleHereIsMyCustom
// 1. //format := "{level} - {time} - {position} - {message}"
format := "{level} - 时间 {time} - 位置 {position} - 消息 {message}" //This version was modified from v 1.1.5
//Create Log Buffer
task := InitAsync(Qs1w)
log,e := logker.NewClog(logker.DEBUG, logker.Shanghai, format,task)
if e != nil{
..... //Custom Operation
}
log.Debug("DEBUG %s","自定义日志消息匹配符测试")
log.Info("%v", log)
log.Warning("%v", logker.Shanghai)
log.Error("ERROR")
}
```
## OutPut
```shell
[ DEBUG ] - 时间 2020-04-20 11:57:23.8927 - 位置 main.go|main.main:23 - 消息 DEBUG 自定义日志消息匹配符测试
[ INFO ] - 时间 2020-04-20 11:57:23.8928 - 位置 main.go|main.main:24 - 消息 &{0 Asia/Shanghai 0xc00008e220 {level} - 时间 {t位置 {position} - 消息 {message}}
[WARNING] - 时间 2020-04-20 11:57:23.8928 - 位置 main.go|main.main:25 - 消息 Asia/Shanghai
[ ERROR ] - 时间 2020-04-20 11:57:23.8929 - 位置 main.go|main.main:26 - 消息 ERROR
```
#### 3. Effect:
> The screenshot is not updated ~ The current screenshot is v1.0.9 version,
> you can install the library yourself to see the effect.
## Thank list🤝
- fatih (https://github.com/fatih/color)
- Icon Mafia (Logo & Banner design)
- When are you? 😜
## Other
- `Welcome to submit work order👏`
- `Pkg Docs: `[click to pkg.go.dev](https://pkg.go.dev/github.com/higker/logker?tab=doc)
## License
This project open source is MIT License
. See the [LICENSE](LICENSE) file content.