README.md

Logzio Golang API client

Sends logs to logz.io over HTTP. It is a low level lib that can to be integrated with other logging libs.

[![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![Coverage Status][cov-img]][cov] [![Go Report][report-img]][report]

Prerequisites

go 1.x

Installation

$ go get -u github.com/logzio/logzio-go

Quick Start

package main

import (
  "fmt"
  "github.com/logzio/logzio-go"
  "os"
  "time"
)

func main() {
  l, err := logzio.New(
  		"fake-token",
  		SetDebug(os.Stderr),
  		SetUrl("http://localhost:12345"),
  		SetDrainDuration(time.Minute*10),
        SetSetTempDirectory("myQueue"),
        SetDrainDiskThreshold(99)
  	) // token is required
  if err != nil {
    panic(err)
  }
  msg := fmt.Sprintf("{ \"%s\": \"%s\"}", "message", time.Now().UnixNano())

  err = l.Send([]byte(msg))
  if err != nil {
     panic(err)
  }

  l.Stop() //logs are buffered on disk. Stop will drain the buffer
}

Usage

• Set url mode: logzio.New(token, SetUrl(ts.URL))

• Set drain duration (flush logs on disk): logzio.New(token, SetDrainDuration(time.Hour))

• Set debug mode: logzio.New(token, SetDebug(os.Stderr))

• Set queue dir: logzio.New(token, SetSetTempDirectory(os.Stderr))

• Set the sender to check if it crosses the maximum allowed disk usage: logzio.New(token, SetCheckDiskSpace(true))

• Set disk queue threshold, once the threshold is crossed the sender will not enqueue the received logs: logzio.New(token, SetDrainDiskThreshold(99))

Disk queue

Logzio go client uses goleveldb and goqueue as a persistent storage. Every 5 seconds logs are sent to logz.io (if any are available)

Tests

$ go test -v

See travis.yaml for running benchmark tests

Contributing

All PRs are welcome

Authors

• Douglas Chimento - [dougEfresh][me]
• Ido Halevi - idohalevi

License

This project is licensed under the Apache License - see the LICENSE file for details

Acknowledgments

• logzio-java-sender