README
¶
PostgreSQL Hook for Logrus 
Use this hook to send your logs to postgresql server.
Usage
The hook must be configured with:
- A postgresql db connection (*
*sql.DB) - an optional hash with extra global fields. These fields will be included in all messages sent to postgresql
package main
import (
log "github.com/sirupsen/logrus"
"gopkg.in/gemnasium/logrus-postgresql-hook.v1"
)
func main() {
db, err := sql.Open("postgres", "user=postgres dbname=postgres host=postgres sslmode=disable")
if err != nil {
t.Fatal("Can't connect to postgresql database:", err)
}
defer db.Close()
hook := pglorus.NewHook(db, map[string]interface{}{"this": "is logged every time"})
log.Hooks.Add(hook)
log.Info("some logging message")
}
Asynchronous logger
This package provides an asynchronous hook, so logging won't block waiting for the data to be inserted in the DB.
Be careful to defer call hook.Flush() if you are using this kind of hook.
package main
import (
log "github.com/sirupsen/logrus"
"gopkg.in/gemnasium/logrus-postgresql-hook.v1"
)
func main() {
db, err := sql.Open("postgres", "user=postgres dbname=postgres host=postgres sslmode=disable")
if err != nil {
t.Fatal("Can't connect to postgresql database:", err)
}
defer db.Close()
hook := pglorus.NewAsyncHook(db, map[string]interface{}{"this": "is logged every time"})
defer hook.Flush()
log.Hooks.Add(hook)
log.Info("some logging message")
}
Customize insertion
By defaults, the hook will log into a logs table (cf the test schema in migrations).
To change this behavior, set the InsertFunc of the hook:
package main
import (
log "github.com/sirupsen/logrus"
"gopkg.in/gemnasium/logrus-postgresql-hook.v1"
)
func main() {
db, err := sql.Open("postgres", "user=postgres dbname=postgres host=postgres sslmode=disable")
if err != nil {
t.Fatal("Can't connect to postgresql database:", err)
}
defer db.Close()
hook := pglorus.NewHook(db, map[string]interface{}{"this": "is logged every time"})
hook.InsertFunc = func(db *sqlDB, entry *logrus.Entry) error {
jsonData, err := json.Marshal(entry.Data)
if err != nil {
return err
}
_, err = db.Exec("INSERT INTO another_logs_table(level, message, message_data, created_at) VALUES ($1,$2,$3,$4);", entry.Level, entry.Message, jsonData, entry.Time)
return err
}
log.Hooks.Add(hook)
log.Info("some logging message")
}
Run tests
Since this hook is hitting a DB, we're testing again a real PostgreSQL server:
docker-compose run --rm test
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var BufSize uint = 8192
Set pglogrus.BufSize = <value> _before_ calling NewHook Once the buffer is full, logging will start blocking, waiting for slots to be available in the queue.
Functions ¶
This section is empty.
Types ¶
type AsyncHook ¶
type AsyncHook struct {
*Hook
Ticker *time.Ticker
InsertFunc func(*sql.Tx, *logrus.Entry) error
// contains filtered or unexported fields
}
func NewAsyncHook ¶
NewAsyncHook creates a hook to be added to an instance of logger. The hook created will be asynchronous, and it's the responsibility of the user to call the Flush method before exiting to empty the log queue.
type Hook ¶
type Hook struct {
Extra map[string]interface{}
InsertFunc func(*sql.DB, *logrus.Entry) error
// contains filtered or unexported fields
}
Hook to send logs to a PostgreSQL database
Source Files