fluxline

README

fluxline

Encoder for Golang to prepare sets of metrics in InfluxDB's Line Protocol format. As input, we use structs annotated with the influx tag, similar to how encoding/json works.

Supports the following Go builtin types as fields:

• string
• int32, int64, int16, int8, int, uint32, uint64, uint16, uint8, uint
• float64, float32
• bool
• time.Time

Remarks

Not thread safe. If the struct is modified elsewhere concurrently, one would need to protect the read access required for encoding.

Get the code

go get github.com/DCSO/fluxline

Usage example

package main

import (
  "bytes"
  "fmt"
  "log"

  "github.com/DCSO/fluxline"
)

const measurement = "example"

type MyCounts struct {
  Success uint64 `influx:"success"`
  Error   uint64 `influx:"error"`
}

func main() {
  var counts MyCounts
  var b bytes.Buffer

  // ...
  counts.Success++
  // ...
  counts.Success++
  // ...
  counts.Error++
  // ...

  tags := make(map[string]string)
  tags["foo"] = "bar"

  encoder := fluxline.NewEncoder(&b)
  err := encoder.Encode(measurement, counts, tags)
  if err != nil {
		log.Fatal(err)
	}
  fmt.Print(b.String())
}

Documentation

Index

• type Encoder
  • func NewEncoder(w io.Writer) *Encoder
  • func NewEncoderWithHostname(w io.Writer, host string) *Encoder
  • func (a *Encoder) Encode(prefix string, val interface{}, tags map[string]string) error
  • func (a *Encoder) EncodeMap(prefix string, val map[string]string, tags map[string]string) error
  • func (a *Encoder) EncodeWithoutTypes(prefix string, val interface{}, tags map[string]string) error

Types

type Encoder

type Encoder struct {
	Writer io.Writer
	// contains filtered or unexported fields
}

Encoder represents a component that encapsulates a target environment for measurement submissions, as given by hostname and receiving writer.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder creates a new encoder that writes to the given io.Writer.

func NewEncoderWithHostname

func NewEncoderWithHostname(w io.Writer, host string) *Encoder

NewEncoderWithHostname creates a new encoder that writes to the given io.Writer with an overridden hostname

func (*Encoder) Encode

func (a *Encoder) Encode(prefix string, val interface{},
	tags map[string]string) error

Encode writes the line protocol representation for a given measurement name, data struct and tag map to the io.Writer specified on encoder creation.

func (*Encoder) EncodeMap

func (a *Encoder) EncodeMap(prefix string, val map[string]string,
	tags map[string]string) error

EncodeMap writes the line protocol representation for a given measurement name, field value map and tag map to the io.Writer specified on encoder creation.

func (*Encoder) EncodeWithoutTypes

func (a *Encoder) EncodeWithoutTypes(prefix string, val interface{},
	tags map[string]string) error

EncodeWithoutTypes writes the line protocol representation for a given measurement name, data struct and tag map to the io.Writer specified on encoder creation. In contrast to Encode(), this method never appends type suffixes to values.