v1

package
v0.8.0 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2021 License: Apache-2.0 Imports: 7 Imported by: 55

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	AggregationTemporality_name = map[int32]string{
		0: "AGGREGATION_TEMPORALITY_UNSPECIFIED",
		1: "AGGREGATION_TEMPORALITY_DELTA",
		2: "AGGREGATION_TEMPORALITY_CUMULATIVE",
	}
	AggregationTemporality_value = map[string]int32{
		"AGGREGATION_TEMPORALITY_UNSPECIFIED": 0,
		"AGGREGATION_TEMPORALITY_DELTA":       1,
		"AGGREGATION_TEMPORALITY_CUMULATIVE":  2,
	}
)

Enum value maps for AggregationTemporality.

View Source 
var File_opentelemetry_proto_metrics_v1_metrics_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AggregationTemporality 

type AggregationTemporality int32

AggregationTemporality defines how a metric aggregator reports aggregated values. It describes how those values relate to the time interval over which they are aggregated. 

const (
	// UNSPECIFIED is the default AggregationTemporality, it MUST not be used.
	AggregationTemporality_AGGREGATION_TEMPORALITY_UNSPECIFIED AggregationTemporality = 0
	// DELTA is an AggregationTemporality for a metric aggregator which reports
	// changes since last report time. Successive metrics contain aggregation of
	// values from continuous and non-overlapping intervals.
	//
	// The values for a DELTA metric are based only on the time interval
	// associated with one measurement cycle. There is no dependency on
	// previous measurements like is the case for CUMULATIVE metrics.
	//
	// For example, consider a system measuring the number of requests that
	// it receives and reports the sum of these requests every second as a
	// DELTA metric:
	//
	//   1. The system starts receiving at time=t_0.
	//   2. A request is received, the system measures 1 request.
	//   3. A request is received, the system measures 1 request.
	//   4. A request is received, the system measures 1 request.
	//   5. The 1 second collection cycle ends. A metric is exported for the
	//      number of requests received over the interval of time t_0 to
	//      t_0+1 with a value of 3.
	//   6. A request is received, the system measures 1 request.
	//   7. A request is received, the system measures 1 request.
	//   8. The 1 second collection cycle ends. A metric is exported for the
	//      number of requests received over the interval of time t_0+1 to
	//      t_0+2 with a value of 2.
	AggregationTemporality_AGGREGATION_TEMPORALITY_DELTA AggregationTemporality = 1
	// CUMULATIVE is an AggregationTemporality for a metric aggregator which
	// reports changes since a fixed start time. This means that current values
	// of a CUMULATIVE metric depend on all previous measurements since the
	// start time. Because of this, the sender is required to retain this state
	// in some form. If this state is lost or invalidated, the CUMULATIVE metric
	// values MUST be reset and a new fixed start time following the last
	// reported measurement time sent MUST be used.
	//
	// For example, consider a system measuring the number of requests that
	// it receives and reports the sum of these requests every second as a
	// CUMULATIVE metric:
	//
	//   1. The system starts receiving at time=t_0.
	//   2. A request is received, the system measures 1 request.
	//   3. A request is received, the system measures 1 request.
	//   4. A request is received, the system measures 1 request.
	//   5. The 1 second collection cycle ends. A metric is exported for the
	//      number of requests received over the interval of time t_0 to
	//      t_0+1 with a value of 3.
	//   6. A request is received, the system measures 1 request.
	//   7. A request is received, the system measures 1 request.
	//   8. The 1 second collection cycle ends. A metric is exported for the
	//      number of requests received over the interval of time t_0 to
	//      t_0+2 with a value of 5.
	//   9. The system experiences a fault and loses state.
	//   10. The system recovers and resumes receiving at time=t_1.
	//   11. A request is received, the system measures 1 request.
	//   12. The 1 second collection cycle ends. A metric is exported for the
	//      number of requests received over the interval of time t_1 to
	//      t_0+1 with a value of 1.
	//
	// Note: Even though, when reporting changes since last report time, using
	// CUMULATIVE is valid, it is not recommended. This may cause problems for
	// systems that do not use start_time to determine when the aggregation
	// value was reset (e.g. Prometheus).
	AggregationTemporality_AGGREGATION_TEMPORALITY_CUMULATIVE AggregationTemporality = 2
)

func (AggregationTemporality) Descriptor 

func (AggregationTemporality) Descriptor() protoreflect.EnumDescriptor

func (AggregationTemporality) Enum 

func (x AggregationTemporality) Enum() *AggregationTemporality

func (AggregationTemporality) EnumDescriptor deprecated 

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

Deprecated: Use AggregationTemporality.Descriptor instead.

func (AggregationTemporality) Number 

func (x AggregationTemporality) Number() protoreflect.EnumNumber

func (AggregationTemporality) String 

func (x AggregationTemporality) String() string

func (AggregationTemporality) Type 

func (AggregationTemporality) Type() protoreflect.EnumType

type Exemplar added in v0.8.0 

