logrussplunk

Documentation

Overview

Package logrussplunk allows hooking into logrus such that all logs will go to splunk via the Splunk HTTP Event Collector (HEC).

Index

• Variables
• type Configuration
• type ErrSplunkSendFailed
  • func (e ErrSplunkSendFailed) Error() string
• type Hook
  • func NewSplunkHook(config Configuration) (*Hook, error)
  • func (hook *Hook) Fire(entry *logrus.Entry) error
  • func (hook *Hook) Levels() []logrus.Level
  • func (hook *Hook) Run() error
  • func (hook *Hook) Tomb() *tomb.Tomb

Variables

var ErrEventsBufferOverflow = errors.New("events buffer overflow")

ErrEventsBufferOverflow is returned by `Fire` if the we log and event but have yet to process all previous events.

var ErrMissingSplunkHost = errors.New("missing splunk host")

ErrMissingSplunkHost is returned by `NewSplunkHook` if the given configuration has no splunk host

Types

type Configuration

type Configuration struct {
	SplunkHECHost string
	ToolName      string
	HostName      string
	BasicAuthUser string
	BasicAuthPass string
}

type ErrSplunkSendFailed

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

ErrSplunkSendFailed indicates that the hook failed to submit an error to Splunk.

func (ErrSplunkSendFailed) Error

func (e ErrSplunkSendFailed) Error() string

type Hook

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

Hook can be registered as a `logrus.Hook`.

func NewSplunkHook

func NewSplunkHook(config Configuration) (*Hook, error)

NewSplunkHook initializes a logrus hook which sends logs to the configured Splunk HEC. The returned object should be registered with a log via `AddHook()`

func (*Hook) Fire

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

Fire forwards a log entry to Bugsnag.

func (*Hook) Levels

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

Levels enumerates the log levels on which this hook will receive `Fire` events from logrus.

func (*Hook) Run

func (hook *Hook) Run() error

Run is part of the `genmain.Component` interface

func (*Hook) Tomb

func (hook *Hook) Tomb() *tomb.Tomb

Tomb implements the `genmain.Component` interface