gelf

package

v0.0.0-...-3861baa Latest Latest Go to latest Published: Mar 28, 2022 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/danversjflett/go-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 ¶

View Source

const (
	ChunkSize = 1420
)

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

TODO: generate dynamically using Path MTU Discovery?

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

writer.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL