prometheusv1

package
v0.0.0-...-54fc8aa Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2025 License: Apache-2.0 Imports: 4 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ReadRequest_ResponseType_name = map[int32]string{
		0: "RESPONSE_TYPE_SAMPLES_UNSPECIFIED",
		1: "RESPONSE_TYPE_STREAMED_XOR_CHUNKS",
	}
	ReadRequest_ResponseType_value = map[string]int32{
		"RESPONSE_TYPE_SAMPLES_UNSPECIFIED": 0,
		"RESPONSE_TYPE_STREAMED_XOR_CHUNKS": 1,
	}
)

Enum value maps for ReadRequest_ResponseType.

View Source 
var (
	MetricMetadata_MetricType_name = map[int32]string{
		0: "METRIC_TYPE_UNKNOWN_UNSPECIFIED",
		1: "METRIC_TYPE_COUNTER",
		2: "METRIC_TYPE_GAUGE",
		3: "METRIC_TYPE_HISTOGRAM",
		4: "METRIC_TYPE_GAUGEHISTOGRAM",
		5: "METRIC_TYPE_SUMMARY",
		6: "METRIC_TYPE_INFO",
		7: "METRIC_TYPE_STATESET",
	}
	MetricMetadata_MetricType_value = map[string]int32{
		"METRIC_TYPE_UNKNOWN_UNSPECIFIED": 0,
		"METRIC_TYPE_COUNTER":             1,
		"METRIC_TYPE_GAUGE":               2,
		"METRIC_TYPE_HISTOGRAM":           3,
		"METRIC_TYPE_GAUGEHISTOGRAM":      4,
		"METRIC_TYPE_SUMMARY":             5,
		"METRIC_TYPE_INFO":                6,
		"METRIC_TYPE_STATESET":            7,
	}
)

Enum value maps for MetricMetadata_MetricType.

View Source 
var (
	Histogram_ResetHint_name = map[int32]string{
		0: "RESET_HINT_UNKNOWN_UNSPECIFIED",
		1: "RESET_HINT_YES",
		2: "RESET_HINT_NO",
		3: "RESET_HINT_GAUGE",
	}
	Histogram_ResetHint_value = map[string]int32{
		"RESET_HINT_UNKNOWN_UNSPECIFIED": 0,
		"RESET_HINT_YES":                 1,
		"RESET_HINT_NO":                  2,
		"RESET_HINT_GAUGE":               3,
	}
)

Enum value maps for Histogram_ResetHint.

View Source 
var (
	LabelMatcher_Type_name = map[int32]string{
		0: "TYPE_EQ_UNSPECIFIED",
		1: "TYPE_NEQ",
		2: "TYPE_RE",
		3: "TYPE_NRE",
	}
	LabelMatcher_Type_value = map[string]int32{
		"TYPE_EQ_UNSPECIFIED": 0,
		"TYPE_NEQ":            1,
		"TYPE_RE":             2,
		"TYPE_NRE":            3,
	}
)

Enum value maps for LabelMatcher_Type.

View Source 
var (
	Chunk_Encoding_name = map[int32]string{
		0: "ENCODING_UNKNOWN_UNSPECIFIED",
		1: "ENCODING_XOR",
		2: "ENCODING_HISTOGRAM",
		3: "ENCODING_FLOAT_HISTOGRAM",
	}
	Chunk_Encoding_value = map[string]int32{
		"ENCODING_UNKNOWN_UNSPECIFIED": 0,
		"ENCODING_XOR":                 1,
		"ENCODING_HISTOGRAM":           2,
		"ENCODING_FLOAT_HISTOGRAM":     3,
	}
)

Enum value maps for Chunk_Encoding.

View Source 
var File_prometheus_v1_remote_proto protoreflect.FileDescriptor
View Source 
var File_prometheus_v1_types_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type BucketSpan 

type BucketSpan struct {
	Offset int32  `protobuf:"zigzag32,1,opt,name=offset,proto3" json:"offset,omitempty"` // Gap to previous span, or starting point for 1st span (which can be negative).
	Length uint32 `protobuf:"varint,2,opt,name=length,proto3" json:"length,omitempty"`   // Length of consecutive buckets.
	// contains filtered or unexported fields
}

A BucketSpan defines a number of consecutive buckets with their offset. Logically, it would be more straightforward to include the bucket counts in the Span. However, the protobuf representation is more compact in the way the data is structured here (with all the buckets in a single array separate from the Spans).

func (*BucketSpan) Descriptor deprecated 

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

Deprecated: Use BucketSpan.ProtoReflect.Descriptor instead.

func (*BucketSpan) GetLength 

