gelf

README

gelf

This formatter outputs GELF v1.1

This is used in our production system to output GELF formatted logs. The features built into it (such as logging http.Request), were built because that's what we needed. If you have different requirements, feel free to copy the code into your repository and modify it.

I may make the gelf package more generic so others can do what they want. If you have an idea of how to do this with a good API, let me know.

Documentation

Index

• type Extra
• type GELFFormatter
  • func New() *GELFFormatter
  • func NewGELFFormatter() *GELFFormatter
  • func (f *GELFFormatter) Format(context log.LogContext) []byte
  • func (f *GELFFormatter) ShouldRuntimeCaller() bool

Types

type Extra

type Extra map[string]interface{}

Extra is a type you wrap around data to be added

as extra fields to JSON.

type GELFFormatter

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

GLEFFormatter provides a formatter that outputs GELF v1.1 data. It will also encode extra information such as an http.Request.

func New

func New() *GELFFormatter

func NewGELFFormatter

func NewGELFFormatter() *GELFFormatter

NewGELFFormatter returns a new GELFFormatter

func (*GELFFormatter) Format

func (f *GELFFormatter) Format(context log.LogContext) []byte

Format formats a LogContext into the GELF format.

func (*GELFFormatter) ShouldRuntimeCaller

func (f *GELFFormatter) ShouldRuntimeCaller() bool

ShouldRuntimeCaller will always return true.