appender

Documentation

Index

• func LogstashRateLimit(limit int) func(*logstash) error
• func LogstashSizeLimit(size int) func(*logstash) error
• func NewConsulLogstashWriter(protocol, serviceName string, refreshInterval time.Duration, ...) (io.Writer, error)
• type Appender
  • func LogstashAppenderFromEnv() (Appender, error)
  • func NewLogstash(writer io.Writer, options ...func(*logstash) error) (Appender, error)

Examples

• NewLogstash

Functions

func LogstashRateLimit

func LogstashRateLimit(limit int) func(*logstash) error

LogstashRateLimit adds rate limiting to logs sending. Logs send in higher rate (log lines per seconds) will be discarded.

func LogstashSizeLimit

func LogstashSizeLimit(size int) func(*logstash) error

LogstashSizeLimit adds size limiting to logs sending. Logs that exceeds passed size (in bytes) will be discarded.

func NewConsulLogstashWriter

func NewConsulLogstashWriter(protocol, serviceName string, refreshInterval time.Duration, dialer *net.Dialer) (io.Writer, error)

NewConsulLogstashWriter creates a new writer that will write data to instances provided by local Consul agent. It will use round robin algorithm to spread logs evenly to every Logstash instance. For TCP connections customised dialer can be optionally passed to have more control over how the connections are made.

Types

type Appender

type Appender interface {
	Append(entries <-chan servicelog.Entry)
}

Appender delivers service log entries to their destination.

func LogstashAppenderFromEnv

func LogstashAppenderFromEnv() (Appender, error)

LogstashAppenderFromEnv creates the appender from the environment variables.

func NewLogstash

func NewLogstash(writer io.Writer, options ...func(*logstash) error) (Appender, error)

NewLogstash creates new appender that will send log entries to Logstash using passed writer.

Example

package main

import (
	"log"
	"net"

	"github.com/allegro/mesos-executor/servicelog/appender"
)

func main() {
	// create writer that will be used to send logs
	writer, err := net.DialUDP("udp", nil, nil)
	if err != nil {
		log.Fatal(err)
	}

	// create appender with desired options
	_, err = appender.NewLogstash(writer,
		appender.LogstashRateLimit(100),
		appender.LogstashSizeLimit(16000))
	if err != nil {
		log.Fatal(err)
	}
}