Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/primalskill/golog
Golang log package used by Primal Skill
https://github.com/primalskill/golog
go go-package golang
Last synced: about 2 months ago
JSON representation
Golang log package used by Primal Skill
- Host: GitHub
- URL: https://github.com/primalskill/golog
- Owner: primalskill
- License: mit
- Created: 2023-10-30T14:40:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T13:33:58.000Z (9 months ago)
- Last Synced: 2024-10-02T09:03:24.443Z (3 months ago)
- Topics: go, go-package, golang
- Language: Go
- Size: 28.3 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-slog - golog
README
# Log handler for the Go [log/slog](https://pkg.go.dev/log/slog) package
## Overview
There are three handlers implemented in this package with a heavy focus on the development handler.
1. Development - logging in development mode.
2. Discard - all gets discarded, useful for integration testing where log lines can become noise.
3. Production - a wrapper around slog's JSON handler with sensible defaults.
## Usage - Development
This handler should only be used in development. It formats the log lines where the attribute keys are color coded.
It is encouraged to always set the default logger with `slog.SetDefault(...)` in order to not "depend" directly on this logger in your code base.
### Example
```go
devLogger := golog.NewDevelopment()
slog.SetDefault(devLogger)
slog.Info("this log will be pretty printed")
```
### Output
Example code used to generate the output: https://go.dev/play/p/Y0d-i5_SutP
### JSON Output
If the data passed in as a `string` or `[]byte` is a valid JSON object, it will be automatically formatted, colorized, and its type marked as JSON.
-----------
## Usage - Discard
All log lines will be discarded. Should be used for integration tests.
### Example
```go
discardLogger := golog.NewDiscard()
slog.SetDefault(discardLogger)
slog.Info("this log will be discarded")
```
------------
## Usage - Production
The production handler is just a wrapper for [slog's JSON handler](https://pkg.go.dev/log/slog#NewJSONHandler) with a few sensible defaults:
- Logs are output to `stderr` to align it to the [POSIX standard](https://linux.die.net/man/3/stderr)
- The default log level is `slog.LevelInfo`
- slog's TimeKey is replaced in JSON to a property named `t`
- slog's source is enabled and formatted to ``, e.g. `my_file.go:17`
### Example
```go
prodLogger := golog.NewProduction()
slog.SetDefault(prodLogger)
slog.Info("this log will be output to stderr and formatted as JSON")
```