README
¶
🥯 bunslog
A simple logger hook for bun ORM using Go's slog package. It logs SQL queries, errors, and slow queries with flexible configuration. 🚀
✨ Features
- 🐞 Log all queries
- 🎚️ Custom log levels for queries, errors, and slow queries
- ⚙️ Environment variable configuration
- 🔗 Integrates with Go's
sloglogger
📦 Installation
go get github.com/XanderD99/bunslog
📝 Usage Example
package main
import (
"context"
"log/slog"
"os"
"time"
"github.com/uptrace/bun"
"github.com/XanderD99/bunslog"
)
func main() {
db := bun.NewDB(/* ... */)
logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
hook := bunslog.NewQueryHook(
bunslog.WithLogger(logger),
bunslog.WithLogSlow(100 * time.Millisecond), // log queries slower than 100ms
)
db.AddQueryHook(hook)
// ... your queries ...
}
🌍 Environment Configuration
You can control logging via environment variables:
- 📴
BUNDEBUG=0disables logging - ✅
BUNDEBUG=1enables logging
📄 License
MIT 🎉
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(hook *QueryHook)
func FromEnv ¶
FromEnv configures the hook using the environment variable value. For example, WithEnv("BUNDEBUG"):
- BUNDEBUG=0 - disables the hook.
- BUNDEBUG=1 - enables the hook.
func WithErrorLevel ¶
func WithLogSlow ¶
func WithLogger ¶
func WithQueryLevel ¶
func WithSlowLevel ¶
type QueryHook ¶
type QueryHook struct {
// contains filtered or unexported fields
}
QueryHook wraps query hook
func NewQueryHook ¶
NewQueryHook returns new instance
func (*QueryHook) AfterQuery ¶
func (h *QueryHook) AfterQuery(ctx context.Context, event *bun.QueryEvent)
AfterQuery convert a bun QueryEvent into a slog message
func (*QueryHook) BeforeQuery ¶
BeforeQuery does nothing
Source Files
Click to show internal directories.
Click to hide internal directories.