gelf

Documentation

Index

• Constants
• type CompressType
• type Message
• type Writer
  • func NewWriter(addr string) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) Write(p []byte) (n int, err error)

Constants

const (
	ChunkSize = 1420
)

Used to control GELF chunking. Should be less than (MTU - len(UDP header)).

TODO: generate dynamically using Path MTU Discovery?

Types

type CompressType

type CompressType int

What compression type the writer should use when sending messages to the graylog2 server

const (
	CompressGzip CompressType = iota
	CompressZlib
	CompressNone
)

type Message

type Message struct {
	Version  string                 `json:"version"`
	Host     string                 `json:"host"`
	Short    string                 `json:"short_message"`
	Full     string                 `json:"full_message,omitempty"`
	TimeUnix float64                `json:"timestamp"`
	Level    int32                  `json:"level,omitempty"`
	Facility string                 `json:"facility,omitempty"`
	Extra    map[string]interface{} `json:"-"`
	RawExtra json.RawMessage        `json:"-"`
}

Message represents the contents of the GELF message. It is gzipped before sending.

type Writer

type Writer struct {
	Mu sync.Mutex

	Facility         string // defaults to current process name
	CompressionLevel int    // one of the consts from compress/flate
	CompressionType  CompressType
	// contains filtered or unexported fields
}

Writer implements io.Writer and is used to send both discrete messages to a graylog2 server, or data from a stream-oriented interface (like the functions in log).

func NewWriter

func NewWriter(addr string) (*Writer, error)

New returns a new GELF Writer. This writer can be used to send the output of the standard Go log functions to a central GELF server by passing it to log.SetOutput()

func (*Writer) Close

func (w *Writer) Close() error

Close connection and interrupt blocked Read or Write operations

func (*Writer) Write

func (w *Writer) Write(p []byte) (n int, err error)

Write sends the specified message to the GELF server specified in the call to New(). It assumes all the fields are filled out appropriately.