 Documentation
      ¶
      Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package io_prometheus_client is a generated protocol buffer package.
It is generated from these files:
metrics.proto
It has these top-level messages:
LabelPair Gauge Counter Quantile Summary Untyped Histogram Bucket Metric MetricFamily
Index ¶
- Variables
- type Bucket
- type Counter
- type Gauge
- type Histogram
- type LabelPair
- type Metric
- func (m *Metric) GetCounter() *Counter
- func (m *Metric) GetGauge() *Gauge
- func (m *Metric) GetHistogram() *Histogram
- func (m *Metric) GetLabel() []*LabelPair
- func (m *Metric) GetSummary() *Summary
- func (m *Metric) GetTimestampMs() int64
- func (m *Metric) GetUntyped() *Untyped
- func (*Metric) ProtoMessage()
- func (m *Metric) Reset()
- func (m *Metric) String() string
 
- type MetricFamily
- type MetricType
- type Quantile
- type Summary
- type Untyped
Constants ¶
This section is empty.
Variables ¶
      View Source
      
  
    var MetricType_name = map[int32]string{
	0: "COUNTER",
	1: "GAUGE",
	2: "SUMMARY",
	3: "UNTYPED",
	4: "HISTOGRAM",
}
    
      View Source
      
  
var MetricType_value = map[string]int32{
	"COUNTER":   0,
	"GAUGE":     1,
	"SUMMARY":   2,
	"UNTYPED":   3,
	"HISTOGRAM": 4,
}
    Functions ¶
