https://github.com/bwmarrin/lit
Lit (Log it) is a simple and opinionated message logger for Go (golang).
https://github.com/bwmarrin/lit
go golang logger logging
Last synced: about 1 year ago
JSON representation
Lit (Log it) is a simple and opinionated message logger for Go (golang).
- Host: GitHub
- URL: https://github.com/bwmarrin/lit
- Owner: bwmarrin
- License: bsd-2-clause
- Created: 2018-08-18T15:35:30.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-08-13T13:26:10.000Z (almost 7 years ago)
- Last Synced: 2025-04-11T04:03:02.894Z (about 1 year ago)
- Topics: go, golang, logger, logging
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
`lit` logs, so hot.
====
[](https://godoc.org/github.com/bwmarrin/lit) [](http://goreportcard.com/report/bwmarrin/lit) [](https://travis-ci.org/bwmarrin/lit) [](https://discord.gg/0f1SbxBZjYq9jLBk)
lit is a [Go](https://golang.org/) package that provides
* A very simple and opinionated message logger
* Logging levels that allow you to set the verbosity of what is logged.
* Added detail, such as file, line, and function name to each logged message.
**For help with this package or general Go discussion, please join the [Discord
Gophers](https://discord.gg/0f1SbxBZjYq9jLBk) chat server.**
## Status @ 2019-03-02
This package is pretty much where it's going to be, there's a chance of some
minor changes in the future but otherwise I expect it to remain about like it is
now.
## Design Goals
I find somethings, like logging, a bit tedious. So I wanted a way to have a
very accessible logger that I could use anywhere without needing much setup.
So, lit has minimal configuration options, it doesn't require to be instantiated
as a variable you pass around, or a global one you setup somewhere. You can just
call the package functions from anywhere and there are handy methods for each of
the four log levels it supports.
## Usage
Add the package to your project.
Look around your code, and find a place that needs something logged.
If it's an error, just add a line like
```go
lit.Error("message here, %s", err)
```
Now that error message will be logged.
If it's something kind of spammy and not
even an error at all - just detail you need when debugging your application.
```go
lit.Debug("message here")
```
Now that will be logged anytime your `lit.LogLevel` is set to `lit.LogDebug`.
There's also `lit.Warning()` and `lit.Informational()` methods that can be used
similarly.
## Options
### lit.LogLevel
Can be set to `lit.LogError`, `lit.LogWarning`, `lit.LogInformational`, and
`lit.LogDebug`. The default is `lit.LogError`.
### lit.Prefix
Can be set to any string you want to prefix all logged messages. The default is
`LIT`.
### lit.Writer
This can be set to any io.Writer and that's where your logged messages will go.
The default is `os.Stderr`.