proto

Documentation

Index

• Constants
• Variables
• type SurfacerConf
  • func (*SurfacerConf) Descriptor() ([]byte, []int)
  • func (x *SurfacerConf) GetIncludeTimestamp() bool
  • func (x *SurfacerConf) GetMetricsBufferSize() int64
  • func (x *SurfacerConf) GetMetricsPrefix() string
  • func (x *SurfacerConf) GetMetricsUrl() string
  • func (*SurfacerConf) ProtoMessage()
  • func (x *SurfacerConf) ProtoReflect() protoreflect.Message
  • func (x *SurfacerConf) Reset()
  • func (x *SurfacerConf) String() string

Constants

const (
	Default_SurfacerConf_MetricsBufferSize = int64(10000)
	Default_SurfacerConf_IncludeTimestamp  = bool(true)
	Default_SurfacerConf_MetricsUrl        = string("/metrics")
)

Default values for SurfacerConf fields.

Variables

var File_github_com_google_cloudprober_surfacers_prometheus_proto_config_proto protoreflect.FileDescriptor

Types

type SurfacerConf

type SurfacerConf struct {

	// How many metrics entries (EventMetrics) to buffer. Incoming metrics
	// processing is paused while serving data to prometheus. This buffer is to
	// make writes to prometheus surfacer non-blocking.
	// NOTE: This field is confusing for users and will be removed from the config
	// after v0.10.3.
	MetricsBufferSize *int64 `protobuf:"varint,1,opt,name=metrics_buffer_size,json=metricsBufferSize,def=10000" json:"metrics_buffer_size,omitempty"`
	// Whether to include timestamps in metrics. If enabled (default) each metric
	// string includes the metric timestamp as recorded in the EventMetric.
	// Prometheus associates the scraped values with this timestamp. If disabled,
	// i.e. timestamps are not exported, prometheus associates scraped values with
	// scrape timestamp.
	IncludeTimestamp *bool `protobuf:"varint,2,opt,name=include_timestamp,json=includeTimestamp,def=1" json:"include_timestamp,omitempty"`
	// URL that prometheus scrapes metrics from.
	MetricsUrl *string `protobuf:"bytes,3,opt,name=metrics_url,json=metricsUrl,def=/metrics" json:"metrics_url,omitempty"`
	// Prefix to add to all metric names. For example setting this field to
	// "cloudprober_" will result in metrics with names:
	// cloudprober_total, cloudprober_success, cloudprober_latency, ..
	MetricsPrefix *string `protobuf:"bytes,4,opt,name=metrics_prefix,json=metricsPrefix" json:"metrics_prefix,omitempty"`
	// contains filtered or unexported fields
}

func (*SurfacerConf) Descriptor

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

Deprecated: Use SurfacerConf.ProtoReflect.Descriptor instead.

func (*SurfacerConf) GetIncludeTimestamp

func (x *SurfacerConf) GetIncludeTimestamp() bool

func (*SurfacerConf) GetMetricsBufferSize

func (x *SurfacerConf) GetMetricsBufferSize() int64

func (*SurfacerConf) GetMetricsPrefix

func (x *SurfacerConf) GetMetricsPrefix() string

func (*SurfacerConf) GetMetricsUrl

func (x *SurfacerConf) GetMetricsUrl() 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