api

Documentation

Index

• Variables
• type Metric
  • func (*Metric) Descriptor() ([]byte, []int)
  • func (x *Metric) GetResourceType() string
  • func (x *Metric) GetSource() string
  • func (x *Metric) GetValues() []float64
  • func (*Metric) ProtoMessage()
  • func (x *Metric) ProtoReflect() protoreflect.Message
  • func (x *Metric) Reset()
  • func (x *Metric) String() string
• type Sample
  • func (*Sample) Descriptor() ([]byte, []int)
  • func (x *Sample) GetLabels() map[string]string
  • func (x *Sample) GetLevel() string
  • func (x *Sample) GetOperation() string
  • func (x *Sample) GetSource() string
  • func (x *Sample) GetValues() []*Metric
  • func (*Sample) ProtoMessage()
  • func (x *Sample) ProtoReflect() protoreflect.Message
  • func (x *Sample) Reset()
  • func (x *Sample) String() string
• type SampleList
  • func (*SampleList) Descriptor() ([]byte, []int)
  • func (x *SampleList) GetClusterName() string
  • func (x *SampleList) GetItems() []*Sample
  • func (x *SampleList) GetMetricName() string
  • func (x *SampleList) GetName() string
  • func (x *SampleList) GetTimestamp() *timestamppb.Timestamp
  • func (x *SampleList) GetType() string
  • func (*SampleList) ProtoMessage()
  • func (x *SampleList) ProtoReflect() protoreflect.Message
  • func (x *SampleList) Reset()
  • func (x *SampleList) String() string
• type ScrapeResult
  • func (*ScrapeResult) Descriptor() ([]byte, []int)
  • func (x *ScrapeResult) GetItems() []*SampleList
  • func (*ScrapeResult) ProtoMessage()
  • func (x *ScrapeResult) ProtoReflect() protoreflect.Message
  • func (x *ScrapeResult) Reset()
  • func (x *ScrapeResult) String() string

Variables

var File_pkg_collector_api_api_proto protoreflect.FileDescriptor

Types

type Metric

type Metric struct {

	// source is the source of the metric data
	// e.g. utilization, requests
	Source string `protobuf:"bytes,1,opt,name=source,proto3" json:"source,omitempty"`
	// resourceType is the type of compute resource the values represent
	// e.g. cpu, memory
	ResourceType string `protobuf:"bytes,2,opt,name=resourceType,proto3" json:"resourceType,omitempty"`
	// values are the sample values
	Values []float64 `protobuf:"fixed64,3,rep,packed,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Metric stores a metric sample for a single object + source type

func (*Metric) Descriptor

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

Deprecated: Use Metric.ProtoReflect.Descriptor instead.

func (*Metric) GetResourceType

func (x *Metric) GetResourceType() string

func (*Metric) GetSource

func (x *Metric) GetSource() string

func (*Metric) GetValues

func (x *Metric) GetValues() []float64

func (*Metric) ProtoMessage

func (*Metric) ProtoMessage()

func (*Metric) ProtoReflect

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

func (*Metric) Reset

func (x *Metric) Reset()

func (*Metric) String

func (x *Metric) String() string

type Sample

type Sample struct {

	// labels are the labels specific to object this sample is for
	// e.g. the exported_container
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// values are the metric values for different source types
	Values    []*Metric `protobuf:"bytes,3,rep,name=values,proto3" json:"values,omitempty"`
	Level     string    `protobuf:"bytes,4,opt,name=level,proto3" json:"level,omitempty"`
	Operation string    `protobuf:"bytes,5,opt,name=operation,proto3" json:"operation,omitempty"`
	Source    string    `protobuf:"bytes,6,opt,name=source,proto3" json:"source,omitempty"`
	// contains filtered or unexported fields
}

Sample stores a set of capacity metric samples for a single object

func (*Sample) Descriptor

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

Deprecated: Use Sample.ProtoReflect.Descriptor instead.

func (*Sample) GetLabels

func (x *Sample) GetLabels() map[string]string

func (*Sample) GetLevel

func (x *Sample) GetLevel() string

func (*Sample) GetOperation

func (x *Sample) GetOperation() string

func (*Sample) GetSource

func (x *Sample) GetSource() string

func (*Sample) GetValues

func (x *Sample) GetValues() []*Metric

func (*Sample) ProtoMessage

func (*Sample) ProtoMessage()

func (*Sample) ProtoReflect

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

func (*Sample) Reset

func (x *Sample) Reset()

func (*Sample) String

func (x *Sample) String() string

type SampleList

type SampleList struct {

	// type is the type of object the samples are for
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// timestamp is the time the samples were taken
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// items are the samples for each object
	Items []*Sample `protobuf:"bytes,3,rep,name=items,proto3" json:"items,omitempty"`
	// name is set by aggregated metrics in the level retentionName field
	Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"`
	// metricName is set if this is from an aggregated metric exported to prometheus
	MetricName string `protobuf:"bytes,5,opt,name=metricName,proto3" json:"metricName,omitempty"`
	// clusterName is the name of the cluster
	ClusterName string `protobuf:"bytes,6,opt,name=clusterName,proto3" json:"clusterName,omitempty"`
	// contains filtered or unexported fields
}

SampleList stores a collection of capacity metric samples

func (*SampleList) Descriptor

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

Deprecated: Use SampleList.ProtoReflect.Descriptor instead.

func (*SampleList) GetClusterName

func (x *SampleList) GetClusterName() string

func (*SampleList) GetItems

func (x *SampleList) GetItems() []*Sample

func (*SampleList) GetMetricName

func (x *SampleList) GetMetricName() string

func (*SampleList) GetName

func (x *SampleList) GetName() string

func (*SampleList) GetTimestamp

func (x *SampleList) GetTimestamp() *timestamppb.Timestamp

func (*SampleList) GetType

func (x *SampleList) GetType() string

func (*SampleList) ProtoMessage

func (*SampleList) ProtoMessage()

func (*SampleList) ProtoReflect

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

func (*SampleList) Reset

func (x *SampleList) Reset()

func (*SampleList) String

func (x *SampleList) String() string

type ScrapeResult

type ScrapeResult struct {
	Items []*SampleList `protobuf:"bytes,1,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

func (*ScrapeResult) Descriptor

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

Deprecated: Use ScrapeResult.ProtoReflect.Descriptor instead.

func (*ScrapeResult) GetItems

func (x *ScrapeResult) GetItems() []*SampleList

func (*ScrapeResult) ProtoMessage

func (*ScrapeResult) ProtoMessage()

func (*ScrapeResult) ProtoReflect

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

func (*ScrapeResult) Reset

func (x *ScrapeResult) Reset()

func (*ScrapeResult) String

func (x *ScrapeResult) String() string