Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rookie-ninja/rk-logger
Log initializer written with goLang. See https://rkdev.info/docs/ for details.
https://github.com/rookie-ninja/rk-logger
go golang log logger logging rk zap
Last synced: 3 months ago
JSON representation
Log initializer written with goLang. See https://rkdev.info/docs/ for details.
- Host: GitHub
- URL: https://github.com/rookie-ninja/rk-logger
- Owner: rookie-ninja
- License: apache-2.0
- Created: 2020-06-30T03:38:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-19T17:50:18.000Z (about 2 years ago)
- Last Synced: 2024-06-18T20:12:02.802Z (8 months ago)
- Topics: go, golang, log, logger, logging, rk, zap
- Language: Go
- Homepage:
- Size: 62.5 KB
- Stars: 6
- Watchers: 0
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# rk-logger
[](https://github.com/rookie-ninja/rk-logger/actions/workflows/ci.yml)
[](https://codecov.io/gh/rookie-ninja/rk-logger)
[](https://goreportcard.com/report/github.com/rookie-ninja/rk-logger)
[](https://opensource.org/licenses/Apache-2.0)
Log initializer written with golang.
Currently, support zap logger as default logger and lumberjack as log rotation
- [zap](https://github.com/uber-go/zap)
- [lumberjack](https://github.com/natefinch/lumberjack)
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Installation](#installation)
- [Quick Start](#quick-start)
- [With Config file path](#with-config-file-path)
- [With Config as byte array](#with-config-as-byte-array)
- [With Config](#with-config)
- [Development Status: Stable](#development-status-stable)
- [Contributing](#contributing)
## Installation
`go get -u github.com/rookie-ninja/rk-logger`
## Quick Start
We combined zap config and lumberjack config in the same config file
Both of the configs could keep same format as it
In order to init zap logger with full log rotation, rk-logger support three different utility functions
- With zap+lumberjack config file path
- With zap+lumberjack config as byte array
- With zap config and lumberjack config
### With Config file path
config:
```yaml
---
level: debug
encoding: console
outputPaths:
- stdout
- logs/rk-logger.log
errorOutputPaths:
- stderr
initialFields:
initFieldKey: fieldValue
encoderConfig:
messageKey: messagea
levelKey: level
nameKey: logger
timeKey: time
callerKey: caller
stacktraceKey: stacktrace
callstackKey: callstack
errorKey: error
timeEncoder: iso8601
fileKey: file
levelEncoder: capital
durationEncoder: second
callerEncoder: full
nameEncoder: full
sampling:
initial: '3'
thereafter: '10'
maxsize: 1
maxage: 7
maxbackups: 3
localtime: true
compress: true
```
Example:
```go
func NewZapLoggerWithConfPathExample() {
// get current working directory
dir, _ := os.Getwd()
// init logger
logger, _, _ := rk_logger.NewZapLoggerWithConfPath(path.Clean(path.Join(dir, "/assets/zap.yaml")), rk_logger.YAML)
// use it
logger.Info("NewZapLoggerWithConfPathExample")
}
```
### With Config as byte array
Example:
```go
func NewZapLoggerWithBytesExample() {
bytes := []byte(`{
"level": "debug",
"encoding": "console",
"outputPaths": ["stdout", "logs/rk-logger.log"],
"errorOutputPaths": ["stderr"],
"initialFields": {"initFieldKey": "fieldValue"},
"encoderConfig": {
"messageKey": "message",
"levelKey": "level",
"nameKey": "logger",
"timeKey": "time",
"callerKey": "caller",
"stacktraceKey": "stacktrace",
"callstackKey": "callstack",
"errorKey": "error",
"timeEncoder": "iso8601",
"fileKey": "file",
"levelEncoder": "capital",
"durationEncoder": "second",
"callerEncoder": "full",
"nameEncoder": "full",
"sampling": {
"initial": "3",
"thereafter": "10"
}
},
"maxsize": 1,
"maxage": 7,
"maxbackups": 3,
"localtime": true,
"compress": true
}`)
logger, _, err := rk_logger.NewZapLoggerWithBytes(bytes, rk_logger.JSON)
logger.Info("NewZapLoggerWithBytesExample")
}
```
### With Config
```go
func NewZapLoggerWithConfExample() {
encodingConfig := zapcore.EncoderConfig{
TimeKey: "zap_timestamp",
LevelKey: "level",
NameKey: "logger",
CallerKey: "caller",
MessageKey: "msg",
StacktraceKey: "stacktrace",
LineEnding: zapcore.DefaultLineEnding,
EncodeLevel: zapcore.CapitalLevelEncoder,
EncodeTime: zapcore.ISO8601TimeEncoder,
EncodeDuration: zapcore.SecondsDurationEncoder,
EncodeCaller: zapcore.ShortCallerEncoder,
}
config := &zap.Config{
Level: zap.NewAtomicLevelAt(zap.InfoLevel),
EncoderConfig: encodingConfig,
OutputPaths: []string{"stdout", "logs/rk-logger.log"},
}
logger, _ := rk_logger.NewZapLoggerWithConf(config, &lumberjack.Logger{})
logger.Info("NewZapLoggerWithConfExample")
}
```
### Development Status: Stable
### Contributing
We encourage and support an active, healthy community of contributors —
including you! Details are in the [contribution guide](CONTRIBUTING.md) and
the [code of conduct](CODE_OF_CONDUCT.md). The rk maintainers keep an eye on
issues and pull requests, but you can also report any negative conduct to
[email protected].
Released under the [Apache 2.0 License](LICENSE).