gelf

package

v0.0.2 Latest Latest Go to latest Published: May 15, 2023 License: MIT Imports: 6 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

This section is empty.

This section is empty.

func Assemble(chunks <-chan Chunk, maxMessageSize int, assembleTimeout time.Duration) <-chan Chunk

Assemble consumes byte chunks from the input channel, usually passed from UDP server. It feeds de-chunked messages to the result channel.

func Extract(encodedMsgs <-chan Chunk, decompressSizeLimit int) <-chan []byte

Extract applies decompression to byte messages if nessessary.

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

Assembler provides GELF message de-chunking

func NewAssembler(maxMessageSize int, timeout time.Duration) (res *Assembler)

NewAssembler returns empty Assembler with maximum message size and duration specified.

func (a *Assembler) Bytes() []byte

Bytes returns message bytes, not nessesarily fully assembled

func (a *Assembler) Expired() bool

Expired returns true if first chunk is too old

func (a *Assembler) Update(chunk Chunk) bool

Update feeds the byte chunk to Assembler, returns ok when the message is complete.

type Chunk []byte

Chunk represent GELF UDP chunk

func (c Chunk) Body() []byte

Body returns chunk payload

func (c Chunk) Data(decompressSizeLimit int) (res []byte, err error)

Data returns appropriately decoded message bytes

func (c Chunk) ID() string

ID returns chunk ID

func (c Chunk) IsGELF() bool

IsGELF returns true if the byte chunk starts with the GELF magic sequence

func (c Chunk) Sequence() (number, count int)

Sequence returns chunk sequence number and count