https://github.com/mavolin/dblog
📜 Generate a logger that wraps your repository interface. Modular, but currently only supports sentry. Useful for performance monitoring.
https://github.com/mavolin/dblog
code-generator database logger repository sentry
Last synced: 2 months ago
JSON representation
📜 Generate a logger that wraps your repository interface. Modular, but currently only supports sentry. Useful for performance monitoring.
- Host: GitHub
- URL: https://github.com/mavolin/dblog
- Owner: mavolin
- License: mit
- Created: 2022-08-16T10:14:02.000Z (over 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-10-17T16:22:16.000Z (over 1 year ago)
- Last Synced: 2025-01-10T02:47:57.326Z (4 months ago)
- Topics: code-generator, database, logger, repository, sentry
- Language: Go
- Homepage:
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
dblog
[](https://goreportcard.com/report/github.com/mavolin/dblog)
[](https://github.com/mavolin/dblog/blob/develop/LICENSE)
---
## About
dblog is a code generator that can generate a wrapper for your repository
interface to log database operations.
Especially useful, if you do things like performance tracking.
## Features
* ✨ **Simple:** Only generate code for the logger you use.
* 📦 **Modular:** Easily add more generators by implementing the `logger.Logger`
interface, the [sentry implementation](logger/sentry/sentry.go) is only 143 LOC long.
(PRs welcome!)
* 🕵 **Context-Aware:** Loggers can log before a request, after a request,
when an error occurs, when the request succeeds, or any combination of those.
## Installation
```shell
go install github.com/mavolin/dblog/cmd/dblog@latest
```
## Examples
First impressions matter, so here is a simple example:
```go
package my-project/repository
import "context"
//go:generate dblog -sentry Repository
type (
Repository interface {
// dblog uses param and return value names in the log messages, so it makes
// sense to name them yourself, if you don't want generated names.
Gopher(ctx context.Context, id GopherID) (g *Gopher, err error)
Gophers(ctx context.Context, search GopherSearchData) (gs []Gopher, err error)
}
GopherSearchData struct {
Name string
MinAge, MaxAge int
}
)
type GopherID uint64
type Gopher struct {
ID GopherID
Name string
Age int
Hobbies []string
}
```
> **Quick Transparency Note:**
> Variables in the below code were renamed for readability,
> normally more cryptic names are used to prevent name collisions.
> Additionally, I changed naked returns to explicit ones.
> Otherwise, the code is identical to the actual output of `dblog`.
```go
package my-project/repository/dblog
import (
"context"
"github.com/getsentry/sentry-go"
"my-project/repository"
)
// Code generated by github.com/mavolin/dblog. DO NOT EDIT.
type Wrapper struct {
repo repository.Repository
}
var _ repository.Repository = (*Wrapper)(nil)
func NewWrapper(repo repository.Repository) *Wrapper {
return &Wrapper{repo: repo}
}
func (w *Wrapper) Gopher(ctx context.Context, id repository.GopherID) (g *repository.Gopher, err error) {
span := sentry.StartSpan(ctx, "db.query")
span.Description = "Gopher"
ctx = span.Context()
defer span.Finish()
g, err = w.repo.Gopher(ctx, id)
if hub := sentry.GetHubFromContext(ctx); hub != nil {
hub.AddBreadcrumb(&sentry.Breadcrumb{
Category: "db.query",
Message: "Gopher",
Data: map[string]any{
"args": map[string]any{"id": id},
"results": map[string]any{"g": g, "err": err},
},
}, nil)
}
return g, err
}
func (w *Wrapper) Gophers(
ctx context.Context, search repository.GopherSearchData,
) (gs []repository.Gopher, err error) {
span := sentry.StartSpan(ctx, "db.query")
span.Description = "Gophers"
ctx = span.Context()
defer span.Finish()
gs, err = w.repo.Gophers(ctx, search)
if hub := sentry.GetHubFromContext(ctx); hub != nil {
hub.AddBreadcrumb(&sentry.Breadcrumb{
Category: "db.query",
Message: "Gophers",
Data: map[string]any{
"args": map[string]any{"search": search},
"results": map[string]any{"gs": gs, "err": err},
},
}, nil)
}
return gs, err
}
```
## License
Built with ❤ by [Maximilian von Lindern](https://github.com/mavolin).
Available under the [MIT License](./LICENSE).