stackdriver.NewSink's return value satisfies the go-metrics library's MetricSink interface. When providing a stackdriver.Sink to libraries and applications instrumented against MetricSink, the metrics will be aggregated within this library and written to stackdriver as Generic Task timeseries metrics.

Example

import "github.com/google/go-metrics-stackdriver"
...
client, _ := monitoring.NewMetricClient(context.Background())
ss := stackdriver.NewSink(client, &stackdriver.Config{
  ProjectID: projectID,
})
...
ss.SetGauge([]string{"foo"}, 42)
ss.IncrCounter([]string{"baz"}, 1)
ss.AddSample([]string{"method", "const"}, 200)

The full example can be run from a cloud shell console to test how metrics are collected and displayed.

You can also try out the example using Cloud Run!

# Packages

example

vault

Package vault provides helper functions to improve the go-metrics to stackdriver metric conversions specific to HashiCorp Vault.

# Functions

DefaultBucketer

DefaultBucketer is the default BucketFn used to determing bucketing values for metrics.

DefaultLabelExtractor

DefaultLabelExtractor is the default ExtractLabelsFn and is a direct passthrough.

NewSink

NewSink creates a Sink to flush metrics to stackdriver every interval.

# Structs

Config

Config options for the stackdriver Sink.

Sink

Sink conforms to the metrics.MetricSink interface and is used to transmit metrics information to stackdriver.

# Interfaces

Logger

Logger is the log interface used in go-metrics-stackdriver.

# Type aliases

BucketFn

BucketFn returns the histogram bucket thresholds based on the given metric name.

ExtractLabelsFn

ExtractLabelsFn converts a given metric name and type into a new metric name and optionally additional labels.