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:
stringint32,int64,int16,int8,int,uint32,uint64,uint16,uint8,uintfloat64,float32booltime.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 ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Encoder ¶
Encoder represents a component that encapsulates a target environment for measurement submissions, as given by hostname and receiving writer.
func NewEncoder ¶
NewEncoder creates a new encoder that writes to the given io.Writer.
func NewEncoderWithHostname ¶
NewEncoderWithHostname creates a new encoder that writes to the given io.Writer with an overridden hostname
func (*Encoder) Encode ¶
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 ¶
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 ¶
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.
Source Files