type Exemplar struct {

	// The set of labels that were filtered out by the aggregator, but recorded
	// alongside the original measurement. Only labels that were filtered out
	// by the aggregator should be included
	FilteredLabels []*v11.StringKeyValue `protobuf:"bytes,1,rep,name=filtered_labels,json=filteredLabels,proto3" json:"filtered_labels,omitempty"`
	// time_unix_nano is the exact time when this exemplar was recorded
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	TimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// Numerical value of the measurement that was recorded. An exemplar is
	// considered invalid when one of the recognized value fields is not present
	// inside this oneof.
	//
	// Types that are assignable to Value:
	//	*Exemplar_AsDouble
	//	*Exemplar_AsInt
	Value isExemplar_Value `protobuf_oneof:"value"`
	// (Optional) Span ID of the exemplar trace.
	// span_id may be missing if the measurement is not recorded inside a trace
	// or if the trace is not sampled.
	SpanId []byte `protobuf:"bytes,4,opt,name=span_id,json=spanId,proto3" json:"span_id,omitempty"`
	// (Optional) Trace ID of the exemplar trace.
	// trace_id may be missing if the measurement is not recorded inside a trace
	// or if the trace is not sampled.
	TraceId []byte `protobuf:"bytes,5,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	// contains filtered or unexported fields
}

A representation of an exemplar, which is a sample input measurement. Exemplars also hold information about the environment when the measurement was recorded, for example the span and trace ID of the active span when the exemplar was recorded.

func (*Exemplar) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use Exemplar.ProtoReflect.Descriptor instead.

func (*Exemplar) GetAsDouble added in v0.8.0 

func (x *Exemplar) GetAsDouble() float64

func (*Exemplar) GetAsInt added in v0.8.0 

func (x *Exemplar) GetAsInt() int64

func (*Exemplar) GetFilteredLabels added in v0.8.0 

func (x *Exemplar) GetFilteredLabels() []*v11.StringKeyValue

func (*Exemplar) GetSpanId added in v0.8.0 

func (x *Exemplar) GetSpanId() []byte

func (*Exemplar) GetTimeUnixNano added in v0.8.0 

func (x *Exemplar) GetTimeUnixNano() uint64

func (*Exemplar) GetTraceId added in v0.8.0 

func (x *Exemplar) GetTraceId() []byte

func (*Exemplar) GetValue added in v0.8.0 

func (m *Exemplar) GetValue() isExemplar_Value

func (*Exemplar) ProtoMessage added in v0.8.0 

func (*Exemplar) ProtoMessage()

func (*Exemplar) ProtoReflect added in v0.8.0 

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

func (*Exemplar) Reset added in v0.8.0 

func (x *Exemplar) Reset()

func (*Exemplar) String added in v0.8.0 

func (x *Exemplar) String() string

type Exemplar_AsDouble added in v0.8.0 

type Exemplar_AsDouble struct {
	AsDouble float64 `protobuf:"fixed64,3,opt,name=as_double,json=asDouble,proto3,oneof"`
}

type Exemplar_AsInt added in v0.8.0 

type Exemplar_AsInt struct {
	AsInt int64 `protobuf:"fixed64,6,opt,name=as_int,json=asInt,proto3,oneof"`
}

type Gauge added in v0.8.0 

type Gauge struct {
	DataPoints []*NumberDataPoint `protobuf:"bytes,1,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// contains filtered or unexported fields
}

Gauge represents the type of a double scalar metric that always exports the "current value" for every data point. It should be used for an "unknown" aggregation.

A Gauge does not support different aggregation temporalities. Given the aggregation is unknown, points cannot be combined using the same aggregation, regardless of aggregation temporalities. Therefore, AggregationTemporality is not included. Consequently, this also means "StartTimeUnixNano" is ignored for all data points.

func (*Gauge) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use Gauge.ProtoReflect.Descriptor instead.

func (*Gauge) GetDataPoints added in v0.8.0 

func (x *Gauge) GetDataPoints() []*NumberDataPoint

func (*Gauge) ProtoMessage added in v0.8.0 

func (*Gauge) ProtoMessage()

func (*Gauge) ProtoReflect added in v0.8.0 

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

func (*Gauge) Reset added in v0.8.0 

func (x *Gauge) Reset()

func (*Gauge) String added in v0.8.0 

func (x *Gauge) String() string

type Histogram added in v0.8.0 

