Documentation ¶
Overview ¶
Package metrics provides a simple API for sending value and counter metrics through the dropsonde system.
Use ¶
See the documentation for package dropsonde for configuration details.
Importing package dropsonde and initializing will initial this package. To send metrics use
metrics.SendValue(name, value, unit)
for sending known quantities, and
metrics.IncrementCounter(name)
to increment a counter. (Note that the value of the counter is maintained by the receiver of the counter events, not the application that includes this package.)
Index ¶
- func AddToCounter(name string, delta uint64) error
- func IncrementCounter(name string) error
- func Initialize(ms metric_sender.MetricSender)
- func SendContainerMetric(applicationId string, instanceIndex int32, cpuPercentage float64, ...) error
- func SendValue(name string, value float64, unit string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddToCounter ¶
AddToCounter sends an event to increment the named counter by the specified (positive) delta. Maintaining the value of the counter is the responsibility of the receiver, as with IncrementCounter.
func IncrementCounter ¶
IncrementCounter sends an event to increment the named counter by one. Maintaining the value of the counter is the responsibility of the receiver of the event, not the process that includes this package.
func Initialize ¶
func Initialize(ms metric_sender.MetricSender)
Initialize prepares the metrics package for use with the automatic Emitter.
func SendContainerMetric ¶
func SendContainerMetric(applicationId string, instanceIndex int32, cpuPercentage float64, memoryBytes uint64, diskBytes uint64) error
SendContainerMetric sends a metric that records resource usage of an app in a container. The container is identified by the applicationId and the instanceIndex. The resource metrics are CPU percentage, memory and disk usage in bytes. Returns an error if one occurs when sending the metric.
Types ¶
This section is empty.