README
¶
Stats
Stats is a statistics collection library for your Go applications. It collects data on a regular, configurable interval and sends it to a configurable collections client.
Supported statistics
- Memory usage
- Goroutines
- Garbage Collection
- CGO Calls
Supported collector clients
- statsd
Example
package main
import (
"github.com/jelmersnoeck/stats"
"github.com/jelmersnoeck/stats/clients/statsd"
)
func main() {
cl, err := statsd.New()
if err != nil {
// error connecting to statsd
}
s := stats.New(stats.Client(cl))
go s.Collect()
}
Documentation
¶
Index ¶
- func CollectCgo(c bool) collectionOption
- func CollectGC(c bool) collectionOption
- func CollectGoroutines(c bool) collectionOption
- func CollectMemory(c bool) collectionOption
- func CollectionClient(c Client) collectionOption
- func CollectionInterval(d time.Duration) collectionOption
- func New(opts ...collectionOption) *collector
- type AppStat
- type Client
- type NilClient
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CollectCgo ¶
func CollectCgo(c bool) collectionOption
CollectCgo is the option to enable or disable collection of the number of Cgo calls made by the application. This is enabled by default.
func CollectGC ¶
func CollectGC(c bool) collectionOption
CollectGC is the option to enable or disable collection of Garbage Collection information. This includes number of GC runs and the GC run times. This is enabled by default.
func CollectGoroutines ¶
func CollectGoroutines(c bool) collectionOption
CollectGoroutines is the option to enable or disable goroutine collection. This is enabled by default.
func CollectMemory ¶
func CollectMemory(c bool) collectionOption
CollectMemory is the option to enable or disable memory collection. This is enabled by default.
func CollectionClient ¶
func CollectionClient(c Client) collectionOption
CollectionClient represents the collection client we'll be using to send our collected data to. This can be an HTTP Client, a Statsd client, etc. as long as it conforms to the Client interface. The default client is the nil client, this client disregards any input that is passed through.
func CollectionInterval ¶
CollectionInterval sets the duration between collection runs. The default is 60 seconds.
Source Files
Directories