gelf

README

zap-gelf

A zap plugin support GELF format send logs to Graylog server over UDP, TCP, HTTP

Documentation

Index

• Constants
• Variables
• func NewHttpCore(options ...Option) (_ zapcore.Core, err error)
• func NewTcpCore(options ...Option) (_ zapcore.Core, err error)
• func NewUdpCore(options ...Option) (_ zapcore.Core, err error)
• type Option
  • func Address(value string) Option
  • func CallerKey(value string) Option
  • func ChunkSize(value int) Option
  • func CompressionLevel(value int) Option
  • func CompressionType(value int) Option
  • func EncodeCaller(value zapcore.CallerEncoder) Option
  • func EncodeDuration(value zapcore.DurationEncoder) Option
  • func EncodeName(value zapcore.NameEncoder) Option
  • func Host(value string) Option
  • func Level(value zapcore.Level) Option
  • func LevelString(value string) Option
  • func LineEnding(value string) Option
  • func NameKey(value string) Option
  • func Version(value string) Option

Constants

const (
	// CompressionNone don't use compression.
	CompressionNone = 0

	// CompressionGzip use gzip compression.
	CompressionGzip = 1

	// CompressionZlib use zlib compression.
	CompressionZlib = 2
)

const (
	// MinChunkSize minimal chunk size in bytes.
	MinChunkSize = 512

	// MaxChunkSize maximal chunk size in bytes.
	// See https://docs.graylog.org/en/3.2/pages/gelf.html#chunking.
	MaxChunkSize = 8192

	// MaxChunkCount maximal chunk per message count.
	// See https://docs.graylog.org/en/3.2/pages/gelf.html#chunking.
	MaxChunkCount = 128

	// DefaultChunkSize is default WAN chunk size.
	DefaultChunkSize = 1420
)

Variables

var (
	// ErrChunkTooSmall triggered when chunk size to small.
	ErrChunkTooSmall = errors.New("chunk size too small")

	// ErrChunkTooLarge triggered when chunk size too large.
	ErrChunkTooLarge = errors.New("chunk size too large")

	// ErrUnknownCompressionType triggered when passed invalid compression type.
	ErrUnknownCompressionType = errors.New("unknown compression type")
)

Functions

func NewHttpCore

func NewHttpCore(options ...Option) (_ zapcore.Core, err error)

NewCore zap core constructor.

func NewTcpCore

func NewTcpCore(options ...Option) (_ zapcore.Core, err error)

NewCore zap core constructor.

func NewUdpCore

func NewUdpCore(options ...Option) (_ zapcore.Core, err error)

NewCore zap core constructor.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option interface.

func Address

func Address(value string) Option

Address set Graylog server address.

func CallerKey

func CallerKey(value string) Option

CallerKey set zapcore.EncoderConfig CallerKey property.

func ChunkSize

func ChunkSize(value int) Option

ChunkSize set GELF chunk size.

func CompressionLevel

func CompressionLevel(value int) Option

CompressionLevel set GELF compression level.

func CompressionType

func CompressionType(value int) Option

CompressionType set GELF compression type.

func EncodeCaller

func EncodeCaller(value zapcore.CallerEncoder) Option

EncodeCaller set zapcore.EncoderConfig EncodeCaller property.

func EncodeDuration

func EncodeDuration(value zapcore.DurationEncoder) Option

EncodeDuration set zapcore.EncoderConfig EncodeDuration property.

func EncodeName

func EncodeName(value zapcore.NameEncoder) Option

EncodeName set zapcore.EncoderConfig EncodeName property.

func Host

func Host(value string) Option

Host set GELF host.

func Level

func Level(value zapcore.Level) Option

Level set logging level.

func LevelString

func LevelString(value string) Option

LevelString set logging level.

func LineEnding

func LineEnding(value string) Option

LineEnding set zapcore.EncoderConfig LineEnding property.

func NameKey

func NameKey(value string) Option

NameKey set zapcore.EncoderConfig NameKey property.

func Version

func Version(value string) Option

Version set GELF version.