This section is empty.
Types ¶
type Bucket ¶ added in v0.12.1
type Bucket struct {
	CumulativeCount  *uint64  `protobuf:"varint,1,opt,name=cumulative_count" json:"cumulative_count,omitempty"`
	UpperBound       *float64 `protobuf:"fixed64,2,opt,name=upper_bound" json:"upper_bound,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}
    func (*Bucket) GetCumulativeCount ¶ added in v0.12.1
func (*Bucket) GetUpperBound ¶ added in v0.12.1
func (*Bucket) ProtoMessage ¶ added in v0.12.1
func (*Bucket) ProtoMessage()
type Counter ¶
type Counter struct {
	Value            *float64 `protobuf:"fixed64,1,opt,name=value" json:"value,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}
    func (*Counter) ProtoMessage ¶
func (*Counter) ProtoMessage()
type Gauge ¶
type Gauge struct {
	Value            *float64 `protobuf:"fixed64,1,opt,name=value" json:"value,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}
    func (*Gauge) ProtoMessage ¶
func (*Gauge) ProtoMessage()
type Histogram ¶ added in v0.12.1
type Histogram struct {
	SampleCount      *uint64   `protobuf:"varint,1,opt,name=sample_count" json:"sample_count,omitempty"`
	SampleSum        *float64  `protobuf:"fixed64,2,opt,name=sample_sum" json:"sample_sum,omitempty"`
	Bucket           []*Bucket `protobuf:"bytes,3,rep,name=bucket" json:"bucket,omitempty"`
	XXX_unrecognized []byte    `json:"-"`
}
    func (*Histogram) GetSampleCount ¶ added in v0.12.1
func (*Histogram) GetSampleSum ¶ added in v0.12.1
func (*Histogram) ProtoMessage ¶ added in v0.12.1
func (*Histogram) ProtoMessage()
type LabelPair ¶
type LabelPair struct {
	Name             *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Value            *string `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"`
	XXX_unrecognized []byte  `json:"-"`
}
    func (*LabelPair) ProtoMessage ¶
func (*LabelPair) ProtoMessage()
type Metric ¶
type Metric struct {
	Label            []*LabelPair `protobuf:"bytes,1,rep,name=label" json:"label,omitempty"`
	Gauge            *Gauge       `protobuf:"bytes,2,opt,name=gauge" json:"gauge,omitempty"`
	Counter          *Counter     `protobuf:"bytes,3,opt,name=counter" json:"counter,omitempty"`
	Summary          *Summary     `protobuf:"bytes,4,opt,name=summary" json:"summary,omitempty"`
	Untyped          *Untyped     `protobuf:"bytes,5,opt,name=untyped" json:"untyped,omitempty"`
	Histogram        *Histogram   `protobuf:"bytes,7,opt,name=histogram" json:"histogram,omitempty"`
	TimestampMs      *int64       `protobuf:"varint,6,opt,name=timestamp_ms" json:"timestamp_ms,omitempty"`
	XXX_unrecognized []byte       `json:"-"`
}
    func (*Metric) GetCounter ¶
func (*Metric) GetHistogram ¶ added in v0.12.1
func (*Metric) GetSummary ¶
func (*Metric) GetTimestampMs ¶
func (*Metric) GetUntyped ¶
func (*Metric) ProtoMessage ¶
func (*Metric) ProtoMessage()
type MetricFamily ¶
type MetricFamily struct {
	Name             *string     `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Help             *string     `protobuf:"bytes,2,opt,name=help" json:"help,omitempty"`
	Type             *MetricType `protobuf:"varint,3,opt,name=type,enum=io.prometheus.client.MetricType" json:"type,omitempty"`
	Metric           []*Metric   `protobuf:"bytes,4,rep,name=metric" json:"metric,omitempty"`
	XXX_unrecognized []byte      `json:"-"`
}
    func (*MetricFamily) GetHelp ¶
func (m *MetricFamily) GetHelp() string
func (*MetricFamily) GetMetric ¶
func (m *MetricFamily) GetMetric() []*Metric
func (*MetricFamily) GetName ¶
func (m *MetricFamily) GetName() string
func (*MetricFamily) GetType ¶
func (m *MetricFamily) GetType() MetricType
func (*MetricFamily) ProtoMessage ¶
func (*MetricFamily) ProtoMessage()
func (*MetricFamily) Reset ¶
func (m *MetricFamily) Reset()
func (*MetricFamily) String ¶
func (m *MetricFamily) String() string
type MetricType ¶
type MetricType int32
const ( MetricType_COUNTER MetricType = 0 MetricType_GAUGE MetricType = 1 MetricType_SUMMARY MetricType = 2 MetricType_UNTYPED MetricType = 3 MetricType_HISTOGRAM MetricType = 4 )
func (MetricType) Enum ¶
func (x MetricType) Enum() *MetricType
func (MetricType) String ¶
func (x MetricType) String() string
func (*MetricType) UnmarshalJSON ¶
func (x *MetricType) UnmarshalJSON(data []byte) error
type Quantile ¶
type Quantile struct {
	Quantile         *float64 `protobuf:"fixed64,1,opt,name=quantile" json:"quantile,omitempty"`
	Value            *float64 `protobuf:"fixed64,2,opt,name=value" json:"value,omitempty"`
	XXX_unrecognized []byte   `json:"-"`
}
    func (*Quantile) GetQuantile ¶
func (*Quantile) ProtoMessage ¶
func (*Quantile) ProtoMessage()
type Summary ¶
type Summary struct {
	SampleCount      *uint64     `protobuf:"varint,1,opt,name=sample_count" json:"sample_count,omitempty"`
	SampleSum        *float64    `protobuf:"fixed64,2,opt,name=sample_sum" json:"sample_sum,omitempty"`
	Quantile         []*Quantile `protobuf:"bytes,3,rep,name=quantile" json:"quantile,omitempty"`
	XXX_unrecognized []byte      `json:"-"`
}
    func (*Summary) GetQuantile ¶
func (*Summary) GetSampleCount ¶
func (*Summary) GetSampleSum ¶
func (*Summary) ProtoMessage ¶
func (*Summary) ProtoMessage()
 Click to show internal directories. 
   Click to hide internal directories.