type Histogram struct {
	DataPoints []*HistogramDataPoint `protobuf:"bytes,1,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// aggregation_temporality describes if the aggregator reports delta changes
	// since last report time, or cumulative changes since a fixed start time.
	AggregationTemporality AggregationTemporality `` /* 187-byte string literal not displayed */
	// contains filtered or unexported fields
}

Histogram represents the type of a metric that is calculated by aggregating as a Histogram of all reported double measurements over a time interval.

func (*Histogram) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use Histogram.ProtoReflect.Descriptor instead.

func (*Histogram) GetAggregationTemporality added in v0.8.0 

func (x *Histogram) GetAggregationTemporality() AggregationTemporality

func (*Histogram) GetDataPoints added in v0.8.0 

func (x *Histogram) GetDataPoints() []*HistogramDataPoint

func (*Histogram) ProtoMessage added in v0.8.0 

func (*Histogram) ProtoMessage()

func (*Histogram) ProtoReflect added in v0.8.0 

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

func (*Histogram) Reset added in v0.8.0 

func (x *Histogram) Reset()

func (*Histogram) String added in v0.8.0 

func (x *Histogram) String() string

type HistogramDataPoint added in v0.8.0 

type HistogramDataPoint struct {

	// The set of labels that uniquely identify this timeseries.
	Labels []*v11.StringKeyValue `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// start_time_unix_nano is the last time when the aggregation value was reset
	// to "zero". For some metric types this is ignored, see data types for more
	// details.
	//
	// The aggregation value is over the time interval (start_time_unix_nano,
	// time_unix_nano].
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	//
	// Value of 0 indicates that the timestamp is unspecified. In that case the
	// timestamp may be decided by the backend.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// time_unix_nano is the moment when this aggregation value was reported.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	TimeUnixNano uint64 `protobuf:"fixed64,3,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// count is the number of values in the population. Must be non-negative. This
	// value must be equal to the sum of the "count" fields in buckets if a
	// histogram is provided.
	Count uint64 `protobuf:"fixed64,4,opt,name=count,proto3" json:"count,omitempty"`
	// sum of the values in the population. If count is zero then this field
	// must be zero. This value must be equal to the sum of the "sum" fields in
	// buckets if a histogram is provided.
	Sum float64 `protobuf:"fixed64,5,opt,name=sum,proto3" json:"sum,omitempty"`
	// bucket_counts is an optional field contains the count values of histogram
	// for each bucket.
	//
	// The sum of the bucket_counts must equal the value in the count field.
	//
	// The number of elements in bucket_counts array must be by one greater than
	// the number of elements in explicit_bounds array.
	BucketCounts []uint64 `protobuf:"fixed64,6,rep,packed,name=bucket_counts,json=bucketCounts,proto3" json:"bucket_counts,omitempty"`
	// explicit_bounds specifies buckets with explicitly defined bounds for values.
	//
	// This defines size(explicit_bounds) + 1 (= N) buckets. The boundaries for
	// bucket at index i are:
	//
	// (-infinity, explicit_bounds[i]] for i == 0
	// (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < N-1
	// (explicit_bounds[i], +infinity) for i == N-1
	//
	// The values in the explicit_bounds array must be strictly increasing.
	//
	// Histogram buckets are inclusive of their upper boundary, except the last
	// bucket where the boundary is at infinity. This format is intentionally
	// compatible with the OpenMetrics histogram definition.
	ExplicitBounds []float64 `protobuf:"fixed64,7,rep,packed,name=explicit_bounds,json=explicitBounds,proto3" json:"explicit_bounds,omitempty"`
	// (Optional) List of exemplars collected from
	// measurements that were used to form the data point
	Exemplars []*Exemplar `protobuf:"bytes,8,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	// contains filtered or unexported fields
}

HistogramDataPoint is a single data point in a timeseries that describes the time-varying values of a Histogram of double values. A Histogram contains summary statistics for a population of values, it may optionally contain the distribution of those values across a set of buckets.

func (*HistogramDataPoint) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use HistogramDataPoint.ProtoReflect.Descriptor instead.

func (*HistogramDataPoint) GetBucketCounts added in v0.8.0 

func (x *HistogramDataPoint) GetBucketCounts() []uint64

func (*HistogramDataPoint) GetCount added in v0.8.0 

func (x *HistogramDataPoint) GetCount() uint64

func (*HistogramDataPoint) GetExemplars added in v0.8.0 

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

func (*HistogramDataPoint) GetExplicitBounds added in v0.8.0 

func (x *HistogramDataPoint) GetExplicitBounds() []float64

func (*HistogramDataPoint) GetLabels added in v0.8.0 

func (x *HistogramDataPoint) GetLabels() []*v11.StringKeyValue

func (*HistogramDataPoint) GetStartTimeUnixNano added in v0.8.0 

func (x *HistogramDataPoint) GetStartTimeUnixNano() uint64

func (*HistogramDataPoint) GetSum added in v0.8.0 

func (x *HistogramDataPoint) GetSum() float64

func (*HistogramDataPoint) GetTimeUnixNano added in v0.8.0 

func (x *HistogramDataPoint) GetTimeUnixNano() uint64

func (*HistogramDataPoint) ProtoMessage added in v0.8.0 

func (*HistogramDataPoint) ProtoMessage()

func (*HistogramDataPoint) ProtoReflect added in v0.8.0 

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

func (*HistogramDataPoint) Reset added in v0.8.0 

func (x *HistogramDataPoint) Reset()

func (*HistogramDataPoint) String added in v0.8.0 

func (x *HistogramDataPoint) String() string

type InstrumentationLibraryMetrics 

type InstrumentationLibraryMetrics struct {

	// The instrumentation library information for the metrics in this message.
	// Semantically when InstrumentationLibrary isn't set, it is equivalent with
	// an empty instrumentation library name (unknown).
	InstrumentationLibrary *v11.InstrumentationLibrary `` /* 127-byte string literal not displayed */
	// A list of metrics that originate from an instrumentation library.
	Metrics []*Metric `protobuf:"bytes,2,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

A collection of Metrics produced by an InstrumentationLibrary.

func (*InstrumentationLibraryMetrics) Descriptor deprecated 

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

Deprecated: Use InstrumentationLibraryMetrics.ProtoReflect.Descriptor instead.

func (*InstrumentationLibraryMetrics) GetInstrumentationLibrary 

func (x *InstrumentationLibraryMetrics) GetInstrumentationLibrary() *v11.InstrumentationLibrary

func (*InstrumentationLibraryMetrics) GetMetrics 

func (x *InstrumentationLibraryMetrics) GetMetrics() []*Metric

func (*InstrumentationLibraryMetrics) ProtoMessage 

func (*InstrumentationLibraryMetrics) ProtoMessage()

func (*InstrumentationLibraryMetrics) ProtoReflect 

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

func (*InstrumentationLibraryMetrics) Reset 

func (x *InstrumentationLibraryMetrics) Reset()

func (*InstrumentationLibraryMetrics) String 

func (x *InstrumentationLibraryMetrics) String() string

type IntDataPoint deprecated 

type IntDataPoint struct {

	// The set of labels that uniquely identify this timeseries.
	Labels []*v11.StringKeyValue `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// start_time_unix_nano is the last time when the aggregation value was reset
	// to "zero". For some metric types this is ignored, see data types for more
	// details.
	//
	// The aggregation value is over the time interval (start_time_unix_nano,
	// time_unix_nano].
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	//
	// Value of 0 indicates that the timestamp is unspecified. In that case the
	// timestamp may be decided by the backend.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// time_unix_nano is the moment when this aggregation value was reported.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	TimeUnixNano uint64 `protobuf:"fixed64,3,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// value itself.
	Value int64 `protobuf:"fixed64,4,opt,name=value,proto3" json:"value,omitempty"`
	// (Optional) List of exemplars collected from
	// measurements that were used to form the data point
	Exemplars []*IntExemplar `protobuf:"bytes,5,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	// contains filtered or unexported fields
}

IntDataPoint is a single data point in a timeseries that describes the time-varying values of a int64 metric.

Deprecated: Do not use.

func (*IntDataPoint) Descriptor deprecated 

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

Deprecated: Use IntDataPoint.ProtoReflect.Descriptor instead.

func (*IntDataPoint) GetExemplars 

func (x *IntDataPoint) GetExemplars() []*IntExemplar

func (*IntDataPoint) GetLabels 

func (x *IntDataPoint) GetLabels() []*v11.StringKeyValue

func (*IntDataPoint) GetStartTimeUnixNano 

func (x *IntDataPoint) GetStartTimeUnixNano() uint64

func (*IntDataPoint) GetTimeUnixNano 

func (x *IntDataPoint) GetTimeUnixNano() uint64

func (*IntDataPoint) GetValue 

func (x *IntDataPoint) GetValue() int64

func (*IntDataPoint) ProtoMessage 

func (*IntDataPoint) ProtoMessage()

func (*IntDataPoint) ProtoReflect 

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

func (*IntDataPoint) Reset 

func (x *IntDataPoint) Reset()

func (*IntDataPoint) String 

func (x *IntDataPoint) String() string

type IntExemplar deprecated 

type IntExemplar struct {

	// The set of labels that were filtered out by the aggregator, but recorded
	// alongside the original measurement. Only labels that were filtered out
	// by the aggregator should be included
	FilteredLabels []*v11.StringKeyValue `protobuf:"bytes,1,rep,name=filtered_labels,json=filteredLabels,proto3" json:"filtered_labels,omitempty"`
	// time_unix_nano is the exact time when this exemplar was recorded
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	TimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// Numerical int value of the measurement that was recorded.
	Value int64 `protobuf:"fixed64,3,opt,name=value,proto3" json:"value,omitempty"`
	// (Optional) Span ID of the exemplar trace.
	// span_id may be missing if the measurement is not recorded inside a trace
	// or if the trace is not sampled.
	SpanId []byte `protobuf:"bytes,4,opt,name=span_id,json=spanId,proto3" json:"span_id,omitempty"`
	// (Optional) Trace ID of the exemplar trace.
	// trace_id may be missing if the measurement is not recorded inside a trace
	// or if the trace is not sampled.
	TraceId []byte `protobuf:"bytes,5,opt,name=trace_id,json=traceId,proto3" json:"trace_id,omitempty"`
	// contains filtered or unexported fields
}

A representation of an exemplar, which is a sample input int measurement. Exemplars also hold information about the environment when the measurement was recorded, for example the span and trace ID of the active span when the exemplar was recorded.

Deprecated: Do not use.

func (*IntExemplar) Descriptor deprecated 

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

Deprecated: Use IntExemplar.ProtoReflect.Descriptor instead.

func (*IntExemplar) GetFilteredLabels 

func (x *IntExemplar) GetFilteredLabels() []*v11.StringKeyValue

func (*IntExemplar) GetSpanId 

func (x *IntExemplar) GetSpanId() []byte

func (*IntExemplar) GetTimeUnixNano 

func (x *IntExemplar) GetTimeUnixNano() uint64

func (*IntExemplar) GetTraceId 

func (x *IntExemplar) GetTraceId() []byte

func (*IntExemplar) GetValue 

func (x *IntExemplar) GetValue() int64

func (*IntExemplar) ProtoMessage 

func (*IntExemplar) ProtoMessage()

func (*IntExemplar) ProtoReflect 

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

func (*IntExemplar) Reset 

func (x *IntExemplar) Reset()

func (*IntExemplar) String 

func (x *IntExemplar) String() string

type IntGauge deprecated 

type IntGauge struct {
	DataPoints []*IntDataPoint `protobuf:"bytes,1,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// contains filtered or unexported fields
}

IntGauge is deprecated. Use Gauge with an integer value in NumberDataPoint.

IntGauge represents the type of a int scalar metric that always exports the "current value" for every data point. It should be used for an "unknown" aggregation.

A Gauge does not support different aggregation temporalities. Given the aggregation is unknown, points cannot be combined using the same aggregation, regardless of aggregation temporalities. Therefore, AggregationTemporality is not included. Consequently, this also means "StartTimeUnixNano" is ignored for all data points.

Deprecated: Do not use.

func (*IntGauge) Descriptor deprecated 

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

Deprecated: Use IntGauge.ProtoReflect.Descriptor instead.

func (*IntGauge) GetDataPoints 

func (x *IntGauge) GetDataPoints() []*IntDataPoint

func (*IntGauge) ProtoMessage 

func (*IntGauge) ProtoMessage()

func (*IntGauge) ProtoReflect 

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

func (*IntGauge) Reset 

func (x *IntGauge) Reset()

func (*IntGauge) String 

func (x *IntGauge) String() string

type IntHistogram deprecated 

type IntHistogram struct {
	DataPoints []*IntHistogramDataPoint `protobuf:"bytes,1,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// aggregation_temporality describes if the aggregator reports delta changes
	// since last report time, or cumulative changes since a fixed start time.
	AggregationTemporality AggregationTemporality `` /* 187-byte string literal not displayed */
	// contains filtered or unexported fields
}

IntHistogram is deprecated, replaced by Histogram points using double- valued exemplars.

This represents the type of a metric that is calculated by aggregating as a Histogram of all reported int measurements over a time interval.

Deprecated: Do not use.

func (*IntHistogram) Descriptor deprecated 

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

Deprecated: Use IntHistogram.ProtoReflect.Descriptor instead.

func (*IntHistogram) GetAggregationTemporality 

func (x *IntHistogram) GetAggregationTemporality() AggregationTemporality

func (*IntHistogram) GetDataPoints 

func (x *IntHistogram) GetDataPoints() []*IntHistogramDataPoint

func (*IntHistogram) ProtoMessage 

func (*IntHistogram) ProtoMessage()

func (*IntHistogram) ProtoReflect 

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

func (*IntHistogram) Reset 

func (x *IntHistogram) Reset()

func (*IntHistogram) String 

func (x *IntHistogram) String() string

type IntHistogramDataPoint deprecated 

type IntHistogramDataPoint struct {

	// The set of labels that uniquely identify this timeseries.
	Labels []*v11.StringKeyValue `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// start_time_unix_nano is the last time when the aggregation value was reset
	// to "zero". For some metric types this is ignored, see data types for more
	// details.
	//
	// The aggregation value is over the time interval (start_time_unix_nano,
	// time_unix_nano].
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	//
	// Value of 0 indicates that the timestamp is unspecified. In that case the
	// timestamp may be decided by the backend.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// time_unix_nano is the moment when this aggregation value was reported.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	TimeUnixNano uint64 `protobuf:"fixed64,3,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// count is the number of values in the population. Must be non-negative. This
	// value must be equal to the sum of the "count" fields in buckets if a
	// histogram is provided.
	Count uint64 `protobuf:"fixed64,4,opt,name=count,proto3" json:"count,omitempty"`
	// sum of the values in the population. If count is zero then this field
	// must be zero. This value must be equal to the sum of the "sum" fields in
	// buckets if a histogram is provided.
	Sum int64 `protobuf:"fixed64,5,opt,name=sum,proto3" json:"sum,omitempty"`
	// bucket_counts is an optional field contains the count values of histogram
	// for each bucket.
	//
	// The sum of the bucket_counts must equal the value in the count field.
	//
	// The number of elements in bucket_counts array must be by one greater than
	// the number of elements in explicit_bounds array.
	BucketCounts []uint64 `protobuf:"fixed64,6,rep,packed,name=bucket_counts,json=bucketCounts,proto3" json:"bucket_counts,omitempty"`
	// explicit_bounds specifies buckets with explicitly defined bounds for values.
	//
	// This defines size(explicit_bounds) + 1 (= N) buckets. The boundaries for
	// bucket at index i are:
	//
	// (-infinity, explicit_bounds[i]] for i == 0
	// (explicit_bounds[i-1], explicit_bounds[i]] for 0 < i < N-1
	// (explicit_bounds[i], +infinity) for i == N-1
	//
	// The values in the explicit_bounds array must be strictly increasing.
	//
	// Histogram buckets are inclusive of their upper boundary, except the last
	// bucket where the boundary is at infinity. This format is intentionally
	// compatible with the OpenMetrics histogram definition.
	ExplicitBounds []float64 `protobuf:"fixed64,7,rep,packed,name=explicit_bounds,json=explicitBounds,proto3" json:"explicit_bounds,omitempty"`
	// (Optional) List of exemplars collected from
	// measurements that were used to form the data point
	Exemplars []*IntExemplar `protobuf:"bytes,8,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	// contains filtered or unexported fields
}

IntHistogramDataPoint is deprecated; use HistogramDataPoint.

This is a single data point in a timeseries that describes the time-varying values of a Histogram of int values. A Histogram contains summary statistics for a population of values, it may optionally contain the distribution of those values across a set of buckets.

Deprecated: Do not use.

func (*IntHistogramDataPoint) Descriptor deprecated 

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

Deprecated: Use IntHistogramDataPoint.ProtoReflect.Descriptor instead.

func (*IntHistogramDataPoint) GetBucketCounts 

func (x *IntHistogramDataPoint) GetBucketCounts() []uint64

func (*IntHistogramDataPoint) GetCount 

func (x *IntHistogramDataPoint) GetCount() uint64

func (*IntHistogramDataPoint) GetExemplars 

func (x *IntHistogramDataPoint) GetExemplars() []*IntExemplar

func (*IntHistogramDataPoint) GetExplicitBounds 

func (x *IntHistogramDataPoint) GetExplicitBounds() []float64

func (*IntHistogramDataPoint) GetLabels 

func (x *IntHistogramDataPoint) GetLabels() []*v11.StringKeyValue

func (*IntHistogramDataPoint) GetStartTimeUnixNano 

func (x *IntHistogramDataPoint) GetStartTimeUnixNano() uint64

func (*IntHistogramDataPoint) GetSum 

func (x *IntHistogramDataPoint) GetSum() int64

func (*IntHistogramDataPoint) GetTimeUnixNano 

func (x *IntHistogramDataPoint) GetTimeUnixNano() uint64

func (*IntHistogramDataPoint) ProtoMessage 

func (*IntHistogramDataPoint) ProtoMessage()

func (*IntHistogramDataPoint) ProtoReflect 

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

func (*IntHistogramDataPoint) Reset 

func (x *IntHistogramDataPoint) Reset()

func (*IntHistogramDataPoint) String 

func (x *IntHistogramDataPoint) String() string

type IntSum deprecated 

type IntSum struct {
	DataPoints []*IntDataPoint `protobuf:"bytes,1,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// aggregation_temporality describes if the aggregator reports delta changes
	// since last report time, or cumulative changes since a fixed start time.
	AggregationTemporality AggregationTemporality `` /* 187-byte string literal not displayed */
	// If "true" means that the sum is monotonic.
	IsMonotonic bool `protobuf:"varint,3,opt,name=is_monotonic,json=isMonotonic,proto3" json:"is_monotonic,omitempty"`
	// contains filtered or unexported fields
}

IntSum is deprecated. Use Sum with an integer value in NumberDataPoint.

IntSum represents the type of a numeric int scalar metric that is calculated as a sum of all reported measurements over a time interval.

Deprecated: Do not use.

func (*IntSum) Descriptor deprecated 

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

Deprecated: Use IntSum.ProtoReflect.Descriptor instead.

func (*IntSum) GetAggregationTemporality 

func (x *IntSum) GetAggregationTemporality() AggregationTemporality

func (*IntSum) GetDataPoints 

func (x *IntSum) GetDataPoints() []*IntDataPoint

func (*IntSum) GetIsMonotonic 

func (x *IntSum) GetIsMonotonic() bool

func (*IntSum) ProtoMessage 

func (*IntSum) ProtoMessage()

func (*IntSum) ProtoReflect 

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

func (*IntSum) Reset 

func (x *IntSum) Reset()

func (*IntSum) String 

func (x *IntSum) String() string

type Metric 

type Metric struct {

	// name of the metric, including its DNS name prefix. It must be unique.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// description of the metric, which can be used in documentation.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// unit in which the metric value is reported. Follows the format
	// described by http://unitsofmeasure.org/ucum.html.
	Unit string `protobuf:"bytes,3,opt,name=unit,proto3" json:"unit,omitempty"`
	// Data determines the aggregation type (if any) of the metric, what is the
	// reported value type for the data points, as well as the relatationship to
	// the time interval over which they are reported.
	//
	// Types that are assignable to Data:
	//	*Metric_IntGauge
	//	*Metric_Gauge
	//	*Metric_IntSum
	//	*Metric_Sum
	//	*Metric_IntHistogram
	//	*Metric_Histogram
	//	*Metric_Summary
	Data isMetric_Data `protobuf_oneof:"data"`
	// contains filtered or unexported fields
}

Defines a Metric which has one or more timeseries.

The data model and relation between entities is shown in the diagram below. Here, "DataPoint" is the term used to refer to any one of the specific data point value types, and "points" is the term used to refer to any one of the lists of points contained in the Metric.

  • Metric is composed of a metadata and data.

  • Metadata part contains a name, description, unit.

  • Data is one of the possible types (Gauge, Sum, Histogram, etc.).

  • DataPoint contains timestamps, labels, and one of the possible value type fields.

    Metric +------------+ |name | |description | |unit | +------------------------------------+ |data |---> |Gauge, Sum, Histogram, Summary, ... | +------------+ +------------------------------------+

    Data [One of Gauge, Sum, Histogram, Summary, ...] +-----------+ |... | // Metadata about the Data. |points |--+ +-----------+ | | +---------------------------+ | |DataPoint 1 | v |+------+------+ +------+ | +-----+ ||label |label |...|label | | | 1 |-->||value1|value2|...|valueN| | +-----+ |+------+------+ +------+ | | . | |+-----+ | | . | ||value| | | . | |+-----+ | | . | +---------------------------+ | . | . | . | . | . | . | . | +---------------------------+ | . | |DataPoint M | +-----+ |+------+------+ +------+ | | M |-->||label |label |...|label | | +-----+ ||value1|value2|...|valueN| | |+------+------+ +------+ | |+-----+ | ||value| | |+-----+ | +---------------------------+

All DataPoint types have three common fields:

  • Labels zero or more key-value pairs associated with the data point.
  • StartTimeUnixNano MUST be set to the start of the interval when the data's type includes an AggregationTemporality. This field is not set otherwise.
  • TimeUnixNano MUST be set to:
  • the moment when an aggregation is reported (independent of the aggregation temporality).
  • the instantaneous time of the event.

func (*Metric) Descriptor deprecated 

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

Deprecated: Use Metric.ProtoReflect.Descriptor instead.

func (*Metric) GetData 

func (m *Metric) GetData() isMetric_Data

func (*Metric) GetDescription 

func (x *Metric) GetDescription() string

func (*Metric) GetGauge added in v0.8.0 

func (x *Metric) GetGauge() *Gauge

func (*Metric) GetHistogram added in v0.8.0 

func (x *Metric) GetHistogram() *Histogram

func (*Metric) GetIntGauge deprecated 

func (x *Metric) GetIntGauge() *IntGauge

Deprecated: Do not use.

func (*Metric) GetIntHistogram deprecated 

func (x *Metric) GetIntHistogram() *IntHistogram

Deprecated: Do not use.

func (*Metric) GetIntSum deprecated 

func (x *Metric) GetIntSum() *IntSum

Deprecated: Do not use.

func (*Metric) GetName 

func (x *Metric) GetName() string

func (*Metric) GetSum added in v0.8.0 

func (x *Metric) GetSum() *Sum

func (*Metric) GetSummary added in v0.8.0 

func (x *Metric) GetSummary() *Summary

func (*Metric) GetUnit 

func (x *Metric) GetUnit() string

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 Metric_Gauge added in v0.8.0 

type Metric_Gauge struct {
	Gauge *Gauge `protobuf:"bytes,5,opt,name=gauge,proto3,oneof"`
}

type Metric_Histogram added in v0.8.0 

type Metric_Histogram struct {
	Histogram *Histogram `protobuf:"bytes,9,opt,name=histogram,proto3,oneof"`
}

type Metric_IntGauge 

type Metric_IntGauge struct {
	// IntGauge and IntSum are deprecated and will be removed soon.
	// 1. Old senders and receivers that are not aware of this change will
	// continue using the `int_gauge` and `int_sum` fields.
	// 2. New senders, which are aware of this change MUST send only `gauge`
	// and `sum` fields.
	// 3. New receivers, which are aware of this change MUST convert these into
	// `gauge` and `sum` by using the provided as_int field in the oneof values.
	//
	// Deprecated: Do not use.
	IntGauge *IntGauge `protobuf:"bytes,4,opt,name=int_gauge,json=intGauge,proto3,oneof"`
}

type Metric_IntHistogram 

type Metric_IntHistogram struct {
	// IntHistogram is deprecated and will be removed soon.
	// 1. Old senders and receivers that are not aware of this change will
	// continue using the `int_histogram` field.
	// 2. New senders, which are aware of this change MUST send only `histogram`.
	// 3. New receivers, which are aware of this change MUST convert this into
	// `histogram` by simply converting all int64 values into float.
	//
	// Deprecated: Do not use.
	IntHistogram *IntHistogram `protobuf:"bytes,8,opt,name=int_histogram,json=intHistogram,proto3,oneof"`
}

type Metric_IntSum 

type Metric_IntSum struct {
	// Deprecated: Do not use.
	IntSum *IntSum `protobuf:"bytes,6,opt,name=int_sum,json=intSum,proto3,oneof"`
}

type Metric_Sum added in v0.8.0 

type Metric_Sum struct {
	Sum *Sum `protobuf:"bytes,7,opt,name=sum,proto3,oneof"`
}

type Metric_Summary added in v0.8.0 

type Metric_Summary struct {
	Summary *Summary `protobuf:"bytes,11,opt,name=summary,proto3,oneof"`
}

type NumberDataPoint added in v0.8.0 

type NumberDataPoint struct {

	// The set of labels that uniquely identify this timeseries.
	Labels []*v11.StringKeyValue `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// start_time_unix_nano is the last time when the aggregation value was reset
	// to "zero". For some metric types this is ignored, see data types for more
	// details.
	//
	// The aggregation value is over the time interval (start_time_unix_nano,
	// time_unix_nano].
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	//
	// Value of 0 indicates that the timestamp is unspecified. In that case the
	// timestamp may be decided by the backend.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// time_unix_nano is the moment when this aggregation value was reported.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	TimeUnixNano uint64 `protobuf:"fixed64,3,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// The value itself.  A point is considered invalid when one of the recognized
	// value fields is not present inside this oneof.
	//
	// Types that are assignable to Value:
	//	*NumberDataPoint_AsDouble
	//	*NumberDataPoint_AsInt
	Value isNumberDataPoint_Value `protobuf_oneof:"value"`
	// (Optional) List of exemplars collected from
	// measurements that were used to form the data point
	Exemplars []*Exemplar `protobuf:"bytes,5,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
	// contains filtered or unexported fields
}

NumberDataPoint is a single data point in a timeseries that describes the time-varying value of a double metric.

func (*NumberDataPoint) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use NumberDataPoint.ProtoReflect.Descriptor instead.

func (*NumberDataPoint) GetAsDouble added in v0.8.0 

func (x *NumberDataPoint) GetAsDouble() float64

func (*NumberDataPoint) GetAsInt added in v0.8.0 

func (x *NumberDataPoint) GetAsInt() int64

func (*NumberDataPoint) GetExemplars added in v0.8.0 

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

func (*NumberDataPoint) GetLabels added in v0.8.0 

func (x *NumberDataPoint) GetLabels() []*v11.StringKeyValue

func (*NumberDataPoint) GetStartTimeUnixNano added in v0.8.0 

func (x *NumberDataPoint) GetStartTimeUnixNano() uint64

func (*NumberDataPoint) GetTimeUnixNano added in v0.8.0 

func (x *NumberDataPoint) GetTimeUnixNano() uint64

func (*NumberDataPoint) GetValue added in v0.8.0 

func (m *NumberDataPoint) GetValue() isNumberDataPoint_Value

func (*NumberDataPoint) ProtoMessage added in v0.8.0 

func (*NumberDataPoint) ProtoMessage()

func (*NumberDataPoint) ProtoReflect added in v0.8.0 

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

func (*NumberDataPoint) Reset added in v0.8.0 

func (x *NumberDataPoint) Reset()

func (*NumberDataPoint) String added in v0.8.0 

func (x *NumberDataPoint) String() string

type NumberDataPoint_AsDouble added in v0.8.0 

type NumberDataPoint_AsDouble struct {
	AsDouble float64 `protobuf:"fixed64,4,opt,name=as_double,json=asDouble,proto3,oneof"`
}

type NumberDataPoint_AsInt added in v0.8.0 

type NumberDataPoint_AsInt struct {
	AsInt int64 `protobuf:"fixed64,6,opt,name=as_int,json=asInt,proto3,oneof"`
}

type ResourceMetrics 

type ResourceMetrics struct {

	// The resource for the metrics in this message.
	// If this field is not set then no resource info is known.
	Resource *v1.Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// A list of metrics that originate from a resource.
	InstrumentationLibraryMetrics []*InstrumentationLibraryMetrics `` /* 150-byte string literal not displayed */
	// contains filtered or unexported fields
}

A collection of InstrumentationLibraryMetrics from a Resource.

func (*ResourceMetrics) Descriptor deprecated 

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

Deprecated: Use ResourceMetrics.ProtoReflect.Descriptor instead.

func (*ResourceMetrics) GetInstrumentationLibraryMetrics 

func (x *ResourceMetrics) GetInstrumentationLibraryMetrics() []*InstrumentationLibraryMetrics

func (*ResourceMetrics) GetResource 

func (x *ResourceMetrics) GetResource() *v1.Resource

func (*ResourceMetrics) ProtoMessage 

func (*ResourceMetrics) ProtoMessage()

func (*ResourceMetrics) ProtoReflect 

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

func (*ResourceMetrics) Reset 

func (x *ResourceMetrics) Reset()

func (*ResourceMetrics) String 

func (x *ResourceMetrics) String() string

type Sum added in v0.8.0 

type Sum struct {
	DataPoints []*NumberDataPoint `protobuf:"bytes,1,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// aggregation_temporality describes if the aggregator reports delta changes
	// since last report time, or cumulative changes since a fixed start time.
	AggregationTemporality AggregationTemporality `` /* 187-byte string literal not displayed */
	// If "true" means that the sum is monotonic.
	IsMonotonic bool `protobuf:"varint,3,opt,name=is_monotonic,json=isMonotonic,proto3" json:"is_monotonic,omitempty"`
	// contains filtered or unexported fields
}

Sum represents the type of a numeric double scalar metric that is calculated as a sum of all reported measurements over a time interval.

func (*Sum) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use Sum.ProtoReflect.Descriptor instead.

func (*Sum) GetAggregationTemporality added in v0.8.0 

func (x *Sum) GetAggregationTemporality() AggregationTemporality

func (*Sum) GetDataPoints added in v0.8.0 

func (x *Sum) GetDataPoints() []*NumberDataPoint

func (*Sum) GetIsMonotonic added in v0.8.0 

func (x *Sum) GetIsMonotonic() bool

func (*Sum) ProtoMessage added in v0.8.0 

func (*Sum) ProtoMessage()

func (*Sum) ProtoReflect added in v0.8.0 

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

func (*Sum) Reset added in v0.8.0 

func (x *Sum) Reset()

func (*Sum) String added in v0.8.0 

func (x *Sum) String() string

type Summary added in v0.8.0 

type Summary struct {
	DataPoints []*SummaryDataPoint `protobuf:"bytes,1,rep,name=data_points,json=dataPoints,proto3" json:"data_points,omitempty"`
	// contains filtered or unexported fields
}

Summary metric data are used to convey quantile summaries, a Prometheus (see: https://prometheus.io/docs/concepts/metric_types/#summary) and OpenMetrics (see: https://github.com/OpenObservability/OpenMetrics/blob/4dbf6075567ab43296eed941037c12951faafb92/protos/prometheus.proto#L45) data type. These data points cannot always be merged in a meaningful way. While they can be useful in some applications, histogram data points are recommended for new applications.

func (*Summary) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use Summary.ProtoReflect.Descriptor instead.

func (*Summary) GetDataPoints added in v0.8.0 

func (x *Summary) GetDataPoints() []*SummaryDataPoint

func (*Summary) ProtoMessage added in v0.8.0 

func (*Summary) ProtoMessage()

func (*Summary) ProtoReflect added in v0.8.0 

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

func (*Summary) Reset added in v0.8.0 

func (x *Summary) Reset()

func (*Summary) String added in v0.8.0 

func (x *Summary) String() string

type SummaryDataPoint added in v0.8.0 

type SummaryDataPoint struct {

	// The set of labels that uniquely identify this timeseries.
	Labels []*v11.StringKeyValue `protobuf:"bytes,1,rep,name=labels,proto3" json:"labels,omitempty"`
	// start_time_unix_nano is the last time when the aggregation value was reset
	// to "zero". For some metric types this is ignored, see data types for more
	// details.
	//
	// The aggregation value is over the time interval (start_time_unix_nano,
	// time_unix_nano].
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	//
	// Value of 0 indicates that the timestamp is unspecified. In that case the
	// timestamp may be decided by the backend.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// time_unix_nano is the moment when this aggregation value was reported.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	TimeUnixNano uint64 `protobuf:"fixed64,3,opt,name=time_unix_nano,json=timeUnixNano,proto3" json:"time_unix_nano,omitempty"`
	// count is the number of values in the population. Must be non-negative.
	Count uint64 `protobuf:"fixed64,4,opt,name=count,proto3" json:"count,omitempty"`
	// sum of the values in the population. If count is zero then this field
	// must be zero.
	Sum float64 `protobuf:"fixed64,5,opt,name=sum,proto3" json:"sum,omitempty"`
	// (Optional) list of values at different quantiles of the distribution calculated
	// from the current snapshot. The quantiles must be strictly increasing.
	QuantileValues []*SummaryDataPoint_ValueAtQuantile `protobuf:"bytes,6,rep,name=quantile_values,json=quantileValues,proto3" json:"quantile_values,omitempty"`
	// contains filtered or unexported fields
}

SummaryDataPoint is a single data point in a timeseries that describes the time-varying values of a Summary metric.

func (*SummaryDataPoint) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use SummaryDataPoint.ProtoReflect.Descriptor instead.

func (*SummaryDataPoint) GetCount added in v0.8.0 

func (x *SummaryDataPoint) GetCount() uint64

func (*SummaryDataPoint) GetLabels added in v0.8.0 

func (x *SummaryDataPoint) GetLabels() []*v11.StringKeyValue

func (*SummaryDataPoint) GetQuantileValues added in v0.8.0 

func (x *SummaryDataPoint) GetQuantileValues() []*SummaryDataPoint_ValueAtQuantile

func (*SummaryDataPoint) GetStartTimeUnixNano added in v0.8.0 

func (x *SummaryDataPoint) GetStartTimeUnixNano() uint64

func (*SummaryDataPoint) GetSum added in v0.8.0 

func (x *SummaryDataPoint) GetSum() float64

func (*SummaryDataPoint) GetTimeUnixNano added in v0.8.0 

func (x *SummaryDataPoint) GetTimeUnixNano() uint64

func (*SummaryDataPoint) ProtoMessage added in v0.8.0 

func (*SummaryDataPoint) ProtoMessage()

func (*SummaryDataPoint) ProtoReflect added in v0.8.0 

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

func (*SummaryDataPoint) Reset added in v0.8.0 

func (x *SummaryDataPoint) Reset()

func (*SummaryDataPoint) String added in v0.8.0 

func (x *SummaryDataPoint) String() string

type SummaryDataPoint_ValueAtQuantile added in v0.8.0 

type SummaryDataPoint_ValueAtQuantile struct {

	// The quantile of a distribution. Must be in the interval
	// [0.0, 1.0].
	Quantile float64 `protobuf:"fixed64,1,opt,name=quantile,proto3" json:"quantile,omitempty"`
	// The value at the given quantile of a distribution.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Represents the value at a given quantile of a distribution.

To record Min and Max values following conventions are used: - The 1.0 quantile is equivalent to the maximum value observed. - The 0.0 quantile is equivalent to the minimum value observed.

See the following issue for more context: https://github.com/open-telemetry/opentelemetry-proto/issues/125

func (*SummaryDataPoint_ValueAtQuantile) Descriptor deprecated added in v0.8.0 

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

Deprecated: Use SummaryDataPoint_ValueAtQuantile.ProtoReflect.Descriptor instead.

func (*SummaryDataPoint_ValueAtQuantile) GetQuantile added in v0.8.0 

func (x *SummaryDataPoint_ValueAtQuantile) GetQuantile() float64

func (*SummaryDataPoint_ValueAtQuantile) GetValue added in v0.8.0 

func (x *SummaryDataPoint_ValueAtQuantile) GetValue() float64

func (*SummaryDataPoint_ValueAtQuantile) ProtoMessage added in v0.8.0 

func (*SummaryDataPoint_ValueAtQuantile) ProtoMessage()

func (*SummaryDataPoint_ValueAtQuantile) ProtoReflect added in v0.8.0 

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

func (*SummaryDataPoint_ValueAtQuantile) Reset added in v0.8.0 

func (x *SummaryDataPoint_ValueAtQuantile) Reset()

func (*SummaryDataPoint_ValueAtQuantile) String added in v0.8.0 

func (x *SummaryDataPoint_ValueAtQuantile) 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.