lhw

README

LogHoleWriter

Documentation

Index

• Constants
• Variables
• type Logger
• type Option
  • func WithInsecure() Option
  • func WithLogger(logger Logger) Option
  • func WithPingInterval(interval time.Duration) Option
  • func WithQueueCap(capacity int) Option
  • func WithRequestTimeout(timeout time.Duration) Option
  • func WithSuccessCodes(codes ...int) Option
• type Options
  • func GetDefaultOptions() *Options
• type Writer
  • func NewWriter(url string, options ...Option) (writer *Writer, err error)
  • func (w *Writer) Close() error
  • func (w *Writer) Write(p []byte) (n int, err error)

Constants

const (
	DefaultQueueCap       = 1000
	DefaultPingInterval   = time.Second
	DefaultRequestTimeout = 2 * time.Second
)

Variables

var (
	ErrBadQueueCapacity  = errors.New("queue capacity invalid")
	ErrBadRequestTimeout = errors.New("request timeout invalid")
	ErrBadPingInterval   = errors.New("ping interval invalid")
	ErrSuccessCodes      = errors.New("success codes empty")
)

var ErrWriteFailed = errors.New("[loghole-writer] write data to queue failed")

Types

type Logger

type Logger interface {
	Printf(format string, v ...interface{})
}

type Option

type Option func(option *Options) error

func WithInsecure

func WithInsecure() Option

func WithLogger

func WithLogger(logger Logger) Option

func WithPingInterval

func WithPingInterval(interval time.Duration) Option

func WithQueueCap

func WithQueueCap(capacity int) Option

func WithRequestTimeout

func WithRequestTimeout(timeout time.Duration) Option

func WithSuccessCodes

func WithSuccessCodes(codes ...int) Option

type Options

type Options struct {
	// Writer settings
	QueueCap int
	Logger   Logger

	Servers        []string
	Insecure       bool
	RequestTimeout time.Duration
	PingInterval   time.Duration
	SuccessCodes   []int
}

func GetDefaultOptions

func GetDefaultOptions() *Options

GetDefaultOptions returns default configuration options for the client.

type Writer

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

func NewWriter

func NewWriter(url string, options ...Option) (writer *Writer, err error)

The url can contain secret token e.g. https://secret_token@localhost:50000 Comma separated arrays are also supported, e.g. urlA, urlB. Options start with the defaults but can be overridden.

func (*Writer) Close

func (w *Writer) Close() error

Close flushes any buffered log entries.

func (*Writer) Write

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

Write writes the data to the queue if it is not full.