statsd

README

go-statsd

Purpose

Simple Statsd implementation

Usage

package main

import (
    statsd "github.com/cameronnewman/go-statsd"
)

func main() {

    metrics, err := statsd.New(&statsd.Options{
        Host:      "127.0.0.1",
        Port:      9191,
        Namespace: "myapp",
    })
    if err != nil {
        panic(err)
    }

    err = metrics.Counter("Starting", 1)
    if err != nil {
        panic(err)
    }
}

Issues

• None

License

MIT Licensed

Documentation

Overview

Package statsd is simple statsd warpper.

Index

• type Metrics
• type Options
• type Statsd
  • func New(opt *Options) (*Statsd, error)
  • func (s *Statsd) Counter(key string, value int64) error
  • func (s *Statsd) Gauge(key string, value int64) error
  • func (s *Statsd) Timing(key string, start time.Time) error
  • func (s *Statsd) TimingDuration(key string, duration time.Duration) error

Types

type Metrics

type Metrics interface {
	Counter(key string, value int64)
	Gauge(key string, value int64)
	Timing(key string, start time.Time)
	TimingDuration(key string, duration time.Duration)
}

Metrics interface

type Options

type Options struct {
	Host      string `json:"host"`
	Port      int    `json:"port"`
	Namespace string `json:"namespace"`
}

Options for statsd

type Statsd

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

Statsd used to monitor and measure performance

func New

func New(opt *Options) (*Statsd, error)

New creates a statsd client instance

func (*Statsd) Counter

func (s *Statsd) Counter(key string, value int64) error

Counter increase counter for key

func (*Statsd) Gauge

func (s *Statsd) Gauge(key string, value int64) error

Gauge gauge for key

func (*Statsd) Timing

func (s *Statsd) Timing(key string, start time.Time) error

Timing measure for key

func (*Statsd) TimingDuration

func (s *Statsd) TimingDuration(key string, duration time.Duration) error

TimingDuration measures duration for key