proto

Documentation

Index

• Constants
• Variables
• type SurfacerConf
  • func (*SurfacerConf) Descriptor() ([]byte, []int)
  • func (x *SurfacerConf) GetAllowedMetricsRegex() string
  • func (x *SurfacerConf) GetBatchTimerSec() uint64
  • func (x *SurfacerConf) GetMetricsBufferSize() int64
  • func (x *SurfacerConf) GetMetricsPrefix() SurfacerConf_MetricPrefix
  • func (x *SurfacerConf) GetMonitoringUrl() string
  • func (x *SurfacerConf) GetProject() string
  • func (*SurfacerConf) ProtoMessage()
  • func (x *SurfacerConf) ProtoReflect() protoreflect.Message
  • func (x *SurfacerConf) Reset()
  • func (x *SurfacerConf) String() string
• type SurfacerConf_MetricPrefix
  • func (SurfacerConf_MetricPrefix) Descriptor() protoreflect.EnumDescriptor
  • func (x SurfacerConf_MetricPrefix) Enum() *SurfacerConf_MetricPrefix
  • func (SurfacerConf_MetricPrefix) EnumDescriptor() ([]byte, []int)
  • func (x SurfacerConf_MetricPrefix) Number() protoreflect.EnumNumber
  • func (x SurfacerConf_MetricPrefix) String() string
  • func (SurfacerConf_MetricPrefix) Type() protoreflect.EnumType
  • func (x *SurfacerConf_MetricPrefix) UnmarshalJSON(b []byte) error

Constants

const (
	Default_SurfacerConf_BatchTimerSec     = uint64(10)
	Default_SurfacerConf_MonitoringUrl     = string("custom.googleapis.com/cloudprober/")
	Default_SurfacerConf_MetricsBufferSize = int64(10000)
	Default_SurfacerConf_MetricsPrefix     = SurfacerConf_PTYPE_PROBE
)

Default values for SurfacerConf fields.

Variables

var (
	SurfacerConf_MetricPrefix_name = map[int32]string{
		0: "NONE",
		1: "PROBE",
		2: "PTYPE_PROBE",
	}
	SurfacerConf_MetricPrefix_value = map[string]int32{
		"NONE":        0,
		"PROBE":       1,
		"PTYPE_PROBE": 2,
	}
)

Enum value maps for SurfacerConf_MetricPrefix.

var File_github_com_cloudprober_cloudprober_surfacers_internal_stackdriver_proto_config_proto protoreflect.FileDescriptor

Types

type SurfacerConf

type SurfacerConf struct {

	// GCP project name for stackdriver. If not specified and running on GCP,
	// project is used.
	Project *string `protobuf:"bytes,1,opt,name=project" json:"project,omitempty"`
	// How often to export metrics to stackdriver.
	BatchTimerSec *uint64 `protobuf:"varint,2,opt,name=batch_timer_sec,json=batchTimerSec,def=10" json:"batch_timer_sec,omitempty"`
	// If allowed_metrics_regex is specified, only metrics matching the given
	// regular expression will be exported to stackdriver. Since probe type and
	// probe name are part of the metric name, you can use this field to restrict
	// stackdriver metrics to a particular probe.
	// Example:
	// allowed_metrics_regex: ".*(http|ping).*(success|validation_failure).*"
	//
	// Deprecated: Please use the common surfacer options to filter metrics:
	// https://cloudprober.org/docs/surfacers/overview/#filtering-metrics
	AllowedMetricsRegex *string `protobuf:"bytes,3,opt,name=allowed_metrics_regex,json=allowedMetricsRegex" json:"allowed_metrics_regex,omitempty"`
	// Monitoring URL base. Full metric URL looks like the following:
	// <monitoring_url>/<ptype>/<probe>/<metric>
	// Example:
	// custom.googleapis.com/cloudprober/http/google-homepage/latency
	MonitoringUrl *string `` /* 132-byte string literal not displayed */
	// How many metrics entries to buffer. Incoming metrics
	// processing is paused while serving data to Stackdriver. This buffer is to
	// make writes to Stackdriver surfacer non-blocking.
	MetricsBufferSize *int64 `protobuf:"varint,5,opt,name=metrics_buffer_size,json=metricsBufferSize,def=10000" json:"metrics_buffer_size,omitempty"`
	// Metric prefix to use for stackdriver metrics. If not specified, default
	// is PTYPE_PROBE.
	MetricsPrefix *SurfacerConf_MetricPrefix `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*SurfacerConf) Descriptor

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

Deprecated: Use SurfacerConf.ProtoReflect.Descriptor instead.

func (*SurfacerConf) GetAllowedMetricsRegex

func (x *SurfacerConf) GetAllowedMetricsRegex() string

func (*SurfacerConf) GetBatchTimerSec

func (x *SurfacerConf) GetBatchTimerSec() uint64

func (*SurfacerConf) GetMetricsBufferSize

func (x *SurfacerConf) GetMetricsBufferSize() int64

func (*SurfacerConf) GetMetricsPrefix

func (x *SurfacerConf) GetMetricsPrefix() SurfacerConf_MetricPrefix

func (*SurfacerConf) GetMonitoringUrl

func (x *SurfacerConf) GetMonitoringUrl() string

func (*SurfacerConf) GetProject

func (x *SurfacerConf) GetProject() string

func (*SurfacerConf) ProtoMessage

func (*SurfacerConf) ProtoMessage()

func (*SurfacerConf) ProtoReflect

func (x *SurfacerConf) ProtoReflect() protoreflect.Message

func (*SurfacerConf) Reset

func (x *SurfacerConf) Reset()

func (*SurfacerConf) String

func (x *SurfacerConf) String() string

type SurfacerConf_MetricPrefix

type SurfacerConf_MetricPrefix int32

const (
	SurfacerConf_NONE        SurfacerConf_MetricPrefix = 0 // monitoring_url/metric_name
	SurfacerConf_PROBE       SurfacerConf_MetricPrefix = 1 // monitoring_url/probe/metric_name
	SurfacerConf_PTYPE_PROBE SurfacerConf_MetricPrefix = 2 // monitoring_url/ptype/probe/metric_name
)

func (SurfacerConf_MetricPrefix) Descriptor

func (SurfacerConf_MetricPrefix) Descriptor() protoreflect.EnumDescriptor

func (SurfacerConf_MetricPrefix) Enum

func (x SurfacerConf_MetricPrefix) Enum() *SurfacerConf_MetricPrefix

func (SurfacerConf_MetricPrefix) EnumDescriptor

func (SurfacerConf_MetricPrefix) EnumDescriptor() ([]byte, []int)

Deprecated: Use SurfacerConf_MetricPrefix.Descriptor instead.

func (SurfacerConf_MetricPrefix) Number

func (x SurfacerConf_MetricPrefix) Number() protoreflect.EnumNumber

func (SurfacerConf_MetricPrefix) String

func (x SurfacerConf_MetricPrefix) String() string

func (SurfacerConf_MetricPrefix) Type

func (SurfacerConf_MetricPrefix) Type() protoreflect.EnumType

func (*SurfacerConf_MetricPrefix) UnmarshalJSON

func (x *SurfacerConf_MetricPrefix) UnmarshalJSON(b []byte) error

Deprecated: Do not use.