https://github.com/markdumay/go-log
Simplified application logger powered by zerolog
https://github.com/markdumay/go-log
golang logging
Last synced: 23 days ago
JSON representation
Simplified application logger powered by zerolog
- Host: GitHub
- URL: https://github.com/markdumay/go-log
- Owner: markdumay
- License: mit
- Created: 2021-09-13T08:20:04.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-07-31T05:12:49.000Z (almost 3 years ago)
- Last Synced: 2026-04-03T10:58:38.019Z (3 months ago)
- Topics: golang, logging
- Language: Go
- Homepage: https://pkg.go.dev/go.markdumay.org/log
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-log
Simplified application logger powered by zerolog
About •
Built With •
Prerequisites •
Installation •
Usage •
Contributing •
Donate •
License
## About
go-log is a simplified logger package for Go applications. Using the Zero Allocation JSON Logger (zerolog) under the hood, it simplifies the logging of application-wide messages. It supports three logging modes: Default, Pretty, and JSON. Logs are directed to the console by default, but can be buffered or redirected to a log file instead.
## Built With
The project uses the following core software components:
* [Zero Allocation JSON Logger][zerolog_url] - Go package providing a fast and simple logger dedicated to JSON output.
* [Testify][testify_url] - Go unit-testing toolkit with common assertions and mocks.
## Prerequisites
go-log requires Go version 1.16 or later to be installed on your system.
## Installation
```console
go get -u go.markdumay.org/log
```
## Usage
Import go-log into your application to start using the logger. By default, go-log writes the log messages to the console. Please refer to the [package documentation][package] for more details. The following code snippet illustrates the basic usage of go-log.
```go
package main
import (
"go.markdumay.org/log"
)
func main() {
// show an info message using default formatting, expected output:
// This is an info log
log.Info("This is an info log")
// show an error message using default formatting, expected output:
// ERROR Error message
log.Info("Error message")
// switch to pretty formatting
log.InitLogger(log.Pretty)
// show a warning using pretty formatting, expected output:
// 2006-01-02T15:04:05Z07:00 | WARN | Warning
log.Warn("Warning")
// switch to JSON formatting
log.InitLogger(log.JSON)
// switch to debug level as minimum level
log.SetGlobalLevel(log.DebugLevel)
// show a debug message using JSON formatting, expected output:
// {"level":"debug","time":"2006-01-02T15:04:05Z07:00","message":"Testing level debug"}
log.Debugf("Testing level %s", "debug")
}
```
## Contributing
go-log welcomes contributions of any kind. It is recommended to create an issue to discuss your intended contribution before submitting a larger pull request though. Please consider the following guidelines when contributing:
- Address all linting recommendations from `golangci-lint run` (using `.golangci.yml` from the repository).
- Ensure the code is covered by one or more unit tests (using [Testify][testify_url] when applicable).
- Follow the recommendations from [Effective Go][effective_go] and the [Uber Go Style Guide][uber_go_guide].
The following steps decribe how to submit a Pull Request:
1. Clone the repository and create a new branch
```console
$ git checkout https://github.com/markdumay/go-log.git -b name_for_new_branch
```
2. Make and test the changes
3. Submit a Pull Request with a comprehensive description of the changes
## Donate
## License
The go-log codebase is released under the [MIT license][license]. The documentation (including the "README") is licensed under the Creative Commons ([CC BY-NC 4.0)][cc-by-nc-4.0] license.
[cc-by-nc-4.0]: https://creativecommons.org/licenses/by-nc/4.0/
[effective_go]: https://golang.org/doc/effective_go
[testify_url]: https://github.com/stretchr/testify
[uber_go_guide]: https://github.com/uber-go/guide/
[zerolog_url]: https://github.com/rs/zerolog
[blog]: https://github.com/markdumay
[license]: https://github.com/markdumay/go-log/blob/main/LICENSE
[package]: https://pkg.go.dev/go.markdumay.org/log
[repository]: https://github.com/markdumay/go-log.git