metrics

Documentation

Overview

Package metrics provides routines for conveniently reporting metrics attached to SSF spans.

Index

• func Report(cl *trace.Client, samples *ssf.Samples) error
• func ReportAsync(cl *trace.Client, metrics []*ssf.SSFSample, done chan<- error) error
• func ReportBatch(cl *trace.Client, samples []*ssf.SSFSample) error
• func ReportOne(cl *trace.Client, metric *ssf.SSFSample) error
• type NoMetrics
  • func (nm NoMetrics) Error() string

Examples

• Report
• ReportAsync
• ReportOne

Functions

func Report

func Report(cl *trace.Client, samples *ssf.Samples) error

Report sends one-off metric samples encapsulated in a Samples structure to a trace client without waiting for a reply. If the batch of metrics is empty, an error NoMetrics is returned.

Example

func ReportAsync

func ReportAsync(cl *trace.Client, metrics []*ssf.SSFSample, done chan<- error) error

ReportAsync sends a batch of one-off metrics to a trace client asynchronously. The channel done receives an error (or nil) when the span containing the batch of metrics has been sent.

If metrics is empty, an error NoMetrics is returned and done does not receive any data.

Example

func ReportBatch

func ReportBatch(cl *trace.Client, samples []*ssf.SSFSample) error

ReportBatch sends a batch of one-off metrics to a trace client without waiting for a reply. If the batch of metrics is empty, an error NoMetrics is returned.

func ReportOne

func ReportOne(cl *trace.Client, metric *ssf.SSFSample) error

ReportOne sends a single metric to a veneur using a trace client without waiting for a reply.

Example

Types

type NoMetrics

type NoMetrics struct{}

NoMetrics indicates that no metrics were included in the batch of metrics to submit.

func (NoMetrics) Error

func (nm NoMetrics) Error() string