func (x *BucketSpan) GetLength() uint32

func (*BucketSpan) GetOffset 

func (x *BucketSpan) GetOffset() int32

func (*BucketSpan) ProtoMessage 

func (*BucketSpan) ProtoMessage()

func (*BucketSpan) ProtoReflect 

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

func (*BucketSpan) Reset 

func (x *BucketSpan) Reset()

func (*BucketSpan) String 

func (x *BucketSpan) String() string

type Chunk 

type Chunk struct {
	MinTimeMs int64          `protobuf:"varint,1,opt,name=min_time_ms,json=minTimeMs,proto3" json:"min_time_ms,omitempty"`
	MaxTimeMs int64          `protobuf:"varint,2,opt,name=max_time_ms,json=maxTimeMs,proto3" json:"max_time_ms,omitempty"`
	Type      Chunk_Encoding `protobuf:"varint,3,opt,name=type,proto3,enum=prometheus.v1.Chunk_Encoding" json:"type,omitempty"`
	Data      []byte         `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

Chunk represents a TSDB chunk. Time range [min, max] is inclusive.

func (*Chunk) Descriptor deprecated 

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

Deprecated: Use Chunk.ProtoReflect.Descriptor instead.

func (*Chunk) GetData 

func (x *Chunk) GetData() []byte

func (*Chunk) GetMaxTimeMs 

func (x *Chunk) GetMaxTimeMs() int64

func (*Chunk) GetMinTimeMs 

func (x *Chunk) GetMinTimeMs() int64

func (*Chunk) GetType 

func (x *Chunk) GetType() Chunk_Encoding

func (*Chunk) ProtoMessage 

func (*Chunk) ProtoMessage()

func (*Chunk) ProtoReflect 

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

func (*Chunk) Reset 

func (x *Chunk) Reset()

func (*Chunk) String 

func (x *Chunk) String() string

type Chunk_Encoding 

type Chunk_Encoding int32

We require this to match chunkenc.Encoding. 

const (
	Chunk_ENCODING_UNKNOWN_UNSPECIFIED Chunk_Encoding = 0
	Chunk_ENCODING_XOR                 Chunk_Encoding = 1
	Chunk_ENCODING_HISTOGRAM           Chunk_Encoding = 2
	Chunk_ENCODING_FLOAT_HISTOGRAM     Chunk_Encoding = 3
)

func (Chunk_Encoding) Descriptor 

func (Chunk_Encoding) Descriptor() protoreflect.EnumDescriptor

func (Chunk_Encoding) Enum 

func (x Chunk_Encoding) Enum() *Chunk_Encoding

func (Chunk_Encoding) EnumDescriptor deprecated 

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

Deprecated: Use Chunk_Encoding.Descriptor instead.

func (Chunk_Encoding) Number 

func (x Chunk_Encoding) Number() protoreflect.EnumNumber

func (Chunk_Encoding) String 

func (x Chunk_Encoding) String() string

func (Chunk_Encoding) Type 

func (Chunk_Encoding) Type() protoreflect.EnumType

type ChunkedReadResponse 

type ChunkedReadResponse struct {
	ChunkedSeries []*ChunkedSeries `protobuf:"bytes,1,rep,name=chunked_series,json=chunkedSeries,proto3" json:"chunked_series,omitempty"`
	// query_index represents an index of the query from ReadRequest.queries these chunks relates to.
	QueryIndex int64 `protobuf:"varint,2,opt,name=query_index,json=queryIndex,proto3" json:"query_index,omitempty"`
	// contains filtered or unexported fields
}

ChunkedReadResponse is a response when response_type equals STREAMED_XOR_CHUNKS. We strictly stream full series after series, optionally split by time. This means that a single frame can contain partition of the single series, but once a new series is started to be streamed it means that no more chunks will be sent for previous one. Series are returned sorted in the same way TSDB block are internally.

func (*ChunkedReadResponse) Descriptor deprecated 

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

Deprecated: Use ChunkedReadResponse.ProtoReflect.Descriptor instead.

func (*ChunkedReadResponse) GetChunkedSeries 

func (x *ChunkedReadResponse) GetChunkedSeries() []*ChunkedSeries

func (*ChunkedReadResponse) GetQueryIndex 

func (x *ChunkedReadResponse) GetQueryIndex() int64

func (*ChunkedReadResponse) ProtoMessage 

func (*ChunkedReadResponse) ProtoMessage()

func (*ChunkedReadResponse) ProtoReflect 

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

func (*ChunkedReadResponse) Reset 

func (x *ChunkedReadResponse) Reset()

func (*ChunkedReadResponse) String 

func (x *ChunkedReadResponse) String() string

type ChunkedSeries 

type ChunkedSeries struct {

	// Labels should be sorted.
	Labels []*Label `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// Chunks will be in start time order and may overlap.
	Chunks []*Chunk `protobuf:"bytes,2,rep,name=chunks,proto3" json:"chunks,omitempty"`
	// contains filtered or unexported fields
}

