stackdriver

Documentation

Overview

Package stackdriver contains the OpenCensus exporters for Stackdriver Monitoring and Tracing.

Please note that the Stackdriver exporter is currently experimental.

Create an exporter:

import (
	"go.opencensus.io/exporter/stackdriver"
	"go.opencensus.io/trace"
	"go.opencensus.io/stats"
)

exporter, err := stackdriver.NewExporter(stackdriver.Options{ProjectID: "google-project-id"})
if err != nil {
	log.Fatal(err)
}

Export to Stackdriver Stats:

stats.RegisterExporter(exporter)

Export to Stackdriver Trace:

trace.RegisterExporter(exporter)

The package uses Application Default Credentials to authenticate. See https://developers.google.com/identity/protocols/application-default-credentials

Exporter can be used to propagate traces over HTTP requests for Stackdriver Trace.

Example:

import (
	"go.opencensus.io/plugin/http/httptrace"
	"go.opencensus.io/plugin/http/propagation/google"
)

client := &http.Client {
	Transport: httptrace.NewTransport(nil, &google.HTTPFormat{}),
}

All outgoing requests from client will include a Stackdriver Trace header. See the httptrace package for how to handle incoming requests.

Package stackdriver contains the OpenCensus exporters for Stackdriver Monitoring.

Please note that the Stackdriver exporter is currently experimental.

Index

• type Exporter
  • func NewExporter(o Options) (*Exporter, error)
  • func (e *Exporter) ExportSpan(sd *trace.SpanData)
  • func (e *Exporter) ExportView(vd *stats.ViewData)
  • func (e *Exporter) Flush()
• type Options

Types

type Exporter

type Exporter struct {
	// contains filtered or unexported fields
}

Exporter is a stats.Exporter and trace.Exporter implementation that uploads data to Stackdriver.

func NewExporter

func NewExporter(o Options) (*Exporter, error)

func (*Exporter) ExportSpan

func (e *Exporter) ExportSpan(sd *trace.SpanData)

ExportSpan exports a SpanData to Stackdriver Trace.

func (*Exporter) ExportView

func (e *Exporter) ExportView(vd *stats.ViewData)

ExportView exports to the Stackdriver Monitoring if view data has one or more rows.

func (*Exporter) Flush

func (e *Exporter) Flush()

Flush waits for exported data to be uploaded.

This is useful if your program is ending and you do not want to lose recent stats or spans.

type Options

type Options struct {
	// ProjectID is the identifier of the Stackdriver
	// project the user is uploading the stats data to.
	ProjectID string

	// OnError is the hook to be called when there is
	// an error occurred when uploading the stats data.
	// If no custom hook is set, errors are logged.
	// Optional.
	OnError func(err error)

	// ClientOptions are additional options to be passed
	// to the underlying Stackdriver Monitoring API client.
	// Optional.
	ClientOptions []option.ClientOption

	// BundleDelayThreshold determines the max amount of time
	// the exporter can wait before uploading view data to
	// the backend.
	// Optional.
	BundleDelayThreshold time.Duration

	// BundleCountThreshold determines how many view data events
	// can be buffered before batch uploading them to the backend.
	// Optional.
	BundleCountThreshold int

	// Resource is an optional field that represents the Stackdriver
	// MonitoredResource, a resource that can be used for monitoring.
	// If no custom ResourceDescriptor is set, a default MonitoredResource
	// with type global and no resource labels will be used.
	// Optional.
	Resource *monitoredrespb.MonitoredResource
}

Options contains options for configuring the exporter.