Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpmcb/gopherlogs
A simple, powerful, and extensible Go logging framework suitable for stylized command line utilities and multi-writer logging
https://github.com/jpmcb/gopherlogs
cli golang logging
Last synced: 11 days ago
JSON representation
A simple, powerful, and extensible Go logging framework suitable for stylized command line utilities and multi-writer logging
- Host: GitHub
- URL: https://github.com/jpmcb/gopherlogs
- Owner: jpmcb
- License: apache-2.0
- Created: 2023-01-06T16:11:59.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-13T17:02:44.000Z (5 months ago)
- Last Synced: 2024-12-30T21:30:48.495Z (23 days ago)
- Topics: cli, golang, logging
- Language: Go
- Homepage:
- Size: 28.3 KB
- Stars: 23
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gopherlogs
[](https://goreportcard.com/report/github.com/jpmcb/gopherlogs)
[](https://github.com/jpmcb/gopherlogs/actions)
[](https://opensource.org/licenses/Apache-2.0)
[](https://pkg.go.dev/github.com/jpmcb/gopherlogs)
_A simple, powerful, and extensible Go logging framework with batteries included 🔋._
`gopherlogs` is ideal for command line applications,
combined logging to system files alongside terminal output,
and much more.
Features:
- Animated logging compatible with concurrent Go routines
- Support for _"emoji"_ style logs
- Dynamic log line replacement
- No external dependencies; what you see is what you get.
---
## Usage
Install as a dependency in your Go module:
```
module example.com
go 1.19
require github.com/jpmcb/gopherlogs v0.1.0
```
And tidy up your modules and `go.sum` with:
```
$ go mod tidy
```
In your go code, you can now import `gopherlogs`:
```go
package main
import (
"github.com/jpmcb/gopherlogs"
)
func main() {
// Creates a new logger with options
l, err := gopherlogs.NewLogger(
WithLogVerbosity(5),
)
// Handle errors from creating a new logger
if err != nil {
panic("Could not create new logger")
}
// Start logging!
l.Info("Hello world")
}
```
When you run your Go program, it will look something like this:
```
$ go run main.go
Hello world
```
## Why another Go logging framework?
This library is heavily inspired by the original logging library
from [Tanzu Community Edition's](https://github.com/vmware-tanzu/community-edition)
`unmanaged-cluster` CLI (which is no longer being maintained and is effectively abandoned).
I worked on that project for a few years, and we created the first iterations of this
logging framework because we couldn't find anything suitable enough
that was still very delightful to experience.
That experience is at the heart of this library; an amazing user experience
for both the _end user_ and the _developer_.
In some ways, this logging library is a fork of some of the best pieces of Go code
that came out of that project.
And in the end, I believed it deserved to see abit more lite of day.
Shout out and huge kudos to the original authors: @stmcginnis, @joshrosso, and @jpmcb (me).
Your work has inspired me and continues to bring me joy!