stash

README

Go Stash

Logstash Client Library For Go

Features

• Support TLS https://en.wikipedia.org/wiki/Transport_Layer_Security
• Support Golang's standar Log https://golang.org/pkg/log/
• Support Logrus https://github.com/sirupsen/logrus

Example

• Basic
• With Golang's Standar Log
• TLS

Install

$ go get github.com/telkomdev/go-stash

Usage

Basic

package main

import (
	"encoding/json"
	"fmt"
	"os"
	"time"

	"github.com/telkomdev/go-stash"
)

type Message struct {
	Data string `json:"data"`
}

type Log struct {
	Action  string    `json:"action"`
	Time    time.Time `json:"time"`
	Message Message   `json:"message"`
}

func main() {
    var host string = "localhost"
	var port uint64 = 5000
	s, err := stash.Connect(host, port)
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	defer func() {
		s.Close()
	}()

	logData := Log{
			Action: "get_me",
			Time:   time.Now(),
			Message: Message{
				Data: "get me for me",
			},
		}

    logDataJSON, _ := json.Marshal(logData)

    n, err := s.Write(logDataJSON)
    if err != nil {
        fmt.Fprintf(w, err.Error())
        return
    }
}

With Golang is Standar Log

You can use go-stash With Golang's standar Log

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"
	"time"

	"github.com/telkomdev/go-stash"
)

type Message struct {
	Data string `json:"data"`
}

type Log struct {
	Action  string    `json:"action"`
	Time    time.Time `json:"time"`
	Message Message   `json:"message"`
}

func main() {
	var host string = "localhost"
	var port uint64 = 5000
	s, err := stash.Connect(host, port)
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	defer func() {
		s.Close()
	}()

	logger := log.New(s, "", 0)

	logData := Log{
		Action: "get_me",
		Time:   time.Now(),
		Message: Message{
			Data: "get me for me",
		},
	}

	logDataJSON, _ := json.Marshal(logData)

	logger.Print(string(logDataJSON))

}

TLS to secure your connection

Sometimes you have to secure your communication between your Logstash and your client

func main() {
	cert, err := tls.LoadX509KeyPair("certs/server.crt", "certs/server.key")
	if err != nil {
		log.Fatalf("server: loadkeys: %s", err)
		os.Exit(1)
	}
	config := tls.Config{Certificates: []tls.Certificate{cert}}

	var (
		host string = "localhost"
		port uint64 = 5000
	)

	s, err := stash.Connect(host, port, stash.SetTLSConfig(&config), stash.SetTLS(true))
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	defer func() {
		s.Close()
	}()

	logger := log.New(s, "", 0)

Documentation

Index

• Constants
• Variables
• type Option
  • func SetDialTimeout(dialTimeout time.Duration) Option
  • func SetKeepAlive(keepAlive time.Duration) Option
  • func SetProtocolConn(protocol string) Option
  • func SetReadTimeout(readTimeout time.Duration) Option
  • func SetSkipVerify(skipVerify bool) Option
  • func SetTLS(useTLS bool) Option
  • func SetTLSConfig(config *tls.Config) Option
  • func SetWriteTimeout(writeTimeout time.Duration) Option
• type Stash
  • func Connect(host string, port uint64, opts ...Option) (*Stash, error)
  • func (s *Stash) Close() error
  • func (s *Stash) Write(data []byte) (int, error)

Constants

const (
	// BrokenPipeError const type to check whether the write process to tcp is broken
	BrokenPipeError = "broken pipe"
)

Variables

var CRLF = []byte{13, 10}

CRLF (Carriage Return and Line Feed in ASCII code)

Types

type Option

type Option func(*options)

Option function

func SetDialTimeout

func SetDialTimeout(dialTimeout time.Duration) Option

SetDialTimeout Option func

func SetKeepAlive

func SetKeepAlive(keepAlive time.Duration) Option

SetKeepAlive Option func

func SetProtocolConn

func SetProtocolConn(protocol string) Option

SetProtocolConn Option func set protocol connection between logstash : `tcp` or `udp`

func SetReadTimeout

func SetReadTimeout(readTimeout time.Duration) Option

SetReadTimeout Option func

func SetSkipVerify

func SetSkipVerify(skipVerify bool) Option

SetSkipVerify Option func

func SetTLS

func SetTLS(useTLS bool) Option

SetTLS Option func

func SetTLSConfig

func SetTLSConfig(config *tls.Config) Option

SetTLSConfig Option func

func SetWriteTimeout

func SetWriteTimeout(writeTimeout time.Duration) Option

SetWriteTimeout Option func

type Stash

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

Stash structure

func Connect

func Connect(host string, port uint64, opts ...Option) (*Stash, error)

Connect function, this function will connect to logstash server

func (*Stash) Close

func (s *Stash) Close() error

Close function, will close connection

func (*Stash) Write

func (s *Stash) Write(data []byte) (int, error)

Write function, implement from io.Writer