stats

README

go-server-stats

The Go-Server-Stats package can be used to count statistics for a web service written in Go.

┌─┐┌─┐   ┌─┐┌─┐┬─┐┬  ┬┌─┐┬─┐   ┌─┐┌┬┐┌─┐┌┬┐┌─┐
│ ┬│ │───└─┐├┤ ├┬┘└┐┌┘├┤ ├┬┘───└─┐ │ ├─┤ │ └─┐
└─┘└─┘   └─┘└─┘┴└─ └┘ └─┘┴└─   └─┘ ┴ ┴ ┴ ┴ └─┘

Installation

To install the package, use the go command

> go get github.com/andrewlader/go-server-stats

Requirements

Requires Go >= v1.2

Usage

Add stats.Stats to the web service. For example:

// the HTTP handler instance
type httpServer struct {
	stats   *stats.Stats
	mux     map[string]apiHandler
}

Then when an API is called, use the Update() method to increment the counters:

server.stats.Update(wasSuccessful, uint64(request.ContentLength), numberOfBytesWritten)

Documentation

Index

• type Output
• type Stats
  • func New() *Stats
  • func (stats *Stats) Bytes() []byte
  • func (stats *Stats) GetOutput() *Output
  • func (stats *Stats) Update(WasSuccessful bool, numberOfBytesReceived uint64, numberOfBytesWritten uint64, ...)

Types

type Output

type Output struct {
	UpTime                      string
	NumberOfCalls               uint64
	NumberOfFailures            uint64
	NumberOfBytesReceived       uint64
	NumberOfBytesWritten        uint64
	AvgResponseTimeMilliseconds uint64
}

Output is what is returned when a stats inquiry is made of the server

type Stats

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

Stats maintains a set of status values for the service

func New

func New() *Stats

New returns a pointer to a new instance of Stats

func (*Stats) Bytes

func (stats *Stats) Bytes() []byte

Bytes returns the stats in the form of a JSON series of bytes

func (*Stats) GetOutput

func (stats *Stats) GetOutput() *Output

GetOutput returns the stats in the form of Output

func (*Stats) Update

func (stats *Stats) Update(WasSuccessful bool, numberOfBytesReceived uint64, numberOfBytesWritten uint64, responseTimeMilliseconds uint64)

Update takes the provide values and increments the stats values using atomic calls