logredis

README

Redis Hook for Logrus

Why?

Useful for centralized logging, using a RELK stack (Redis, Elasticsearch, Logstash and Kibana). When the hook is installed, all log messages are sent to a Redis server, in Logstash message V0 or V1 format, ready to be parsed/processed by Logstash.

Install

$ go get github.com/rogierlommers/logrus-redis-hook

Usage

package main

import (
	"io/ioutil"

	"github.com/sirupsen/logrus"
	"github.com/rogierlommers/logrus-redis-hook"
)

func init() {
	hookConfig := logredis.HookConfig{
		Host:     "localhost",
		Key:      "my_redis_key",
		Format:   "v0",
		App:      "my_app_name",
		Port:     6379,
		Hostname: "my_app_hostname", // will be sent to field @source_host
		DB:       0, // optional
		TTL:      3600,
	}

	hook, err := logredis.NewHook(hookConfig)
	if err == nil {
		logrus.AddHook(hook)
	} else {
		logrus.Errorf("logredis error: %q", err)
	}
}

func main() {
	// when hook is injected succesfully, logs will be sent to redis server
	logrus.Info("just some info logging...")

	// we also support log.WithFields()
	logrus.WithFields(logrus.Fields{
		"animal": "walrus",
		"foo":    "bar",
		"this":   "that"}).
		Info("additional fields are being logged as well")

	// If you want to disable writing to stdout, use setOutput
	logrus.SetOutput(ioutil.Discard)
	logrus.Info("This will only be sent to Redis")
}

Testing

Please see the docker-compose directory for information about how to test. There is a readme inside.

In case of hook: disable writing to stdout

See this: https://github.com/Sirupsen/logrus/issues/328#issuecomment-210758435

Documentation

Index

• type HookConfig
• type RedisHook
  • func NewHook(config HookConfig, options ...redis.DialOption) (*RedisHook, error)
  • func (hook *RedisHook) Fire(entry *logrus.Entry) error
  • func (hook *RedisHook) Levels() []logrus.Level

Types

type HookConfig

type HookConfig struct {
	Key      string
	Format   string
	App      string
	Host     string
	Password string
	Hostname string
	Port     int
	DB       int
	TTL      int
}

HookConfig stores configuration needed to setup the hook

type RedisHook

type RedisHook struct {
	RedisPool      *redis.Pool
	RedisHost      string
	RedisKey       string
	LogstashFormat string
	AppName        string
	Hostname       string
	RedisPort      int
	TTL            int
	DialOptions    []redis.DialOption
}

RedisHook to sends logs to Redis server

func NewHook

func NewHook(config HookConfig, options ...redis.DialOption) (*RedisHook, error)

NewHook creates a hook to be added to an instance of logger

func (*RedisHook) Fire

func (hook *RedisHook) Fire(entry *logrus.Entry) error

Fire is called when a log event is fired.

func (*RedisHook) Levels

func (hook *RedisHook) Levels() []logrus.Level

Levels returns the available logging levels.