onelog

A unified logging interface for Go. The library is currently still a work in progress.

[![codecov](https://codecov.io/gh/nikoksr/onelog/branch/main/graph/badge.svg?token=oVqojUn7pd)](https://codecov.io/gh/nikoksr/onelog) [![Go Report Card](https://goreportcard.com/badge/github.com/nikoksr/onelog)](https://goreportcard.com/report/github.com/nikoksr/onelog) [![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/nikoksr/onelog)

## About > This is a work in progress. _onelog_ is a general-purpose logging interface heavily inspired by the [zerolog](https://github.com/rs/zerolog) API. It is designed to provide a user-friendly API for diverse logging requirements. This package supports a wide range of data types and log levels, creating flexibility for various use cases. _onelog_ includes adapters for several commonly used loggers, enabling easy integration and compatibility with existing logging methodologies. It reduces the friction associated with logging setup and promotes consistency in logging across different parts of a project or across different projects. Personally, I plan on using this library in my projects [Notify](https://github.com/nikoksr/notify) and [doppler-go](https://github.com/nikoksr/doppler-go), to provide the users of both projects with a unified logging interface without having to force them to use a specific logging library. ## Install ```sh go get -u github.com/nikoksr/onelog ``` ## Example usage ```go func main() { // Let's use zap's production logger as our superhero event logger logger, _ := zap.NewProduction() // Use the zapadapter to create a onelog.Logger compatible logger superheroTracker := zapadapter.NewAdapter(logger) // Start logging superheroTracker.Debug().Msg("Tracking superheroes...") // Now let's log a superhero event superheroTracker.Info(). Str("superhero", "Superman"). Str("location", "New York"). Time("time", time.Now()). Msg("Superman seen flying over New York!") // Or perhaps we'd rather use slog for logging our superhero sightings superheroTracker = slogadapter.NewAdapter(slog.Default()) // And now we can log another sighting superheroTracker.Info(). Str("superhero", "Batman"). Str("location", "Gotham"). Time("time", time.Now()). Msg("Batman seen driving through Gotham!") // Output: // {"level":"info","ts":1690213152.0569847,"caller":"zap/adapter.go:547","msg":"Superman seen flying over New York!","superhero":"Superman","location":"New York","time":1690213152.0569835} // 2023/07/24 17:39:12 INFO Batman seen driving through Gotham! superhero=Batman location=Gotham time=2023-07-24T17:39:12.057+02:00 // // Note: The lines above look differently because we switched the logger in between. } ``` For more examples, please take a look at the [examples](_examples) directory. ## Contributing Contributions of all kinds are very welcome! Feel free to check our [open issues](https://github.com/nikoksr/onelog/issues). Please also take a look at the [contribution guidelines](https://github.com/nikoksr/onelog/blob/main/CONTRIBUTING.md). ## Show your support Please give a âï¸ if you like this project! This helps us to get more visibility and helps other people to find this project.