stackdriver

Documentation

Overview

Package stackdriver is a generated protocol buffer package.

It is generated from these files:

github.com/google/cloudprober/surfacers/stackdriver/config.proto

It has these top-level messages:

SurfacerConf

Package stackdriver implements the Stackdriver version of the Surfacer object. This package allows users to create an initialized Stack Driver Surfacer and use it to write custom metrics data.

Index

• Constants
• type SDSurfacer
  • func New(config *SurfacerConf, l *logger.Logger) (*SDSurfacer, error)
  • func (s *SDSurfacer) Write(ctxIn context.Context, em *metrics.EventMetrics)
• type SurfacerConf
  • func (*SurfacerConf) Descriptor() ([]byte, []int)
  • func (m *SurfacerConf) GetBatch() bool
  • func (m *SurfacerConf) GetBatchSize() uint64
  • func (m *SurfacerConf) GetBatchTimerSec() uint64
  • func (m *SurfacerConf) GetMonitoringUrl() string
  • func (*SurfacerConf) ProtoMessage()
  • func (m *SurfacerConf) Reset()
  • func (m *SurfacerConf) String() string

Constants

const Default_SurfacerConf_Batch bool = true

const Default_SurfacerConf_BatchSize uint64 = 200

const Default_SurfacerConf_BatchTimerSec uint64 = 10

const Default_SurfacerConf_MonitoringUrl string = "custom.googleapis.com/cloudprober/"

Types

type SDSurfacer

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

SDSurfacer structure for StackDriver, which includes an authenticated client for making StackDriver API calls, and a registered which is in charge of keeping track of what metrics have already been registereded

func New

func New(config *SurfacerConf, l *logger.Logger) (*SDSurfacer, error)

New initializes a SDSurfacer for Stack Driver with all its necessary internal variables for call references (project and instances variables) as well as provisioning it with clients for making the necessary API calls. New requires you to pass in a valid stackdriver surfacer configuration.

func (*SDSurfacer) Write

func (s *SDSurfacer) Write(ctxIn context.Context, em *metrics.EventMetrics)

Write queues a message to be written to stackdriver.

type SurfacerConf

type SurfacerConf struct {
	Batch            *bool   `protobuf:"varint,1,opt,name=batch,def=1" json:"batch,omitempty"`
	BatchSize        *uint64 `protobuf:"varint,2,opt,name=batch_size,json=batchSize,def=200" json:"batch_size,omitempty"`
	BatchTimerSec    *uint64 `protobuf:"varint,3,opt,name=batch_timer_sec,json=batchTimerSec,def=10" json:"batch_timer_sec,omitempty"`
	MonitoringUrl    *string `` /* 132-byte string literal not displayed */
	XXX_unrecognized []byte  `json:"-"`
}

func (*SurfacerConf) Descriptor

func (*SurfacerConf) Descriptor() ([]byte, []int)

func (*SurfacerConf) GetBatch

func (m *SurfacerConf) GetBatch() bool

func (*SurfacerConf) GetBatchSize

func (m *SurfacerConf) GetBatchSize() uint64

func (*SurfacerConf) GetBatchTimerSec

func (m *SurfacerConf) GetBatchTimerSec() uint64

func (*SurfacerConf) GetMonitoringUrl

func (m *SurfacerConf) GetMonitoringUrl() string

func (*SurfacerConf) ProtoMessage

func (*SurfacerConf) ProtoMessage()

func (*SurfacerConf) Reset

func (m *SurfacerConf) Reset()

func (*SurfacerConf) String

func (m *SurfacerConf) String() string