Categorygithub.com/stathat/go
modulepackage
1.0.0
Repository: https://github.com/stathat/go.git
Documentation: pkg.go.dev

# README

stathat

This is a Go package for posting stats to your StatHat account.

For more information about StatHat, visit www.stathat.com.

Installation

Use go get:

go get github.com/stathat/go

That's it.

Import it like this:

import (
        "github.com/stathat/go"
)

Usage

The easiest way to use the package is with the EZ API functions. You can add stats directly in your code by just adding a call with a new stat name. Once StatHat receives the call, a new stat will be created for you.

To post a count of 1 to a stat:

stathat.PostEZCountOne("messages sent - female to male", "[email protected]")

To specify the count:

stathat.PostEZCount("messages sent - male to male", "[email protected]", 37)

To post a value:

stathat.PostEZValue("ws0 load average", "[email protected]", 0.372)

There are also functions for the classic API. The drawback to the classic API is that you need to create the stats using the web interface and copy the keys it gives you into your code.

To post a count of 1 to a stat using the classic API:

stathat.PostCountOne("statkey", "userkey")

To specify the count:

stathat.PostCount("statkey", "userkey", 37)

To post a value:

stathat.PostValue("statkey", "userkey", 0.372)

Contact us

We'd love to hear from you if you are using this in your projects! Please drop us a line: @stat_hat or contact us here.

About

Written by Patrick Crosby at StatHat. Twitter: @stat_hat

# Functions

NewBatchReporter creates a batching stat reporter.
NewReporter returns a new Reporter.
Using the classic API, posts a count to a stat using DefaultReporter.
Using the classic API, posts a count of 1 to a stat using DefaultReporter.
Using the classic API, posts a count to a stat using DefaultReporter at a specific time.
Using the EZ API, posts a count to a stat using DefaultReporter.
Using the EZ API, posts a count of 1 to a stat using DefaultReporter.
Using the EZ API, posts a count to a stat at a specific time using DefaultReporter.
Using the EZ API, posts a value to a stat using DefaultReporter.
Using the EZ API, posts a value to a stat at a specific time using DefaultReporter.
Using the classic API, posts a value to a stat using DefaultReporter.
Using the classic API, posts a value to a stat at a specific time using DefaultReporter.
Wait for all stats to be sent, or until timeout.

# Variables

DefaultReporter is the default instance of *Reporter.
The Verbose flag determines if the package should write verbose output to stdout.

# Structs

BasicReporter is a StatHat client that can report stat values/counts to the servers.
BatchReporter wraps an existing Reporter in order to implement sending stats to the StatHat server in batch.

# Interfaces

Reporter describes an interface for communicating with the StatHat API.