ChunkedSeries represents single, encoded time series.

func (*ChunkedSeries) Descriptor deprecated 

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

Deprecated: Use ChunkedSeries.ProtoReflect.Descriptor instead.

func (*ChunkedSeries) GetChunks 

func (x *ChunkedSeries) GetChunks() []*Chunk

func (*ChunkedSeries) GetLabels 

func (x *ChunkedSeries) GetLabels() []*Label

func (*ChunkedSeries) ProtoMessage 

func (*ChunkedSeries) ProtoMessage()

func (*ChunkedSeries) ProtoReflect 

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

func (*ChunkedSeries) Reset 

func (x *ChunkedSeries) Reset()

func (*ChunkedSeries) String 

func (x *ChunkedSeries) String() string

type Exemplar 

type Exemplar struct {

	// Optional, can be empty.
	Labels []*Label `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	Value  float64  `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	// timestamp is in ms format, see model/timestamp/timestamp.go for
	// conversion from time.Time to Prometheus timestamp.
	Timestamp int64 `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

func (*Exemplar) Descriptor deprecated 

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

Deprecated: Use Exemplar.ProtoReflect.Descriptor instead.

func (*Exemplar) GetLabels 

func (x *Exemplar) GetLabels() []*Label

func (*Exemplar) GetTimestamp 

func (x *Exemplar) GetTimestamp() int64

func (*Exemplar) GetValue 

func (x *Exemplar) GetValue() float64

func (*Exemplar) ProtoMessage 

func (*Exemplar) ProtoMessage()

func (*Exemplar) ProtoReflect 

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

func (*Exemplar) Reset 

func (x *Exemplar) Reset()

func (*Exemplar) String 

func (x *Exemplar) String() string

type Histogram 

type Histogram struct {

	// Types that are assignable to Count:
	//
	//	*Histogram_CountInt
	//	*Histogram_CountFloat
	Count isHistogram_Count `protobuf_oneof:"count"`
	Sum   float64           `protobuf:"fixed64,3,opt,name=sum,proto3" json:"sum,omitempty"` // Sum of observations in the histogram.
	// The schema defines the bucket schema. Currently, valid numbers
	// are -4 <= n <= 8. They are all for base-2 bucket schemas, where 1
	// is a bucket boundary in each case, and then each power of two is
	// divided into 2^n logarithmic buckets. Or in other words, each
	// bucket boundary is the previous boundary times 2^(2^-n). In the
	// future, more bucket schemas may be added using numbers < -4 or >
	// 8.
	Schema        int32   `protobuf:"zigzag32,4,opt,name=schema,proto3" json:"schema,omitempty"`
	ZeroThreshold float64 `protobuf:"fixed64,5,opt,name=zero_threshold,json=zeroThreshold,proto3" json:"zero_threshold,omitempty"` // Breadth of the zero bucket.
	// Types that are assignable to ZeroCount:
	//
	//	*Histogram_ZeroCountInt
	//	*Histogram_ZeroCountFloat
	ZeroCount isHistogram_ZeroCount `protobuf_oneof:"zero_count"`
	// Negative Buckets.
	NegativeSpans []*BucketSpan `protobuf:"bytes,8,rep,name=negative_spans,json=negativeSpans,proto3" json:"negative_spans,omitempty"`
	// Use either "negative_deltas" or "negative_counts", the former for
	// regular histograms with integer counts, the latter for float
	// histograms.
	NegativeDeltas []int64   `protobuf:"zigzag64,9,rep,packed,name=negative_deltas,json=negativeDeltas,proto3" json:"negative_deltas,omitempty"` // Count delta of each bucket compared to previous one (or to zero for 1st bucket).
	NegativeCounts []float64 `protobuf:"fixed64,10,rep,packed,name=negative_counts,json=negativeCounts,proto3" json:"negative_counts,omitempty"` // Absolute count of each bucket.
	// Positive Buckets.
	PositiveSpans []*BucketSpan `protobuf:"bytes,11,rep,name=positive_spans,json=positiveSpans,proto3" json:"positive_spans,omitempty"`
	// Use either "positive_deltas" or "positive_counts", the former for
	// regular histograms with integer counts, the latter for float
	// histograms.
	PositiveDeltas []int64             `protobuf:"zigzag64,12,rep,packed,name=positive_deltas,json=positiveDeltas,proto3" json:"positive_deltas,omitempty"` // Count delta of each bucket compared to previous one (or to zero for 1st bucket).
	PositiveCounts []float64           `protobuf:"fixed64,13,rep,packed,name=positive_counts,json=positiveCounts,proto3" json:"positive_counts,omitempty"`  // Absolute count of each bucket.
	ResetHint      Histogram_ResetHint ``                                                                                                                   /* 129-byte string literal not displayed */
	// timestamp is in ms format, see model/timestamp/timestamp.go for
	// conversion from time.Time to Prometheus timestamp.
	Timestamp int64 `protobuf:"varint,15,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

A native histogram, also known as a sparse histogram. Original design doc: https://docs.google.com/document/d/1cLNv3aufPZb3fNfaJgdaRBZsInZKKIHo9E6HinJVbpM/edit The appendix of this design doc also explains the concept of float histograms. This Histogram message can represent both, the usual integer histogram as well as a float histogram.

func (*Histogram) Descriptor deprecated 

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

Deprecated: Use Histogram.ProtoReflect.Descriptor instead.

func (*Histogram) GetCount 

func (m *Histogram) GetCount() isHistogram_Count

func (*Histogram) GetCountFloat 

func (x *Histogram) GetCountFloat() float64

func (*Histogram) GetCountInt 

func (x *Histogram) GetCountInt() uint64

func (*Histogram) GetNegativeCounts 

func (x *Histogram) GetNegativeCounts() []float64

func (*Histogram) GetNegativeDeltas 

func (x *Histogram) GetNegativeDeltas() []int64

func (*Histogram) GetNegativeSpans 

func (x *Histogram) GetNegativeSpans() []*BucketSpan

func (*Histogram) GetPositiveCounts 

func (x *Histogram) GetPositiveCounts() []float64

func (*Histogram) GetPositiveDeltas 

func (x *Histogram) GetPositiveDeltas() []int64

func (*Histogram) GetPositiveSpans 

func (x *Histogram) GetPositiveSpans() []*BucketSpan

func (*Histogram) GetResetHint 

func (x *Histogram) GetResetHint() Histogram_ResetHint

func (*Histogram) GetSchema 

func (x *Histogram) GetSchema() int32

func (*Histogram) GetSum 

func (x *Histogram) GetSum() float64

func (*Histogram) GetTimestamp 

func (x *Histogram) GetTimestamp() int64

func (*Histogram) GetZeroCount 

func (m *Histogram) GetZeroCount() isHistogram_ZeroCount

func (*Histogram) GetZeroCountFloat 

func (x *Histogram) GetZeroCountFloat() float64

func (*Histogram) GetZeroCountInt 

func (x *Histogram) GetZeroCountInt() uint64

func (*Histogram) GetZeroThreshold 

func (x *Histogram) GetZeroThreshold() float64

func (*Histogram) ProtoMessage 

func (*Histogram) ProtoMessage()

func (*Histogram) ProtoReflect 

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

func (*Histogram) Reset 

func (x *Histogram) Reset()

func (*Histogram) String 

func (x *Histogram) String() string

type Histogram_CountFloat 

type Histogram_CountFloat struct {
	CountFloat float64 `protobuf:"fixed64,2,opt,name=count_float,json=countFloat,proto3,oneof"`
}

type Histogram_CountInt 

type Histogram_CountInt struct {
	CountInt uint64 `protobuf:"varint,1,opt,name=count_int,json=countInt,proto3,oneof"`
}

type Histogram_ResetHint 

type Histogram_ResetHint int32
const (
	Histogram_RESET_HINT_UNKNOWN_UNSPECIFIED Histogram_ResetHint = 0 // Need to test for a counter reset explicitly.
	Histogram_RESET_HINT_YES                 Histogram_ResetHint = 1 // This is the 1st histogram after a counter reset.
	Histogram_RESET_HINT_NO                  Histogram_ResetHint = 2 // There was no counter reset between this and the previous Histogram.
	Histogram_RESET_HINT_GAUGE               Histogram_ResetHint = 3 // This is a gauge histogram where counter resets don't happen.
)

func (Histogram_ResetHint) Descriptor 

func (Histogram_ResetHint) Descriptor() protoreflect.EnumDescriptor

func (Histogram_ResetHint) Enum 

func (x Histogram_ResetHint) Enum() *Histogram_ResetHint

func (Histogram_ResetHint) EnumDescriptor deprecated 

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

Deprecated: Use Histogram_ResetHint.Descriptor instead.

func (Histogram_ResetHint) Number 

func (x Histogram_ResetHint) Number() protoreflect.EnumNumber

func (Histogram_ResetHint) String 

func (x Histogram_ResetHint) String() string

func (Histogram_ResetHint) Type 

func (Histogram_ResetHint) Type() protoreflect.EnumType

type Histogram_ZeroCountFloat 

type Histogram_ZeroCountFloat struct {
	ZeroCountFloat float64 `protobuf:"fixed64,7,opt,name=zero_count_float,json=zeroCountFloat,proto3,oneof"`
}

type Histogram_ZeroCountInt 

type Histogram_ZeroCountInt struct {
	ZeroCountInt uint64 `protobuf:"varint,6,opt,name=zero_count_int,json=zeroCountInt,proto3,oneof"`
}

type Label 

type Label struct {
	Name  string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*Label) Descriptor deprecated 

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

Deprecated: Use Label.ProtoReflect.Descriptor instead.

func (*Label) GetName 

func (x *Label) GetName() string

func (*Label) GetValue 

func (x *Label) GetValue() string

func (*Label) ProtoMessage 

func (*Label) ProtoMessage()

func (*Label) ProtoReflect 

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

func (*Label) Reset 

func (x *Label) Reset()

func (*Label) String 

func (x *Label) String() string

type LabelMatcher 

type LabelMatcher struct {
	Type  LabelMatcher_Type `protobuf:"varint,1,opt,name=type,proto3,enum=prometheus.v1.LabelMatcher_Type" json:"type,omitempty"`
	Name  string            `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Value string            `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Matcher specifies a rule, which can match or set of labels or not.

func (*LabelMatcher) Descriptor deprecated 

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

Deprecated: Use LabelMatcher.ProtoReflect.Descriptor instead.

func (*LabelMatcher) GetName 

func (x *LabelMatcher) GetName() string

func (*LabelMatcher) GetType 

func (x *LabelMatcher) GetType() LabelMatcher_Type

func (*LabelMatcher) GetValue 

func (x *LabelMatcher) GetValue() string

func (*LabelMatcher) ProtoMessage 

func (*LabelMatcher) ProtoMessage()

func (*LabelMatcher) ProtoReflect 

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

func (*LabelMatcher) Reset 

func (x *LabelMatcher) Reset()

func (*LabelMatcher) String 

func (x *LabelMatcher) String() string

type LabelMatcher_Type 

type LabelMatcher_Type int32
const (
	LabelMatcher_TYPE_EQ_UNSPECIFIED LabelMatcher_Type = 0
	LabelMatcher_TYPE_NEQ            LabelMatcher_Type = 1
	LabelMatcher_TYPE_RE             LabelMatcher_Type = 2
	LabelMatcher_TYPE_NRE            LabelMatcher_Type = 3
)

func (LabelMatcher_Type) Descriptor 

func (LabelMatcher_Type) Descriptor() protoreflect.EnumDescriptor

func (LabelMatcher_Type) Enum 

func (x LabelMatcher_Type) Enum() *LabelMatcher_Type

func (LabelMatcher_Type) EnumDescriptor deprecated 

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

Deprecated: Use LabelMatcher_Type.Descriptor instead.

func (LabelMatcher_Type) Number 

func (x LabelMatcher_Type) Number() protoreflect.EnumNumber

func (LabelMatcher_Type) String 

func (x LabelMatcher_Type) String() string

func (LabelMatcher_Type) Type 

func (LabelMatcher_Type) Type() protoreflect.EnumType

type Labels 

type Labels struct {
	Labels []*Label `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// contains filtered or unexported fields
}

func (*Labels) Descriptor deprecated 

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

Deprecated: Use Labels.ProtoReflect.Descriptor instead.

func (*Labels) GetLabels 

func (x *Labels) GetLabels() []*Label

func (*Labels) ProtoMessage 

func (*Labels) ProtoMessage()

func (*Labels) ProtoReflect 

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

func (*Labels) Reset 

func (x *Labels) Reset()

func (*Labels) String 

func (x *Labels) String() string

type MetricMetadata 

type MetricMetadata struct {

	// Represents the metric type, these match the set from Prometheus.
	// Refer to model/textparse/interface.go for details.
	Type             MetricMetadata_MetricType `protobuf:"varint,1,opt,name=type,proto3,enum=prometheus.v1.MetricMetadata_MetricType" json:"type,omitempty"`
	MetricFamilyName string                    `protobuf:"bytes,2,opt,name=metric_family_name,json=metricFamilyName,proto3" json:"metric_family_name,omitempty"`
	Help             string                    `protobuf:"bytes,4,opt,name=help,proto3" json:"help,omitempty"`
	Unit             string                    `protobuf:"bytes,5,opt,name=unit,proto3" json:"unit,omitempty"`
	// contains filtered or unexported fields
}

func (*MetricMetadata) Descriptor deprecated 

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

Deprecated: Use MetricMetadata.ProtoReflect.Descriptor instead.

func (*MetricMetadata) GetHelp 

func (x *MetricMetadata) GetHelp() string

func (*MetricMetadata) GetMetricFamilyName 

func (x *MetricMetadata) GetMetricFamilyName() string

func (*MetricMetadata) GetType 

func (x *MetricMetadata) GetType() MetricMetadata_MetricType

func (*MetricMetadata) GetUnit 

func (x *MetricMetadata) GetUnit() string

func (*MetricMetadata) ProtoMessage 

func (*MetricMetadata) ProtoMessage()

func (*MetricMetadata) ProtoReflect 

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

func (*MetricMetadata) Reset 

func (x *MetricMetadata) Reset()

func (*MetricMetadata) String 

func (x *MetricMetadata) String() string

type MetricMetadata_MetricType 

type MetricMetadata_MetricType int32
const (
	MetricMetadata_METRIC_TYPE_UNKNOWN_UNSPECIFIED MetricMetadata_MetricType = 0
	MetricMetadata_METRIC_TYPE_COUNTER             MetricMetadata_MetricType = 1
	MetricMetadata_METRIC_TYPE_GAUGE               MetricMetadata_MetricType = 2
	MetricMetadata_METRIC_TYPE_HISTOGRAM           MetricMetadata_MetricType = 3
	MetricMetadata_METRIC_TYPE_GAUGEHISTOGRAM      MetricMetadata_MetricType = 4
	MetricMetadata_METRIC_TYPE_SUMMARY             MetricMetadata_MetricType = 5
	MetricMetadata_METRIC_TYPE_INFO                MetricMetadata_MetricType = 6
	MetricMetadata_METRIC_TYPE_STATESET            MetricMetadata_MetricType = 7
)

func (MetricMetadata_MetricType) Descriptor 

func (MetricMetadata_MetricType) Descriptor() protoreflect.EnumDescriptor

func (MetricMetadata_MetricType) Enum 

func (x MetricMetadata_MetricType) Enum() *MetricMetadata_MetricType

func (MetricMetadata_MetricType) EnumDescriptor deprecated 

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

Deprecated: Use MetricMetadata_MetricType.Descriptor instead.

func (MetricMetadata_MetricType) Number 

func (x MetricMetadata_MetricType) Number() protoreflect.EnumNumber

func (MetricMetadata_MetricType) String 

func (x MetricMetadata_MetricType) String() string

func (MetricMetadata_MetricType) Type 

func (MetricMetadata_MetricType) Type() protoreflect.EnumType

type Query 

type Query struct {
	StartTimestampMs int64           `protobuf:"varint,1,opt,name=start_timestamp_ms,json=startTimestampMs,proto3" json:"start_timestamp_ms,omitempty"`
	EndTimestampMs   int64           `protobuf:"varint,2,opt,name=end_timestamp_ms,json=endTimestampMs,proto3" json:"end_timestamp_ms,omitempty"`
	Matchers         []*LabelMatcher `protobuf:"bytes,3,rep,name=matchers,proto3" json:"matchers,omitempty"`
	Hints            *ReadHints      `protobuf:"bytes,4,opt,name=hints,proto3" json:"hints,omitempty"`
	// contains filtered or unexported fields
}

func (*Query) Descriptor deprecated 

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

Deprecated: Use Query.ProtoReflect.Descriptor instead.

func (*Query) GetEndTimestampMs 

func (x *Query) GetEndTimestampMs() int64

func (*Query) GetHints 

func (x *Query) GetHints() *ReadHints

func (*Query) GetMatchers 

func (x *Query) GetMatchers() []*LabelMatcher

func (*Query) GetStartTimestampMs 

func (x *Query) GetStartTimestampMs() int64

func (*Query) ProtoMessage 

func (*Query) ProtoMessage()

func (*Query) ProtoReflect 

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

func (*Query) Reset 

func (x *Query) Reset()

func (*Query) String 

func (x *Query) String() string

type QueryResult 

type QueryResult struct {

	// Samples within a time series must be ordered by time.
	Timeseries []*TimeSeries `protobuf:"bytes,1,rep,name=timeseries,proto3" json:"timeseries,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryResult) Descriptor deprecated 

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

Deprecated: Use QueryResult.ProtoReflect.Descriptor instead.

func (*QueryResult) GetTimeseries 

func (x *QueryResult) GetTimeseries() []*TimeSeries

func (*QueryResult) ProtoMessage 

func (*QueryResult) ProtoMessage()

func (*QueryResult) ProtoReflect 

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

func (*QueryResult) Reset 

func (x *QueryResult) Reset()

func (*QueryResult) String 

func (x *QueryResult) String() string

type ReadHints 

type ReadHints struct {
	StepMs   int64    `protobuf:"varint,1,opt,name=step_ms,json=stepMs,proto3" json:"step_ms,omitempty"`    // Query step size in milliseconds.
	Func     string   `protobuf:"bytes,2,opt,name=func,proto3" json:"func,omitempty"`                       // String representation of surrounding function or aggregation.
	StartMs  int64    `protobuf:"varint,3,opt,name=start_ms,json=startMs,proto3" json:"start_ms,omitempty"` // Start time in milliseconds.
	EndMs    int64    `protobuf:"varint,4,opt,name=end_ms,json=endMs,proto3" json:"end_ms,omitempty"`       // End time in milliseconds.
	Grouping []string `protobuf:"bytes,5,rep,name=grouping,proto3" json:"grouping,omitempty"`               // List of label names used in aggregation.
	By       bool     `protobuf:"varint,6,opt,name=by,proto3" json:"by,omitempty"`                          // Indicate whether it is without or by.
	RangeMs  int64    `protobuf:"varint,7,opt,name=range_ms,json=rangeMs,proto3" json:"range_ms,omitempty"` // Range vector selector range in milliseconds.
	// contains filtered or unexported fields
}

func (*ReadHints) Descriptor deprecated 

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

Deprecated: Use ReadHints.ProtoReflect.Descriptor instead.

func (*ReadHints) GetBy 

func (x *ReadHints) GetBy() bool

func (*ReadHints) GetEndMs 

func (x *ReadHints) GetEndMs() int64

func (*ReadHints) GetFunc 

func (x *ReadHints) GetFunc() string

func (*ReadHints) GetGrouping 

func (x *ReadHints) GetGrouping() []string

func (*ReadHints) GetRangeMs 

func (x *ReadHints) GetRangeMs() int64

func (*ReadHints) GetStartMs 

func (x *ReadHints) GetStartMs() int64

func (*ReadHints) GetStepMs 

func (x *ReadHints) GetStepMs() int64

func (*ReadHints) ProtoMessage 

func (*ReadHints) ProtoMessage()

func (*ReadHints) ProtoReflect 

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

func (*ReadHints) Reset 

func (x *ReadHints) Reset()

func (*ReadHints) String 

func (x *ReadHints) String() string

type ReadRequest 

type ReadRequest struct {
	Queries []*Query `protobuf:"bytes,1,rep,name=queries,proto3" json:"queries,omitempty"`
	// accepted_response_types allows negotiating the content type of the response.
	//
	// Response types are taken from the list in the FIFO order. If no response type in `accepted_response_types` is
	// implemented by server, error is returned.
	// For request that do not contain `accepted_response_types` field the SAMPLES response type will be used.
	AcceptedResponseTypes []ReadRequest_ResponseType `` /* 178-byte string literal not displayed */
	// contains filtered or unexported fields
}

ReadRequest represents a remote read request.

func (*ReadRequest) Descriptor deprecated 

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

Deprecated: Use ReadRequest.ProtoReflect.Descriptor instead.

func (*ReadRequest) GetAcceptedResponseTypes 

func (x *ReadRequest) GetAcceptedResponseTypes() []ReadRequest_ResponseType

func (*ReadRequest) GetQueries 

func (x *ReadRequest) GetQueries() []*Query

func (*ReadRequest) ProtoMessage 

func (*ReadRequest) ProtoMessage()

func (*ReadRequest) ProtoReflect 

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

func (*ReadRequest) Reset 

func (x *ReadRequest) Reset()

func (*ReadRequest) String 

func (x *ReadRequest) String() string

type ReadRequest_ResponseType 

type ReadRequest_ResponseType int32
const (
	// Server will return a single ReadResponse message with matched series that includes list of raw samples.
	// It's recommended to use streamed response types instead.
	//
	// Response headers:
	// Content-Type: "application/x-protobuf"
	// Content-Encoding: "snappy"
	ReadRequest_RESPONSE_TYPE_SAMPLES_UNSPECIFIED ReadRequest_ResponseType = 0
	// Server will stream a delimited ChunkedReadResponse message that
	// contains XOR or HISTOGRAM(!) encoded chunks for a single series.
	// Each message is following varint size and fixed size bigendian
	// uint32 for CRC32 Castagnoli checksum.
	//
	// Response headers:
	// Content-Type: "application/x-streamed-protobuf; proto=prometheus.ChunkedReadResponse"
	// Content-Encoding: ""
	ReadRequest_RESPONSE_TYPE_STREAMED_XOR_CHUNKS ReadRequest_ResponseType = 1
)

func (ReadRequest_ResponseType) Descriptor 

func (ReadRequest_ResponseType) Descriptor() protoreflect.EnumDescriptor

func (ReadRequest_ResponseType) Enum 

func (x ReadRequest_ResponseType) Enum() *ReadRequest_ResponseType

func (ReadRequest_ResponseType) EnumDescriptor deprecated 

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

Deprecated: Use ReadRequest_ResponseType.Descriptor instead.

func (ReadRequest_ResponseType) Number 

func (x ReadRequest_ResponseType) Number() protoreflect.EnumNumber

func (ReadRequest_ResponseType) String 

func (x ReadRequest_ResponseType) String() string

func (ReadRequest_ResponseType) Type 

func (ReadRequest_ResponseType) Type() protoreflect.EnumType

type ReadResponse 

type ReadResponse struct {

	// In same order as the request's queries.
	Results []*QueryResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

ReadResponse is a response when response_type equals SAMPLES.

func (*ReadResponse) Descriptor deprecated 

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

Deprecated: Use ReadResponse.ProtoReflect.Descriptor instead.

func (*ReadResponse) GetResults 

func (x *ReadResponse) GetResults() []*QueryResult

func (*ReadResponse) ProtoMessage 

func (*ReadResponse) ProtoMessage()

func (*ReadResponse) ProtoReflect 

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

func (*ReadResponse) Reset 

func (x *ReadResponse) Reset()

func (*ReadResponse) String 

func (x *ReadResponse) String() string

type Sample 

type Sample struct {
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	// timestamp is in ms format, see model/timestamp/timestamp.go for
	// conversion from time.Time to Prometheus timestamp.
	Timestamp int64 `protobuf:"varint,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// contains filtered or unexported fields
}

func (*Sample) Descriptor deprecated 

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

Deprecated: Use Sample.ProtoReflect.Descriptor instead.

func (*Sample) GetTimestamp 

func (x *Sample) GetTimestamp() int64

func (*Sample) GetValue 

func (x *Sample) GetValue() float64

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 TimeSeries 

type TimeSeries struct {

	// For a timeseries to be valid, and for the samples and exemplars
	// to be ingested by the remote system properly, the labels field is required.
	Labels     []*Label     `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	Samples    []*Sample    `protobuf:"bytes,2,rep,name=samples,proto3" json:"samples,omitempty"`
	Exemplars  []*Exemplar  `protobuf:"bytes,3,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	Histograms []*Histogram `protobuf:"bytes,4,rep,name=histograms,proto3" json:"histograms,omitempty"`
	// contains filtered or unexported fields
}

TimeSeries represents samples and labels for a single time series.

func (*TimeSeries) Descriptor deprecated 

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

Deprecated: Use TimeSeries.ProtoReflect.Descriptor instead.

func (*TimeSeries) GetExemplars 

func (x *TimeSeries) GetExemplars() []*Exemplar

func (*TimeSeries) GetHistograms 

func (x *TimeSeries) GetHistograms() []*Histogram

func (*TimeSeries) GetLabels 

func (x *TimeSeries) GetLabels() []*Label

func (*TimeSeries) GetSamples 

func (x *TimeSeries) GetSamples() []*Sample

func (*TimeSeries) ProtoMessage 

func (*TimeSeries) ProtoMessage()

func (*TimeSeries) ProtoReflect 

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

func (*TimeSeries) Reset 

func (x *TimeSeries) Reset()

func (*TimeSeries) String 

func (x *TimeSeries) String() string

type WriteRequest 

type WriteRequest struct {
	Timeseries []*TimeSeries     `protobuf:"bytes,1,rep,name=timeseries,proto3" json:"timeseries,omitempty"`
	Metadata   []*MetricMetadata `protobuf:"bytes,3,rep,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*WriteRequest) Descriptor deprecated 

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

Deprecated: Use WriteRequest.ProtoReflect.Descriptor instead.

func (*WriteRequest) GetMetadata 

func (x *WriteRequest) GetMetadata() []*MetricMetadata

func (*WriteRequest) GetTimeseries 

func (x *WriteRequest) GetTimeseries() []*TimeSeries

func (*WriteRequest) ProtoMessage 

func (*WriteRequest) ProtoMessage()

func (*WriteRequest) ProtoReflect 

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

func (*WriteRequest) Reset 

func (x *WriteRequest) Reset()

func (*WriteRequest) String 

func (x *WriteRequest) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.