measures

README

Measures

A Go package to send application metrics using UDP.

Usage

Create an instance of Measures specifying the client name and server address:

Measures = measures.New("measures-example", "0.0.0.0:3593")

Count something – a fruit, for example:

Measures.Count("fruits", 1, measures.Dimensions{
    "name": "avocado",
    "color": "green",
})

You can also measure time spent on something:

func someLengthyOperation() {
    defer M.Time("example", time.Now(), nil) // No Dimensions in this case
    time.Sleep(359e6)
}

And you can provide Dimensions at once:

func anotherLengthyOperation() {
    defer M.Time("example", time.Now(), measures.Dimensions{"number": 359})
    time.Sleep(359e6)
}

Or as you have them:

func yetanotherLengthyOperation() {
    d := make(measures.Dimensions, 2)
    defer M.Time("example", time.Now(), d)
    d["number"] = 359
    time.Sleep(359e6)
    d["isPrime"] = true
}

License

Simplified BSD © Measures authors et al

Documentation

Index

• type Client
  • func NewClient(address string) Client
• type Dimensions
• type Measures
  • func New(client, address string) *Measures
  • func (m *Measures) CleanUp()
  • func (m *Measures) Count(metric string, counter int, dimensions Dimensions) (err error)
  • func (m *Measures) SetClient(client Client) (err error)
  • func (m *Measures) Time(metric string, startTime time.Time, dimensions Dimensions) (err error)

Types

type Client

type Client interface {
	Connect() error
	Disconnect() error
	Write(b []byte) (int, error)
}

func NewClient

func NewClient(address string) Client

type Dimensions

type Dimensions map[string]interface{}

type Measures

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

func New

func New(client, address string) *Measures

func (*Measures) CleanUp

func (m *Measures) CleanUp()

func (*Measures) Count

func (m *Measures) Count(metric string, counter int, dimensions Dimensions) (err error)

func (*Measures) SetClient

func (m *Measures) SetClient(client Client) (err error)

func (*Measures) Time

func (m *Measures) Time(metric string, startTime time.Time, dimensions Dimensions) (err error)