honeycomb

README

go-metrics-honeycomb

This is a simple reporter for rcrowley's go-metrics library, designed to work with the Honeycomb metrics reporting service.

For more information, check out the GoDoc.

Usage

Basic usage:

import (
  "time"

  "github.com/getspine/go-metrics-honeycomb"
  "github.com/rcrowley/go-metrics"
)

go honeycomb.Honeycomb(
  metrics.DefaultRegistry,
  60 * time.Second,      // Interval between sending metrics
  "your-write-key",      // Honeycomb write key
  "your-dataset",        // Honeycomb dataset
  []float64{0.95, 0.99}, // Percentiles to report from histograms
)

If you wish to add extra fields or other configuration to the Honeycomb client, you can use the following procedure:

import (
  "time"

  "github.com/getspine/go-metrics-honeycomb"
  "github.com/honeycombio/libhoney-go"
  "github.com/rcrowley/go-metrics"
)

reporter := honeycomb.NewReporter(
  metrics.DefaultRegistry,
  60 * time.Second,      // Interval between sending metrics
  "your-write-key",      // Honeycomb write key
  "your-dataset",        // Honeycomb dataset,
  []float64{0.95, 0.99}, // Percentiles to report from histograms
)

libhoney.AddField("philcollins", "sussudio")
...

go reporter.Run()

Installation

$ go get github.com/getspine/go-metrics-honeycomb

Bugs

If you run into any bugs, please drop an issue on our GitHub and we'll be sure to have a look.

Documentation

Index

• Variables
• func Honeycomb(registry metrics.Registry, interval time.Duration, writeKey string, ...)
• type Reporter
  • func NewDefaultReporter(registry metrics.Registry, writeKey string, dataset string) *Reporter
  • func NewReporter(registry metrics.Registry, interval time.Duration, writeKey string, ...) *Reporter
  • func (r *Reporter) AddField(key string, val interface{})
  • func (r *Reporter) Init()
  • func (r *Reporter) Run()
  • func (r *Reporter) Stop()

Variables

var DefaultInterval = 60 * time.Second

var DefaultPercentiles = []float64{.5, .95, .99, .999}

Functions

func Honeycomb

func Honeycomb(
	registry metrics.Registry,
	interval time.Duration,
	writeKey string,
	dataset string,
	percentiles []float64,
)

Types

type Reporter

type Reporter struct {
	Registry    metrics.Registry
	Interval    time.Duration
	WriteKey    string
	Dataset     string
	Percentiles []float64 // percentiles to report on histogram metrics
	// contains filtered or unexported fields
}

func NewDefaultReporter

func NewDefaultReporter(
	registry metrics.Registry,
	writeKey string,
	dataset string,
) *Reporter

func NewReporter

func NewReporter(
	registry metrics.Registry,
	interval time.Duration,
	writeKey string,
	dataset string,
	percentiles []float64,
) *Reporter

func (*Reporter) AddField

func (r *Reporter) AddField(key string, val interface{})

Convenience method around libhoney.AddField()

func (*Reporter) Init

func (r *Reporter) Init()

Initializes the Honeycomb client.

func (*Reporter) Run

func (r *Reporter) Run()

Blocks and starts reporting metrics from the provided registry to Honeycomb.

func (*Reporter) Stop

func (r *Reporter) Stop()

Stops the metrics reporting process and closes any connections to Honeycomb.