Documentation
¶
Index ¶
- Constants
- Variables
- func Setup(configList ...interface{})
- func StopRuntimeStats()
- type ConfigStats
- type HandleT
- type RudderStats
- type RudderStatsT
- func (rStats *RudderStatsT) Count(n int)
- func (rStats *RudderStatsT) DeferredTimer()
- func (rStats *RudderStatsT) End()
- func (rStats *RudderStatsT) Gauge(value interface{})
- func (rStats *RudderStatsT) Increment()
- func (rStats *RudderStatsT) SendTiming(duration time.Duration)
- func (rStats *RudderStatsT) Start()
- type Stats
- type Tags
Constants ¶
const ( CountType = "count" TimerType = "timer" GaugeType = "gauge" )
Variables ¶
var DefaultConfigStats = ConfigStats{StatsEnabled: false, StatsdServerURL: "localhost:8125", InstanceID: "", Enabled: true, StatsCollectionInterval: 10, EnableCPUStats: true, EnableMemStats: true, EnableGCStats: true, StatsSamplingRate: 1, ConfigLog: logger.DefaultConfigLogger, ErrorFilePath: "/tmp/error_store.json", KubeNameSpace: ""}
Functions ¶
Types ¶
type ConfigStats ¶
type HandleT ¶
type HandleT struct {
}
HandleT is the default implementation of Stats
func (*HandleT) NewSampledTaggedStat ¶
func (s *HandleT) NewSampledTaggedStat(Name string, StatType string, tags Tags) (rStats RudderStats)
func (*HandleT) NewStat ¶
func (s *HandleT) NewStat(Name string, StatType string) (rStats RudderStats)
NewStat creates a new RudderStats with provided Name and Type
func (*HandleT) NewTaggedStat ¶
func (s *HandleT) NewTaggedStat(Name string, StatType string, tags Tags) (rStats RudderStats)
type RudderStats ¶
type RudderStats interface {
Count(n int)
Increment()
Gauge(value interface{})
Start()
End()
DeferredTimer()
SendTiming(duration time.Duration)
}
RudderStats provides functions to interact with StatsD stats
func NewStat ¶
func NewStat(Name string, StatType string) (rStats RudderStats)
NewStat creates a new RudderStats with provided Name and Type Deprecated: Use DefaultStats for managing stats instead
func NewTaggedStat ¶
func NewTaggedStat(Name string, StatType string, tags Tags) (rStats RudderStats)
type RudderStatsT ¶
type RudderStatsT struct {
Name string
StatType string
Timing statsd.Timing
DestID string
Client *statsd.Client
// contains filtered or unexported fields
}
RudderStatsT is the default implementation of a StatsD stat
func (*RudderStatsT) Count ¶
func (rStats *RudderStatsT) Count(n int)
Count increases the stat by n. Only applies to CountType stats
func (*RudderStatsT) DeferredTimer ¶
func (rStats *RudderStatsT) DeferredTimer()
func (*RudderStatsT) End ¶
func (rStats *RudderStatsT) End()
End send the time elapsed since the Start() call of this stat. Only applies to TimerType stats
func (*RudderStatsT) Gauge ¶
func (rStats *RudderStatsT) Gauge(value interface{})
Gauge records an absolute value for this stat. Only applies to GaugeType stats
func (*RudderStatsT) Increment ¶
func (rStats *RudderStatsT) Increment()
Increment increases the stat by 1. Is the Equivalent of Count(1). Only applies to CountType stats
func (*RudderStatsT) SendTiming ¶
func (rStats *RudderStatsT) SendTiming(duration time.Duration)
Timing sends a timing for this stat. Only applies to TimerType stats
func (*RudderStatsT) Start ¶
func (rStats *RudderStatsT) Start()
Start starts a new timing for this stat. Only applies to TimerType stats
type Stats ¶
type Stats interface {
NewStat(Name string, StatType string) (rStats RudderStats)
NewTaggedStat(Name string, StatType string, tags Tags) RudderStats
NewSampledTaggedStat(Name string, StatType string, tags Tags) RudderStats
}
Stats manages provisioning of RudderStats
var DefaultStats Stats
DefaultStats is a common implementation of StatsD stats managements
Source Files