kafkahook

README

Kafka Logrus Hook

A Logrus Hook for sending log info to Kafka

Usage

import (
    "github.com/sirupsen/logrus"
    "github.com/mailgun/logrus-hooks/kafkahook"
)

hook, err := kafkahook.New(kafkahook.Config{Endpoints: []string{"localhost:9092"}})
if err != nil {
    panic(err)
}

// Tell logrus about the hook
logrus.AddHook(hook)

// Log a line
logrus.Info("Your mother milk chicken for a living")

// You must close the hook to flush messages before exit
err := hook.Close()
if err != nil {
        panic(err)
}

will result in json

{
	"context": null,
	"appname": "logrus-kafkahook.test",
	"hostname": "localhost",
	"logLevel": "INFO",
	"filename": "/mailgun/logrus-hooks/kafkahook/functional_test.go",
	"funcName": "github.com/mailgun/logrus-hooks/kafkahook.(*FunctionalTest).TestUDPHookExported",
	"lineno": 55,
	"message": "Your mother milk chicken for a living",
	"timestamp": 1485482245.473685
}

logrus.WithFields() places the fields into the context object.

log.WithFields(logrus.Fields{
	"domain.id": "282b0862-e425-11e6-a897-600308a97d8c",
	"domain.name": "example.com",
	"bar": "foo",
	"foo.bar": "bar",
}).Error("Your mother milk chicken for a living")

will result in json

{
    "context": {
        "domain": {
            "id": "282b0862-e425-11e6-a897-600308a97d8c",
            "name": "example.com"
        },
        "bar": "foo",
        "foo": {
            "bar": "bar"
        }
    },
	"appname": "logrus.test",
	"hostname": "localhost",
	"logLevel": "INFO",
	"filename": "/mailgun/logrus-hooks/kafkahook/functional_test.go",
	"funcName": "github.com/mailgun/logrus-hooks/kafkahook.(*FunctionalTest).TestUDPHookExported",
	"lineno": 75,
	"message": "Your mother milk chicken for a living",
	"timestamp": 1485482245.472957
}

logrus.WithFields() also understands http.Request objects

func (c *Controller) Get(w http.ResponseWriter, r *http.Request) (interface{}, error) {
        log.WithFields{logrus.Fields{ "http": r, }).Info("Get Called")
}

will result in json

{
    "context": {
        "http": {
            "headers": {
                "User-Agent": ["test-agent"]
            },
            "ip": "192.0.2.1:1234",
            "method": "POST",
            "params": {
                "param1": ["1"],
                "param2": ["2"]
            },
            "size": 4,
            "url": "http://example.com?param1=1&param2=2",
            "useragent": "test-agent"
        }
    },
	"appname": "logrus.test",
	"hostname": "localhost",
	"logLevel": "INFO",
	"filename": "/mailgun/logrus-hooks/kafkahook/functional_test.go",
	"funcName": "github.com/mailgun/logrus-hooks/kafkahook.(*FunctionalTest).TestUDPHookExported",
	"lineno": 175,
	"message": "Get Called",
	"timestamp": 1485482245.472957
}

Documentation

Index

• type Config
• type KafkaHook
  • func New(conf Config) (*KafkaHook, error)
  • func NewWithContext(ctx context.Context, conf Config) (hook *KafkaHook, err error)
  • func (h *KafkaHook) Close() error
  • func (h *KafkaHook) Fire(entry *logrus.Entry) error
  • func (h *KafkaHook) Levels() []logrus.Level
  • func (h *KafkaHook) SendIO(input io.Reader) error
  • func (h *KafkaHook) SetDebug(set bool)

Types

type Config

type Config struct {
	Endpoints []string
	Topic     string
	Producer  sarama.AsyncProducer
	Formatter logrus.Formatter
}

type KafkaHook

type KafkaHook struct {
	// contains filtered or unexported fields
}

func New

func New(conf Config) (*KafkaHook, error)

func NewWithContext

func NewWithContext(ctx context.Context, conf Config) (hook *KafkaHook, err error)

func (*KafkaHook) Close

func (h *KafkaHook) Close() error

Close the kakfa producer and flush any remaining logs

func (*KafkaHook) Fire

func (h *KafkaHook) Fire(entry *logrus.Entry) error

func (*KafkaHook) Levels

func (h *KafkaHook) Levels() []logrus.Level

Levels returns the available logging levels.

func (*KafkaHook) SendIO

func (h *KafkaHook) SendIO(input io.Reader) error

Given an io reader send the contents of the reader to udplog

func (*KafkaHook) SetDebug

func (h *KafkaHook) SetDebug(set bool)