Documentation
¶
Overview ¶
Package tsmon contains global state and utility functions for configuring and interacting with tsmon. This has a similar API to the infra-python ts_mon module.
Users of tsmon should call InitializeFromFlags from their application's main function.
Index ¶
- Constants
- func Flush(c context.Context) error
- func Initialize(c context.Context, m monitor.Monitor, s store.Store)
- func InitializeFromFlags(c context.Context, fl *Flags) error
- func Monitor(c context.Context) monitor.Monitor
- func Register(c context.Context, m types.Metric)
- func RegisterCallback(f Callback)
- func RegisterCallbackIn(c context.Context, f Callback)
- func RegisterGlobalCallback(f Callback, metrics ...types.Metric)
- func RegisterGlobalCallbackIn(c context.Context, f Callback, metrics ...types.Metric)
- func ResetCumulativeMetrics(c context.Context)
- func SetStore(c context.Context, s store.Store)
- func Shutdown(c context.Context)
- func Store(c context.Context) store.Store
- func Unregister(c context.Context, m types.Metric)
- func WithDummyInMemory(c context.Context) (context.Context, *monitor.Fake)
- func WithFakes(c context.Context) (context.Context, *store.Fake, *monitor.Fake)
- func WithState(c context.Context, s *State) context.Context
- type Callback
- type Flags
- type FlushType
- type GlobalCallback
- type State
Constants ¶
Variables ¶
This section is empty.
Functions ¶
func Flush ¶
Flush sends all the metrics that are registered in the application.
func Initialize ¶
Initialize configures the tsmon library with the given monitor and store.
func InitializeFromFlags ¶
InitializeFromFlags configures the tsmon library from flag values.
This will set a Target (information about what's reporting metrics) and a Monitor (where to send the metrics to).
func Monitor ¶
Monitor returns the global monitor that sends metrics to monitoring endpoints. Defaults to a nil monitor, but changed by InitializeFromFlags.
func Register ¶
Register is called by metric objects to register themselves. This will panic if another metric with the same name is already registered.
func RegisterCallback ¶
func RegisterCallback(f Callback)
RegisterCallback registers a callback function that will be run at metric collection time to set the values of one or more metrics. RegisterCallback should be called from an init() function in your module.
func RegisterCallbackIn ¶
RegisterCallbackIn is like RegisterCallback but registers in a given context.
func RegisterGlobalCallback ¶
RegisterGlobalCallback registers a callback function that will be run once per minute on *one* instance of your application. It is supported primarily on GAE.
You must specify the list of metrics that your callback affects - these metrics will be reset after flushing to ensure they are not sent by multiple instances.
RegisterGlobalCallback should be called from an init() function in your module.
func RegisterGlobalCallbackIn ¶
RegisterGlobalCallbackIn is like RegisterGlobalCallback but registers in a given context.
func ResetCumulativeMetrics ¶
ResetCumulativeMetrics resets only cumulative metrics.
func SetStore ¶
SetStore changes the global metric store. All metrics that were registered with the old store will be re-registered on the new store.
func Shutdown ¶
Shutdown gracefully terminates the tsmon by doing the final flush and disabling auto flush (if it was enabled).
It resets Monitor and Store.
Logs error to standard logger. Does nothing if tsmon wasn't initialized.
func Store ¶
Store returns the global metric store that contains all the metric values for this process. Applications shouldn't need to access this directly - instead use the metric objects which provide type-safe accessors.
func Unregister ¶
Unregister is called by metric objects to unregister themselves.
func WithDummyInMemory ¶
WithDummyInMemory returns a new context holding a new State with a new in- memory store and a fake monitor.
func WithFakes ¶
WithFakes returns a new context holding a new State with a fake store and a fake monitor.
Types ¶
type Callback ¶
Callback is a function that is run at metric collection time to set the values of one or more metrics. A callback can be registered with RegisterCallback.
type Flags ¶
type Flags struct {
ConfigFile string
Endpoint string
Credentials string
ActAs string
Flush FlushType
FlushInterval time.Duration
Target target.Flags
}
Flags defines command line flags related to tsmon. Use NewFlags() to get a Flags struct with sensible default values.
type GlobalCallback ¶
A GlobalCallback is a Callback with the list of metrics it affects, so those metrics can be reset after they are flushed.
type State ¶
type State struct {
S store.Store
M monitor.Monitor
Flusher *autoFlusher
RegisteredMetrics map[string]types.Metric
RegisteredMetricsLock sync.RWMutex
CallbacksMutex sync.RWMutex
Callbacks []Callback
GlobalCallbacks []GlobalCallback
InvokeGlobalCallbacksOnFlush bool
}
State holds the configuration of the tsmon library. There is one global instance of State, but it can be overridden in a Context by tests.
func GetState ¶
GetState returns the State instance held in the context (if set) or else returns the global state.
func NewState ¶
func NewState() *State
NewState returns a new default State, configured with a nil Store and Monitor.
func (*State) Flush ¶
Flush sends all the metrics that are registered in the application.
Uses given monitor if not nil, or the state.M otherwise.
func (*State) ResetCumulativeMetrics ¶
ResetCumulativeMetrics resets only cumulative metrics.
func (*State) RunGlobalCallbacks ¶
RunGlobalCallbacks runs all registered global callbacks that produce global metrics.
See RegisterGlobalCallback for more info.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package distribution contains distribution metrics, fixed width and geometric bucketers.
|
Package distribution contains distribution metrics, fixed width and geometric bucketers. |
|
Package field contains constructors for metric field definitions.
|
Package field contains constructors for metric field definitions. |
|
Package metric is the API for defining metrics and updating their values.
|
Package metric is the API for defining metrics and updating their values. |
|
Package monitor contains the code for sending metric data to monitoring endpoints.
|
Package monitor contains the code for sending metric data to monitoring endpoints. |
|
Package runtimestats exposes metrics related to the Go runtime.
|
Package runtimestats exposes metrics related to the Go runtime. |
|
Package store contains code for storing and retreiving metrics.
|
Package store contains code for storing and retreiving metrics. |
|
storetest
Package storetest is imported exclusively by tests for Store implementations.
|
Package storetest is imported exclusively by tests for Store implementations. |
|
Package target contains information about the thing that is sending metrics - either a NetworkDevice (a machine) or a Task (a service).
|
Package target contains information about the thing that is sending metrics - either a NetworkDevice (a machine) or a Task (a service). |
|
Package ts_mon_proto is a generated protocol buffer package.
|
Package ts_mon_proto is a generated protocol buffer package. |
|
Package types contains miscellaneous structs and interfaces used throughout tsmon.
|
Package types contains miscellaneous structs and interfaces used throughout tsmon. |
|
Package versions allows processes to report string-valued metrics with versions of various libraries they link with.
|
Package versions allows processes to report string-valued metrics with versions of various libraries they link with. |