v1

package
v0.54.0 Latest Latest
Warning

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

 Go to latest Published: Jun 22, 2022 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidLengthMetrics        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowMetrics          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupMetrics = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var AggregationTemporality_name = map[int32]string{
	0: "AGGREGATION_TEMPORALITY_UNSPECIFIED",
	1: "AGGREGATION_TEMPORALITY_DELTA",
	2: "AGGREGATION_TEMPORALITY_CUMULATIVE",
}
View Source 
var AggregationTemporality_value = map[string]int32{
	"AGGREGATION_TEMPORALITY_UNSPECIFIED": 0,
	"AGGREGATION_TEMPORALITY_DELTA":       1,
	"AGGREGATION_TEMPORALITY_CUMULATIVE":  2,
}
View Source 
var DataPointFlags_name = map[int32]string{
	0: "FLAG_NONE",
	1: "FLAG_NO_RECORDED_VALUE",
}
View Source 
var DataPointFlags_value = map[string]int32{
	"FLAG_NONE":              0,
	"FLAG_NO_RECORDED_VALUE": 1,
}

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) EnumDescriptor 

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

func (AggregationTemporality) String 

func (x AggregationTemporality) String() string

type DataPointFlags 

type DataPointFlags int32

DataPointFlags is defined as a protobuf 'uint32' type and is to be used as a bit-field representing 32 distinct boolean flags. Each flag defined in this enum is a bit-mask. To test the presence of a single flag in the flags of a data point, for example, use an expression like: 

(point.flags & FLAG_NO_RECORDED_VALUE) == FLAG_NO_RECORDED_VALUE

const (
	DataPointFlags_FLAG_NONE DataPointFlags = 0
	// This DataPoint is valid but has no recorded value.  This value
	// SHOULD be used to reflect explicitly missing data in a series, as
	// for an equivalent to the Prometheus "staleness marker".
	DataPointFlags_FLAG_NO_RECORDED_VALUE DataPointFlags = 1
)

func (DataPointFlags) EnumDescriptor 

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

func (DataPointFlags) String 

func (x DataPointFlags) String() string

type Exemplar 

type Exemplar struct {
	// The set of key/value pairs that were filtered out by the aggregator, but
	// recorded alongside the original measurement. Only key/value pairs that were
	// filtered out by the aggregator should be included
	FilteredAttributes []v11.KeyValue `protobuf:"bytes,7,rep,name=filtered_attributes,json=filteredAttributes,proto3" json:"filtered_attributes"`
	// 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"`
	// The 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 valid to be assigned 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 go_opentelemetry_io_collector_pdata_internal_data.SpanID `` /* 137-byte string literal not displayed */
	// (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 go_opentelemetry_io_collector_pdata_internal_data.TraceID `` /* 141-byte string literal not displayed */
}

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 

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

func (*Exemplar) GetAsDouble 

func (m *Exemplar) GetAsDouble() float64

func (*Exemplar) GetAsInt 

func (m *Exemplar) GetAsInt() int64

func (*Exemplar) GetFilteredAttributes 

func (m *Exemplar) GetFilteredAttributes() []v11.KeyValue

func (*Exemplar) GetTimeUnixNano 

func (m *Exemplar) GetTimeUnixNano() uint64

func (*Exemplar) GetValue 

func (m *Exemplar) GetValue() isExemplar_Value

func (*Exemplar) Marshal 

func (m *Exemplar) Marshal() (dAtA []byte, err error)

func (*Exemplar) MarshalTo 

func (m *Exemplar) MarshalTo(dAtA []byte) (int, error)

func (*Exemplar) MarshalToSizedBuffer 

func (m *Exemplar) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Exemplar) ProtoMessage 

func (*Exemplar) ProtoMessage()

func (*Exemplar) Reset 

func (m *Exemplar) Reset()

func (*Exemplar) Size 

func (m *Exemplar) Size() (n int)

func (*Exemplar) String 

func (m *Exemplar) String() string

func (*Exemplar) Unmarshal 

func (m *Exemplar) Unmarshal(dAtA []byte) error

func (*Exemplar) XXX_DiscardUnknown 

func (m *Exemplar) XXX_DiscardUnknown()

func (*Exemplar) XXX_Marshal 

func (m *Exemplar) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Exemplar) XXX_Merge 

func (m *Exemplar) XXX_Merge(src proto.Message)

func (*Exemplar) XXX_OneofWrappers 

func (*Exemplar) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Exemplar) XXX_Size 

func (m *Exemplar) XXX_Size() int

func (*Exemplar) XXX_Unmarshal 

func (m *Exemplar) XXX_Unmarshal(b []byte) error

type Exemplar_AsDouble 

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

func (*Exemplar_AsDouble) MarshalTo 

func (m *Exemplar_AsDouble) MarshalTo(dAtA []byte) (int, error)

func (*Exemplar_AsDouble) MarshalToSizedBuffer 

func (m *Exemplar_AsDouble) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Exemplar_AsDouble) Size 

func (m *Exemplar_AsDouble) Size() (n int)

type Exemplar_AsInt 

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

func (*Exemplar_AsInt) MarshalTo 

func (m *Exemplar_AsInt) MarshalTo(dAtA []byte) (int, error)

func (*Exemplar_AsInt) MarshalToSizedBuffer 

func (m *Exemplar_AsInt) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Exemplar_AsInt) Size 

func (m *Exemplar_AsInt) Size() (n int)

type ExponentialHistogram 

type ExponentialHistogram struct {
	DataPoints []*ExponentialHistogramDataPoint `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 */
}

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

func (*ExponentialHistogram) Descriptor 

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

func (*ExponentialHistogram) GetAggregationTemporality 

func (m *ExponentialHistogram) GetAggregationTemporality() AggregationTemporality

func (*ExponentialHistogram) GetDataPoints 

func (m *ExponentialHistogram) GetDataPoints() []*ExponentialHistogramDataPoint

func (*ExponentialHistogram) Marshal 

func (m *ExponentialHistogram) Marshal() (dAtA []byte, err error)

func (*ExponentialHistogram) MarshalTo 

func (m *ExponentialHistogram) MarshalTo(dAtA []byte) (int, error)

func (*ExponentialHistogram) MarshalToSizedBuffer 

func (m *ExponentialHistogram) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExponentialHistogram) ProtoMessage 

func (*ExponentialHistogram) ProtoMessage()

func (*ExponentialHistogram) Reset 

func (m *ExponentialHistogram) Reset()

func (*ExponentialHistogram) Size 

func (m *ExponentialHistogram) Size() (n int)

func (*ExponentialHistogram) String 

func (m *ExponentialHistogram) String() string

func (*ExponentialHistogram) Unmarshal 

func (m *ExponentialHistogram) Unmarshal(dAtA []byte) error

func (*ExponentialHistogram) XXX_DiscardUnknown 

func (m *ExponentialHistogram) XXX_DiscardUnknown()

func (*ExponentialHistogram) XXX_Marshal 

func (m *ExponentialHistogram) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExponentialHistogram) XXX_Merge 

func (m *ExponentialHistogram) XXX_Merge(src proto.Message)

func (*ExponentialHistogram) XXX_Size 

func (m *ExponentialHistogram) XXX_Size() int

func (*ExponentialHistogram) XXX_Unmarshal 

func (m *ExponentialHistogram) XXX_Unmarshal(b []byte) error

type ExponentialHistogramDataPoint 

type ExponentialHistogramDataPoint struct {
	// The set of key/value pairs that uniquely identify the timeseries from
	// where this point belongs. The list may be empty (may contain 0 elements).
	// Attribute keys MUST be unique (it is not allowed to have more than one
	// attribute with the same key).
	Attributes []v11.KeyValue `protobuf:"bytes,1,rep,name=attributes,proto3" json:"attributes"`
	// StartTimeUnixNano is optional but strongly encouraged, see the
	// the detailed comments above Metric.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// TimeUnixNano is required, see the detailed comments above Metric.
	//
	// 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 "bucket_counts"
	// values in the positive and negative Buckets plus the "zero_count" field.
	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.
	//
	// Note: Sum should only be filled out when measuring non-negative discrete
	// events, and is assumed to be monotonic over the values of these events.
	// Negative events *can* be recorded, but sum should not be filled out when
	// doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
	// see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram
	//
	// Types that are valid to be assigned to Sum_:
	//	*ExponentialHistogramDataPoint_Sum
	Sum_ isExponentialHistogramDataPoint_Sum_ `protobuf_oneof:"sum_"`
	// scale describes the resolution of the histogram.  Boundaries are
	// located at powers of the base, where:
	//
	//   base = (2^(2^-scale))
	//
	// The histogram bucket identified by `index`, a signed integer,
	// contains values that are greater than or equal to (base^index) and
	// less than (base^(index+1)).
	//
	// The positive and negative ranges of the histogram are expressed
	// separately.  Negative values are mapped by their absolute value
	// into the negative range using the same scale as the positive range.
	//
	// scale is not restricted by the protocol, as the permissible
	// values depend on the range of the data.
	Scale int32 `protobuf:"zigzag32,6,opt,name=scale,proto3" json:"scale,omitempty"`
	// zero_count is the count of values that are either exactly zero or
	// within the region considered zero by the instrumentation at the
	// tolerated degree of precision.  This bucket stores values that
	// cannot be expressed using the standard exponential formula as
	// well as values that have been rounded to zero.
	//
	// Implementations MAY consider the zero bucket to have probability
	// mass equal to (zero_count / count).
	ZeroCount uint64 `protobuf:"fixed64,7,opt,name=zero_count,json=zeroCount,proto3" json:"zero_count,omitempty"`
	// positive carries the positive range of exponential bucket counts.
	Positive ExponentialHistogramDataPoint_Buckets `protobuf:"bytes,8,opt,name=positive,proto3" json:"positive"`
	// negative carries the negative range of exponential bucket counts.
	Negative ExponentialHistogramDataPoint_Buckets `protobuf:"bytes,9,opt,name=negative,proto3" json:"negative"`
	// Flags that apply to this specific data point.  See DataPointFlags
	// for the available flags and their meaning.
	Flags uint32 `protobuf:"varint,10,opt,name=flags,proto3" json:"flags,omitempty"`
	// (Optional) List of exemplars collected from
	// measurements that were used to form the data point
	Exemplars []Exemplar `protobuf:"bytes,11,rep,name=exemplars,proto3" json:"exemplars"`
	// min is the minimum value over (start_time, end_time].
	//
	// Types that are valid to be assigned to Min_:
	//	*ExponentialHistogramDataPoint_Min
	Min_ isExponentialHistogramDataPoint_Min_ `protobuf_oneof:"min_"`
	// max is the maximum value over (start_time, end_time].
	//
	// Types that are valid to be assigned to Max_:
	//	*ExponentialHistogramDataPoint_Max
	Max_ isExponentialHistogramDataPoint_Max_ `protobuf_oneof:"max_"`
}

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

func (*ExponentialHistogramDataPoint) Descriptor 

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

func (*ExponentialHistogramDataPoint) GetAttributes 

func (m *ExponentialHistogramDataPoint) GetAttributes() []v11.KeyValue

func (*ExponentialHistogramDataPoint) GetCount 

func (m *ExponentialHistogramDataPoint) GetCount() uint64

func (*ExponentialHistogramDataPoint) GetExemplars 

func (m *ExponentialHistogramDataPoint) GetExemplars() []Exemplar

func (*ExponentialHistogramDataPoint) GetFlags 

func (m *ExponentialHistogramDataPoint) GetFlags() uint32

func (*ExponentialHistogramDataPoint) GetMax added in v0.52.0 

func (m *ExponentialHistogramDataPoint) GetMax() float64

func (*ExponentialHistogramDataPoint) GetMax_ added in v0.52.0 

func (m *ExponentialHistogramDataPoint) GetMax_() isExponentialHistogramDataPoint_Max_

func (*ExponentialHistogramDataPoint) GetMin added in v0.52.0 

func (m *ExponentialHistogramDataPoint) GetMin() float64

func (*ExponentialHistogramDataPoint) GetMin_ added in v0.52.0 

func (m *ExponentialHistogramDataPoint) GetMin_() isExponentialHistogramDataPoint_Min_

func (*ExponentialHistogramDataPoint) GetNegative 

func (m *ExponentialHistogramDataPoint) GetNegative() ExponentialHistogramDataPoint_Buckets

func (*ExponentialHistogramDataPoint) GetPositive 

func (m *ExponentialHistogramDataPoint) GetPositive() ExponentialHistogramDataPoint_Buckets

func (*ExponentialHistogramDataPoint) GetScale 

func (m *ExponentialHistogramDataPoint) GetScale() int32

func (*ExponentialHistogramDataPoint) GetStartTimeUnixNano 

func (m *ExponentialHistogramDataPoint) GetStartTimeUnixNano() uint64

func (*ExponentialHistogramDataPoint) GetSum 

func (m *ExponentialHistogramDataPoint) GetSum() float64

func (*ExponentialHistogramDataPoint) GetSum_ added in v0.54.0 

func (m *ExponentialHistogramDataPoint) GetSum_() isExponentialHistogramDataPoint_Sum_

func (*ExponentialHistogramDataPoint) GetTimeUnixNano 

func (m *ExponentialHistogramDataPoint) GetTimeUnixNano() uint64

func (*ExponentialHistogramDataPoint) GetZeroCount 

func (m *ExponentialHistogramDataPoint) GetZeroCount() uint64

func (*ExponentialHistogramDataPoint) Marshal 

func (m *ExponentialHistogramDataPoint) Marshal() (dAtA []byte, err error)

func (*ExponentialHistogramDataPoint) MarshalTo 

func (m *ExponentialHistogramDataPoint) MarshalTo(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint) MarshalToSizedBuffer 

func (m *ExponentialHistogramDataPoint) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint) ProtoMessage 

func (*ExponentialHistogramDataPoint) ProtoMessage()

func (*ExponentialHistogramDataPoint) Reset 

func (m *ExponentialHistogramDataPoint) Reset()

func (*ExponentialHistogramDataPoint) Size 

func (m *ExponentialHistogramDataPoint) Size() (n int)

func (*ExponentialHistogramDataPoint) String 

func (m *ExponentialHistogramDataPoint) String() string

func (*ExponentialHistogramDataPoint) Unmarshal 

func (m *ExponentialHistogramDataPoint) Unmarshal(dAtA []byte) error

func (*ExponentialHistogramDataPoint) XXX_DiscardUnknown 

func (m *ExponentialHistogramDataPoint) XXX_DiscardUnknown()

func (*ExponentialHistogramDataPoint) XXX_Marshal 

func (m *ExponentialHistogramDataPoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExponentialHistogramDataPoint) XXX_Merge 

func (m *ExponentialHistogramDataPoint) XXX_Merge(src proto.Message)

func (*ExponentialHistogramDataPoint) XXX_OneofWrappers added in v0.52.0 

func (*ExponentialHistogramDataPoint) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*ExponentialHistogramDataPoint) XXX_Size 

func (m *ExponentialHistogramDataPoint) XXX_Size() int

func (*ExponentialHistogramDataPoint) XXX_Unmarshal 

func (m *ExponentialHistogramDataPoint) XXX_Unmarshal(b []byte) error

type ExponentialHistogramDataPoint_Buckets 

type ExponentialHistogramDataPoint_Buckets struct {
	// Offset is the bucket index of the first entry in the bucket_counts array.
	//
	// Note: This uses a varint encoding as a simple form of compression.
	Offset int32 `protobuf:"zigzag32,1,opt,name=offset,proto3" json:"offset,omitempty"`
	// Count is an array of counts, where count[i] carries the count
	// of the bucket at index (offset+i).  count[i] is the count of
	// values greater than or equal to base^(offset+i) and less than
	// base^(offset+i+1).
	//
	// Note: By contrast, the explicit HistogramDataPoint uses
	// fixed64.  This field is expected to have many buckets,
	// especially zeros, so uint64 has been selected to ensure
	// varint encoding.
	BucketCounts []uint64 `protobuf:"varint,2,rep,packed,name=bucket_counts,json=bucketCounts,proto3" json:"bucket_counts,omitempty"`
}

Buckets are a set of bucket counts, encoded in a contiguous array of counts.

func (*ExponentialHistogramDataPoint_Buckets) Descriptor 

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

func (*ExponentialHistogramDataPoint_Buckets) GetBucketCounts 

func (m *ExponentialHistogramDataPoint_Buckets) GetBucketCounts() []uint64

func (*ExponentialHistogramDataPoint_Buckets) GetOffset 

func (m *ExponentialHistogramDataPoint_Buckets) GetOffset() int32

func (*ExponentialHistogramDataPoint_Buckets) Marshal 

func (m *ExponentialHistogramDataPoint_Buckets) Marshal() (dAtA []byte, err error)

func (*ExponentialHistogramDataPoint_Buckets) MarshalTo 

func (m *ExponentialHistogramDataPoint_Buckets) MarshalTo(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Buckets) MarshalToSizedBuffer 

func (m *ExponentialHistogramDataPoint_Buckets) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Buckets) ProtoMessage 

func (*ExponentialHistogramDataPoint_Buckets) ProtoMessage()

func (*ExponentialHistogramDataPoint_Buckets) Reset 

func (m *ExponentialHistogramDataPoint_Buckets) Reset()

func (*ExponentialHistogramDataPoint_Buckets) Size 

func (m *ExponentialHistogramDataPoint_Buckets) Size() (n int)

func (*ExponentialHistogramDataPoint_Buckets) String 

func (m *ExponentialHistogramDataPoint_Buckets) String() string

func (*ExponentialHistogramDataPoint_Buckets) Unmarshal 

func (m *ExponentialHistogramDataPoint_Buckets) Unmarshal(dAtA []byte) error

func (*ExponentialHistogramDataPoint_Buckets) XXX_DiscardUnknown 

func (m *ExponentialHistogramDataPoint_Buckets) XXX_DiscardUnknown()

func (*ExponentialHistogramDataPoint_Buckets) XXX_Marshal 

func (m *ExponentialHistogramDataPoint_Buckets) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ExponentialHistogramDataPoint_Buckets) XXX_Merge 

func (m *ExponentialHistogramDataPoint_Buckets) XXX_Merge(src proto.Message)

func (*ExponentialHistogramDataPoint_Buckets) XXX_Size 

func (m *ExponentialHistogramDataPoint_Buckets) XXX_Size() int

func (*ExponentialHistogramDataPoint_Buckets) XXX_Unmarshal 

func (m *ExponentialHistogramDataPoint_Buckets) XXX_Unmarshal(b []byte) error

type ExponentialHistogramDataPoint_Max added in v0.52.0 

type ExponentialHistogramDataPoint_Max struct {
	Max float64 `protobuf:"fixed64,13,opt,name=max,proto3,oneof" json:"max,omitempty"`
}

func (*ExponentialHistogramDataPoint_Max) MarshalTo added in v0.52.0 

func (m *ExponentialHistogramDataPoint_Max) MarshalTo(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Max) MarshalToSizedBuffer added in v0.52.0 

func (m *ExponentialHistogramDataPoint_Max) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Max) Size added in v0.52.0 

func (m *ExponentialHistogramDataPoint_Max) Size() (n int)

type ExponentialHistogramDataPoint_Min added in v0.52.0 

type ExponentialHistogramDataPoint_Min struct {
	Min float64 `protobuf:"fixed64,12,opt,name=min,proto3,oneof" json:"min,omitempty"`
}

func (*ExponentialHistogramDataPoint_Min) MarshalTo added in v0.52.0 

func (m *ExponentialHistogramDataPoint_Min) MarshalTo(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Min) MarshalToSizedBuffer added in v0.52.0 

func (m *ExponentialHistogramDataPoint_Min) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Min) Size added in v0.52.0 

func (m *ExponentialHistogramDataPoint_Min) Size() (n int)

type ExponentialHistogramDataPoint_Sum added in v0.54.0 

type ExponentialHistogramDataPoint_Sum struct {
	Sum float64 `protobuf:"fixed64,5,opt,name=sum,proto3,oneof" json:"sum,omitempty"`
}

func (*ExponentialHistogramDataPoint_Sum) MarshalTo added in v0.54.0 

func (m *ExponentialHistogramDataPoint_Sum) MarshalTo(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Sum) MarshalToSizedBuffer added in v0.54.0 

func (m *ExponentialHistogramDataPoint_Sum) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ExponentialHistogramDataPoint_Sum) Size added in v0.54.0 

func (m *ExponentialHistogramDataPoint_Sum) Size() (n int)

type Gauge 

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

Gauge represents the type of a 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 

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

func (*Gauge) GetDataPoints 

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

func (*Gauge) Marshal 

func (m *Gauge) Marshal() (dAtA []byte, err error)

func (*Gauge) MarshalTo 

func (m *Gauge) MarshalTo(dAtA []byte) (int, error)

func (*Gauge) MarshalToSizedBuffer 

func (m *Gauge) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Gauge) ProtoMessage 

func (*Gauge) ProtoMessage()

func (*Gauge) Reset 

func (m *Gauge) Reset()

func (*Gauge) Size 

func (m *Gauge) Size() (n int)

func (*Gauge) String 

func (m *Gauge) String() string

func (*Gauge) Unmarshal 

func (m *Gauge) Unmarshal(dAtA []byte) error

func (*Gauge) XXX_DiscardUnknown 

func (m *Gauge) XXX_DiscardUnknown()

func (*Gauge) XXX_Marshal 

func (m *Gauge) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Gauge) XXX_Merge 

func (m *Gauge) XXX_Merge(src proto.Message)

func (*Gauge) XXX_Size 

func (m *Gauge) XXX_Size() int

func (*Gauge) XXX_Unmarshal 

func (m *Gauge) XXX_Unmarshal(b []byte) error

type Histogram 

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 */
}

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

func (*Histogram) Descriptor 

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

func (*Histogram) GetAggregationTemporality 

func (m *Histogram) GetAggregationTemporality() AggregationTemporality

func (*Histogram) GetDataPoints 

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

func (*Histogram) Marshal 

func (m *Histogram) Marshal() (dAtA []byte, err error)

func (*Histogram) MarshalTo 

func (m *Histogram) MarshalTo(dAtA []byte) (int, error)

func (*Histogram) MarshalToSizedBuffer 

func (m *Histogram) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Histogram) ProtoMessage 

func (*Histogram) ProtoMessage()

func (*Histogram) Reset 

func (m *Histogram) Reset()

func (*Histogram) Size 

func (m *Histogram) Size() (n int)

func (*Histogram) String 

func (m *Histogram) String() string

func (*Histogram) Unmarshal 

func (m *Histogram) Unmarshal(dAtA []byte) error

func (*Histogram) XXX_DiscardUnknown 

func (m *Histogram) XXX_DiscardUnknown()

func (*Histogram) XXX_Marshal 

func (m *Histogram) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Histogram) XXX_Merge 

func (m *Histogram) XXX_Merge(src proto.Message)

func (*Histogram) XXX_Size 

func (m *Histogram) XXX_Size() int

func (*Histogram) XXX_Unmarshal 

func (m *Histogram) XXX_Unmarshal(b []byte) error

type HistogramDataPoint 

type HistogramDataPoint struct {
	// The set of key/value pairs that uniquely identify the timeseries from
	// where this point belongs. The list may be empty (may contain 0 elements).
	// Attribute keys MUST be unique (it is not allowed to have more than one
	// attribute with the same key).
	Attributes []v11.KeyValue `protobuf:"bytes,9,rep,name=attributes,proto3" json:"attributes"`
	// StartTimeUnixNano is optional but strongly encouraged, see the
	// the detailed comments above Metric.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// TimeUnixNano is required, see the detailed comments above Metric.
	//
	// 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.
	//
	// Note: Sum should only be filled out when measuring non-negative discrete
	// events, and is assumed to be monotonic over the values of these events.
	// Negative events *can* be recorded, but sum should not be filled out when
	// doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
	// see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#histogram
	//
	// Types that are valid to be assigned to Sum_:
	//	*HistogramDataPoint_Sum
	Sum_ isHistogramDataPoint_Sum_ `protobuf_oneof:"sum_"`
	// 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.
	//
	// 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 < size(explicit_bounds)
	// (explicit_bounds[i-1], +infinity) for i == size(explicit_bounds)
	//
	// 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"`
	// Flags that apply to this specific data point.  See DataPointFlags
	// for the available flags and their meaning.
	Flags uint32 `protobuf:"varint,10,opt,name=flags,proto3" json:"flags,omitempty"`
	// min is the minimum value over (start_time, end_time].
	//
	// Types that are valid to be assigned to Min_:
	//	*HistogramDataPoint_Min
	Min_ isHistogramDataPoint_Min_ `protobuf_oneof:"min_"`
	// max is the maximum value over (start_time, end_time].
	//
	// Types that are valid to be assigned to Max_:
	//	*HistogramDataPoint_Max
	Max_ isHistogramDataPoint_Max_ `protobuf_oneof:"max_"`
}

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

If the histogram contains the distribution of values, then both "explicit_bounds" and "bucket counts" fields must be defined. If the histogram does not contain the distribution of values, then both "explicit_bounds" and "bucket_counts" must be omitted and only "count" and "sum" are known.

func (*HistogramDataPoint) Descriptor 

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

func (*HistogramDataPoint) GetAttributes 

func (m *HistogramDataPoint) GetAttributes() []v11.KeyValue

func (*HistogramDataPoint) GetBucketCounts 

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

func (*HistogramDataPoint) GetCount 

func (m *HistogramDataPoint) GetCount() uint64

func (*HistogramDataPoint) GetExemplars 

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

func (*HistogramDataPoint) GetExplicitBounds 

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

func (*HistogramDataPoint) GetFlags 

func (m *HistogramDataPoint) GetFlags() uint32

func (*HistogramDataPoint) GetMax added in v0.52.0 

func (m *HistogramDataPoint) GetMax() float64

func (*HistogramDataPoint) GetMax_ added in v0.52.0 

func (m *HistogramDataPoint) GetMax_() isHistogramDataPoint_Max_

func (*HistogramDataPoint) GetMin added in v0.52.0 

func (m *HistogramDataPoint) GetMin() float64

func (*HistogramDataPoint) GetMin_ added in v0.52.0 

func (m *HistogramDataPoint) GetMin_() isHistogramDataPoint_Min_

func (*HistogramDataPoint) GetStartTimeUnixNano 

func (m *HistogramDataPoint) GetStartTimeUnixNano() uint64

func (*HistogramDataPoint) GetSum 

func (m *HistogramDataPoint) GetSum() float64

func (*HistogramDataPoint) GetSum_ 

func (m *HistogramDataPoint) GetSum_() isHistogramDataPoint_Sum_

func (*HistogramDataPoint) GetTimeUnixNano 

func (m *HistogramDataPoint) GetTimeUnixNano() uint64

func (*HistogramDataPoint) Marshal 

func (m *HistogramDataPoint) Marshal() (dAtA []byte, err error)

func (*HistogramDataPoint) MarshalTo 

func (m *HistogramDataPoint) MarshalTo(dAtA []byte) (int, error)

func (*HistogramDataPoint) MarshalToSizedBuffer 

func (m *HistogramDataPoint) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HistogramDataPoint) ProtoMessage 

func (*HistogramDataPoint) ProtoMessage()

func (*HistogramDataPoint) Reset 

func (m *HistogramDataPoint) Reset()

func (*HistogramDataPoint) Size 

func (m *HistogramDataPoint) Size() (n int)

func (*HistogramDataPoint) String 

func (m *HistogramDataPoint) String() string

func (*HistogramDataPoint) Unmarshal 

func (m *HistogramDataPoint) Unmarshal(dAtA []byte) error

func (*HistogramDataPoint) XXX_DiscardUnknown 

func (m *HistogramDataPoint) XXX_DiscardUnknown()

func (*HistogramDataPoint) XXX_Marshal 

func (m *HistogramDataPoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*HistogramDataPoint) XXX_Merge 

func (m *HistogramDataPoint) XXX_Merge(src proto.Message)

func (*HistogramDataPoint) XXX_OneofWrappers 

func (*HistogramDataPoint) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*HistogramDataPoint) XXX_Size 

func (m *HistogramDataPoint) XXX_Size() int

func (*HistogramDataPoint) XXX_Unmarshal 

func (m *HistogramDataPoint) XXX_Unmarshal(b []byte) error

type HistogramDataPoint_Max added in v0.52.0 

type HistogramDataPoint_Max struct {
	Max float64 `protobuf:"fixed64,12,opt,name=max,proto3,oneof" json:"max,omitempty"`
}

func (*HistogramDataPoint_Max) MarshalTo added in v0.52.0 

func (m *HistogramDataPoint_Max) MarshalTo(dAtA []byte) (int, error)

func (*HistogramDataPoint_Max) MarshalToSizedBuffer added in v0.52.0 

func (m *HistogramDataPoint_Max) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HistogramDataPoint_Max) Size added in v0.52.0 

func (m *HistogramDataPoint_Max) Size() (n int)

type HistogramDataPoint_Min added in v0.52.0 

type HistogramDataPoint_Min struct {
	Min float64 `protobuf:"fixed64,11,opt,name=min,proto3,oneof" json:"min,omitempty"`
}

func (*HistogramDataPoint_Min) MarshalTo added in v0.52.0 

func (m *HistogramDataPoint_Min) MarshalTo(dAtA []byte) (int, error)

func (*HistogramDataPoint_Min) MarshalToSizedBuffer added in v0.52.0 

func (m *HistogramDataPoint_Min) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HistogramDataPoint_Min) Size added in v0.52.0 

func (m *HistogramDataPoint_Min) Size() (n int)

type HistogramDataPoint_Sum 

type HistogramDataPoint_Sum struct {
	Sum float64 `protobuf:"fixed64,5,opt,name=sum,proto3,oneof" json:"sum,omitempty"`
}

func (*HistogramDataPoint_Sum) MarshalTo 

func (m *HistogramDataPoint_Sum) MarshalTo(dAtA []byte) (int, error)

func (*HistogramDataPoint_Sum) MarshalToSizedBuffer 

func (m *HistogramDataPoint_Sum) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*HistogramDataPoint_Sum) Size 

func (m *HistogramDataPoint_Sum) Size() (n int)

type InstrumentationLibraryMetrics deprecated 

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 `protobuf:"bytes,1,opt,name=instrumentation_library,json=instrumentationLibrary,proto3" json:"instrumentation_library"`
	// A list of metrics that originate from an instrumentation library.
	Metrics []*Metric `protobuf:"bytes,2,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// This schema_url applies to all metrics in the "metrics" field.
	SchemaUrl string `protobuf:"bytes,3,opt,name=schema_url,json=schemaUrl,proto3" json:"schema_url,omitempty"`
}

A collection of Metrics produced by an InstrumentationLibrary. InstrumentationLibraryMetrics is wire-compatible with ScopeMetrics for binary Protobuf format. This message is deprecated and will be removed on June 15, 2022.

Deprecated: Do not use.

func (*InstrumentationLibraryMetrics) Descriptor 

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

func (*InstrumentationLibraryMetrics) GetInstrumentationLibrary 

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

func (*InstrumentationLibraryMetrics) GetMetrics 

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

func (*InstrumentationLibraryMetrics) GetSchemaUrl 

func (m *InstrumentationLibraryMetrics) GetSchemaUrl() string

func (*InstrumentationLibraryMetrics) Marshal 

func (m *InstrumentationLibraryMetrics) Marshal() (dAtA []byte, err error)

func (*InstrumentationLibraryMetrics) MarshalTo 

func (m *InstrumentationLibraryMetrics) MarshalTo(dAtA []byte) (int, error)

func (*InstrumentationLibraryMetrics) MarshalToSizedBuffer 

func (m *InstrumentationLibraryMetrics) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*InstrumentationLibraryMetrics) ProtoMessage 

func (*InstrumentationLibraryMetrics) ProtoMessage()

func (*InstrumentationLibraryMetrics) Reset 

func (m *InstrumentationLibraryMetrics) Reset()

func (*InstrumentationLibraryMetrics) Size 

func (m *InstrumentationLibraryMetrics) Size() (n int)

func (*InstrumentationLibraryMetrics) String 

func (m *InstrumentationLibraryMetrics) String() string

func (*InstrumentationLibraryMetrics) Unmarshal 

func (m *InstrumentationLibraryMetrics) Unmarshal(dAtA []byte) error

func (*InstrumentationLibraryMetrics) XXX_DiscardUnknown 

func (m *InstrumentationLibraryMetrics) XXX_DiscardUnknown()

func (*InstrumentationLibraryMetrics) XXX_Marshal 

func (m *InstrumentationLibraryMetrics) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*InstrumentationLibraryMetrics) XXX_Merge 

func (m *InstrumentationLibraryMetrics) XXX_Merge(src proto.Message)

func (*InstrumentationLibraryMetrics) XXX_Size 

func (m *InstrumentationLibraryMetrics) XXX_Size() int

func (*InstrumentationLibraryMetrics) XXX_Unmarshal 

func (m *InstrumentationLibraryMetrics) XXX_Unmarshal(b []byte) error

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 valid to be assigned to Data:
	//	*Metric_Gauge
	//	*Metric_Sum
	//	*Metric_Histogram
	//	*Metric_ExponentialHistogram
	//	*Metric_Summary
	Data isMetric_Data `protobuf_oneof:"data"`
}

Defines a Metric which has one or more timeseries. The following is a brief summary of the Metric data model. For more details, see: 

https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/datamodel.md

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 (Sum, Gauge, Histogram, Summary).

  • DataPoint contains timestamps, attributes, 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| | |+-----+ | +---------------------------+

Each distinct type of DataPoint represents the output of a specific aggregation function, the result of applying the DataPoint's associated function of to one or more measurements.

All DataPoint types have three common fields:

  • Attributes includes key-value pairs associated with the data point
  • TimeUnixNano is required, set to the end time of the aggregation
  • StartTimeUnixNano is optional, but strongly encouraged for DataPoints having an AggregationTemporality field, as discussed below.

Both TimeUnixNano and StartTimeUnixNano values are expressed as UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

TimeUnixNano

This field is required, having consistent interpretation across DataPoint types. TimeUnixNano is the moment corresponding to when the data point's aggregate value was captured.

Data points with the 0 value for TimeUnixNano SHOULD be rejected by consumers.

StartTimeUnixNano

StartTimeUnixNano in general allows detecting when a sequence of observations is unbroken. This field indicates to consumers the start time for points with cumulative and delta AggregationTemporality, and it should be included whenever possible to support correct rate calculation. Although it may be omitted when the start time is truly unknown, setting StartTimeUnixNano is strongly encouraged.

func (*Metric) Descriptor 

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

func (*Metric) GetData 

func (m *Metric) GetData() isMetric_Data

func (*Metric) GetDescription 

func (m *Metric) GetDescription() string

func (*Metric) GetExponentialHistogram 

func (m *Metric) GetExponentialHistogram() *ExponentialHistogram

func (*Metric) GetGauge 

func (m *Metric) GetGauge() *Gauge

func (*Metric) GetHistogram 

func (m *Metric) GetHistogram() *Histogram

func (*Metric) GetName 

func (m *Metric) GetName() string

func (*Metric) GetSum 

func (m *Metric) GetSum() *Sum

func (*Metric) GetSummary 

func (m *Metric) GetSummary() *Summary

func (*Metric) GetUnit 

func (m *Metric) GetUnit() string

func (*Metric) Marshal 

func (m *Metric) Marshal() (dAtA []byte, err error)

func (*Metric) MarshalTo 

func (m *Metric) MarshalTo(dAtA []byte) (int, error)

func (*Metric) MarshalToSizedBuffer 

func (m *Metric) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Metric) ProtoMessage 

func (*Metric) ProtoMessage()

func (*Metric) Reset 

func (m *Metric) Reset()

func (*Metric) Size 

func (m *Metric) Size() (n int)

func (*Metric) String 

func (m *Metric) String() string

func (*Metric) Unmarshal 

func (m *Metric) Unmarshal(dAtA []byte) error

func (*Metric) XXX_DiscardUnknown 

func (m *Metric) XXX_DiscardUnknown()

func (*Metric) XXX_Marshal 

func (m *Metric) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Metric) XXX_Merge 

func (m *Metric) XXX_Merge(src proto.Message)

func (*Metric) XXX_OneofWrappers 

func (*Metric) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*Metric) XXX_Size 

func (m *Metric) XXX_Size() int

func (*Metric) XXX_Unmarshal 

func (m *Metric) XXX_Unmarshal(b []byte) error

type Metric_ExponentialHistogram 

type Metric_ExponentialHistogram struct {
	ExponentialHistogram *ExponentialHistogram `` /* 128-byte string literal not displayed */
}

func (*Metric_ExponentialHistogram) MarshalTo 

func (m *Metric_ExponentialHistogram) MarshalTo(dAtA []byte) (int, error)

func (*Metric_ExponentialHistogram) MarshalToSizedBuffer 

func (m *Metric_ExponentialHistogram) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Metric_ExponentialHistogram) Size 

func (m *Metric_ExponentialHistogram) Size() (n int)

type Metric_Gauge 

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

func (*Metric_Gauge) MarshalTo 

func (m *Metric_Gauge) MarshalTo(dAtA []byte) (int, error)

func (*Metric_Gauge) MarshalToSizedBuffer 

func (m *Metric_Gauge) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Metric_Gauge) Size 

func (m *Metric_Gauge) Size() (n int)

type Metric_Histogram 

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

func (*Metric_Histogram) MarshalTo 

func (m *Metric_Histogram) MarshalTo(dAtA []byte) (int, error)

func (*Metric_Histogram) MarshalToSizedBuffer 

func (m *Metric_Histogram) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Metric_Histogram) Size 

func (m *Metric_Histogram) Size() (n int)

type Metric_Sum 

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

func (*Metric_Sum) MarshalTo 

func (m *Metric_Sum) MarshalTo(dAtA []byte) (int, error)

func (*Metric_Sum) MarshalToSizedBuffer 

func (m *Metric_Sum) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Metric_Sum) Size 

func (m *Metric_Sum) Size() (n int)

type Metric_Summary 

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

func (*Metric_Summary) MarshalTo 

func (m *Metric_Summary) MarshalTo(dAtA []byte) (int, error)

func (*Metric_Summary) MarshalToSizedBuffer 

func (m *Metric_Summary) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Metric_Summary) Size 

func (m *Metric_Summary) Size() (n int)

type MetricsData 

type MetricsData struct {
	// An array of ResourceMetrics.
	// For data coming from a single resource this array will typically contain
	// one element. Intermediary nodes that receive data from multiple origins
	// typically batch the data before forwarding further and in that case this
	// array will contain multiple elements.
	ResourceMetrics []*ResourceMetrics `protobuf:"bytes,1,rep,name=resource_metrics,json=resourceMetrics,proto3" json:"resource_metrics,omitempty"`
}

MetricsData represents the metrics data that can be stored in a persistent storage, OR can be embedded by other protocols that transfer OTLP metrics data but do not implement the OTLP protocol.

The main difference between this message and collector protocol is that in this message there will not be any "control" or "metadata" specific to OTLP protocol.

When new fields are added into this message, the OTLP request MUST be updated as well.

func (*MetricsData) Descriptor 

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

func (*MetricsData) GetResourceMetrics 

func (m *MetricsData) GetResourceMetrics() []*ResourceMetrics

func (*MetricsData) Marshal 

func (m *MetricsData) Marshal() (dAtA []byte, err error)

func (*MetricsData) MarshalTo 

func (m *MetricsData) MarshalTo(dAtA []byte) (int, error)

func (*MetricsData) MarshalToSizedBuffer 

func (m *MetricsData) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*MetricsData) ProtoMessage 

func (*MetricsData) ProtoMessage()

func (*MetricsData) Reset 

func (m *MetricsData) Reset()

func (*MetricsData) Size 

func (m *MetricsData) Size() (n int)

func (*MetricsData) String 

func (m *MetricsData) String() string

func (*MetricsData) Unmarshal 

func (m *MetricsData) Unmarshal(dAtA []byte) error

func (*MetricsData) XXX_DiscardUnknown 

func (m *MetricsData) XXX_DiscardUnknown()

func (*MetricsData) XXX_Marshal 

func (m *MetricsData) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*MetricsData) XXX_Merge 

func (m *MetricsData) XXX_Merge(src proto.Message)

func (*MetricsData) XXX_Size 

func (m *MetricsData) XXX_Size() int

func (*MetricsData) XXX_Unmarshal 

func (m *MetricsData) XXX_Unmarshal(b []byte) error

type NumberDataPoint 

type NumberDataPoint struct {
	// The set of key/value pairs that uniquely identify the timeseries from
	// where this point belongs. The list may be empty (may contain 0 elements).
	// Attribute keys MUST be unique (it is not allowed to have more than one
	// attribute with the same key).
	Attributes []v11.KeyValue `protobuf:"bytes,7,rep,name=attributes,proto3" json:"attributes"`
	// StartTimeUnixNano is optional but strongly encouraged, see the
	// the detailed comments above Metric.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// TimeUnixNano is required, see the detailed comments above Metric.
	//
	// 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 valid to be assigned 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"`
	// Flags that apply to this specific data point.  See DataPointFlags
	// for the available flags and their meaning.
	Flags uint32 `protobuf:"varint,8,opt,name=flags,proto3" json:"flags,omitempty"`
}

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

func (*NumberDataPoint) Descriptor 

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

func (*NumberDataPoint) GetAsDouble 

func (m *NumberDataPoint) GetAsDouble() float64

func (*NumberDataPoint) GetAsInt 

func (m *NumberDataPoint) GetAsInt() int64

func (*NumberDataPoint) GetAttributes 

func (m *NumberDataPoint) GetAttributes() []v11.KeyValue

func (*NumberDataPoint) GetExemplars 

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

func (*NumberDataPoint) GetFlags 

func (m *NumberDataPoint) GetFlags() uint32

func (*NumberDataPoint) GetStartTimeUnixNano 

func (m *NumberDataPoint) GetStartTimeUnixNano() uint64

func (*NumberDataPoint) GetTimeUnixNano 

func (m *NumberDataPoint) GetTimeUnixNano() uint64

func (*NumberDataPoint) GetValue 

func (m *NumberDataPoint) GetValue() isNumberDataPoint_Value

func (*NumberDataPoint) Marshal 

func (m *NumberDataPoint) Marshal() (dAtA []byte, err error)

func (*NumberDataPoint) MarshalTo 

func (m *NumberDataPoint) MarshalTo(dAtA []byte) (int, error)

func (*NumberDataPoint) MarshalToSizedBuffer 

func (m *NumberDataPoint) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*NumberDataPoint) ProtoMessage 

func (*NumberDataPoint) ProtoMessage()

func (*NumberDataPoint) Reset 

func (m *NumberDataPoint) Reset()

func (*NumberDataPoint) Size 

func (m *NumberDataPoint) Size() (n int)

func (*NumberDataPoint) String 

func (m *NumberDataPoint) String() string

func (*NumberDataPoint) Unmarshal 

func (m *NumberDataPoint) Unmarshal(dAtA []byte) error

func (*NumberDataPoint) XXX_DiscardUnknown 

func (m *NumberDataPoint) XXX_DiscardUnknown()

func (*NumberDataPoint) XXX_Marshal 

func (m *NumberDataPoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*NumberDataPoint) XXX_Merge 

func (m *NumberDataPoint) XXX_Merge(src proto.Message)

func (*NumberDataPoint) XXX_OneofWrappers 

func (*NumberDataPoint) XXX_OneofWrappers() []interface{}

XXX_OneofWrappers is for the internal use of the proto package.

func (*NumberDataPoint) XXX_Size 

func (m *NumberDataPoint) XXX_Size() int

func (*NumberDataPoint) XXX_Unmarshal 

func (m *NumberDataPoint) XXX_Unmarshal(b []byte) error

type NumberDataPoint_AsDouble 

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

func (*NumberDataPoint_AsDouble) MarshalTo 

func (m *NumberDataPoint_AsDouble) MarshalTo(dAtA []byte) (int, error)

func (*NumberDataPoint_AsDouble) MarshalToSizedBuffer 

func (m *NumberDataPoint_AsDouble) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*NumberDataPoint_AsDouble) Size 

func (m *NumberDataPoint_AsDouble) Size() (n int)

type NumberDataPoint_AsInt 

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

func (*NumberDataPoint_AsInt) MarshalTo 

func (m *NumberDataPoint_AsInt) MarshalTo(dAtA []byte) (int, error)

func (*NumberDataPoint_AsInt) MarshalToSizedBuffer 

func (m *NumberDataPoint_AsInt) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*NumberDataPoint_AsInt) Size 

func (m *NumberDataPoint_AsInt) Size() (n int)

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"`
	// A list of metrics that originate from a resource.
	ScopeMetrics []*ScopeMetrics `protobuf:"bytes,2,rep,name=scope_metrics,json=scopeMetrics,proto3" json:"scope_metrics,omitempty"`
	// A list of InstrumentationLibraryMetrics that originate from a resource.
	// This field is deprecated and will be removed after grace period expires on June 15, 2022.
	//
	// During the grace period the following rules SHOULD be followed:
	//
	// For Binary Protobufs
	// ====================
	// Binary Protobuf senders SHOULD NOT set instrumentation_library_metrics. Instead
	// scope_metrics SHOULD be set.
	//
	// Binary Protobuf receivers SHOULD check if instrumentation_library_metrics is set
	// and scope_metrics is not set then the value in instrumentation_library_metrics
	// SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
	// If scope_metrics is set then instrumentation_library_metrics SHOULD be ignored.
	//
	// For JSON
	// ========
	// JSON senders that set instrumentation_library_metrics field MAY also set
	// scope_metrics to carry the same metrics, essentially double-publishing the same data.
	// Such double-publishing MAY be controlled by a user-settable option.
	// If double-publishing is not used then the senders SHOULD set scope_metrics and
	// SHOULD NOT set instrumentation_library_metrics.
	//
	// JSON receivers SHOULD check if instrumentation_library_metrics is set and
	// scope_metrics is not set then the value in instrumentation_library_metrics
	// SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
	// If scope_metrics is set then instrumentation_library_metrics field SHOULD be ignored.
	InstrumentationLibraryMetrics []*InstrumentationLibraryMetrics `` // Deprecated: Do not use.
	/* 153-byte string literal not displayed */
	// This schema_url applies to the data in the "resource" field. It does not apply
	// to the data in the "scope_metrics" field which have their own schema_url field.
	SchemaUrl string `protobuf:"bytes,3,opt,name=schema_url,json=schemaUrl,proto3" json:"schema_url,omitempty"`
}

A collection of ScopeMetrics from a Resource.

func (*ResourceMetrics) Descriptor 

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

func (*ResourceMetrics) GetInstrumentationLibraryMetrics deprecated 

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

Deprecated: Do not use.

func (*ResourceMetrics) GetResource 

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

func (*ResourceMetrics) GetSchemaUrl 

func (m *ResourceMetrics) GetSchemaUrl() string

func (*ResourceMetrics) GetScopeMetrics 

func (m *ResourceMetrics) GetScopeMetrics() []*ScopeMetrics

func (*ResourceMetrics) Marshal 

func (m *ResourceMetrics) Marshal() (dAtA []byte, err error)

func (*ResourceMetrics) MarshalTo 

func (m *ResourceMetrics) MarshalTo(dAtA []byte) (int, error)

func (*ResourceMetrics) MarshalToSizedBuffer 

func (m *ResourceMetrics) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ResourceMetrics) ProtoMessage 

func (*ResourceMetrics) ProtoMessage()

func (*ResourceMetrics) Reset 

func (m *ResourceMetrics) Reset()

func (*ResourceMetrics) Size 

func (m *ResourceMetrics) Size() (n int)

func (*ResourceMetrics) String 

func (m *ResourceMetrics) String() string

func (*ResourceMetrics) Unmarshal 

func (m *ResourceMetrics) Unmarshal(dAtA []byte) error

func (*ResourceMetrics) XXX_DiscardUnknown 

func (m *ResourceMetrics) XXX_DiscardUnknown()

func (*ResourceMetrics) XXX_Marshal 

func (m *ResourceMetrics) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ResourceMetrics) XXX_Merge 

func (m *ResourceMetrics) XXX_Merge(src proto.Message)

func (*ResourceMetrics) XXX_Size 

func (m *ResourceMetrics) XXX_Size() int

func (*ResourceMetrics) XXX_Unmarshal 

func (m *ResourceMetrics) XXX_Unmarshal(b []byte) error

type ScopeMetrics 

type ScopeMetrics struct {
	// The instrumentation scope information for the metrics in this message.
	// Semantically when InstrumentationScope isn't set, it is equivalent with
	// an empty instrumentation scope name (unknown).
	Scope v11.InstrumentationScope `protobuf:"bytes,1,opt,name=scope,proto3" json:"scope"`
	// A list of metrics that originate from an instrumentation library.
	Metrics []*Metric `protobuf:"bytes,2,rep,name=metrics,proto3" json:"metrics,omitempty"`
	// This schema_url applies to all metrics in the "metrics" field.
	SchemaUrl string `protobuf:"bytes,3,opt,name=schema_url,json=schemaUrl,proto3" json:"schema_url,omitempty"`
}

A collection of Metrics produced by an Scope.

func (*ScopeMetrics) Descriptor 

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

func (*ScopeMetrics) GetMetrics 

func (m *ScopeMetrics) GetMetrics() []*Metric

func (*ScopeMetrics) GetSchemaUrl 

func (m *ScopeMetrics) GetSchemaUrl() string

func (*ScopeMetrics) GetScope 

func (m *ScopeMetrics) GetScope() v11.InstrumentationScope

func (*ScopeMetrics) Marshal 

func (m *ScopeMetrics) Marshal() (dAtA []byte, err error)

func (*ScopeMetrics) MarshalTo 

func (m *ScopeMetrics) MarshalTo(dAtA []byte) (int, error)

func (*ScopeMetrics) MarshalToSizedBuffer 

func (m *ScopeMetrics) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*ScopeMetrics) ProtoMessage 

func (*ScopeMetrics) ProtoMessage()

func (*ScopeMetrics) Reset 

func (m *ScopeMetrics) Reset()

func (*ScopeMetrics) Size 

func (m *ScopeMetrics) Size() (n int)

func (*ScopeMetrics) String 

func (m *ScopeMetrics) String() string

func (*ScopeMetrics) Unmarshal 

func (m *ScopeMetrics) Unmarshal(dAtA []byte) error

func (*ScopeMetrics) XXX_DiscardUnknown 

func (m *ScopeMetrics) XXX_DiscardUnknown()

func (*ScopeMetrics) XXX_Marshal 

func (m *ScopeMetrics) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*ScopeMetrics) XXX_Merge 

func (m *ScopeMetrics) XXX_Merge(src proto.Message)

func (*ScopeMetrics) XXX_Size 

func (m *ScopeMetrics) XXX_Size() int

func (*ScopeMetrics) XXX_Unmarshal 

func (m *ScopeMetrics) XXX_Unmarshal(b []byte) error

type Sum 

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"`
}

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

func (*Sum) Descriptor 

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

func (*Sum) GetAggregationTemporality 

func (m *Sum) GetAggregationTemporality() AggregationTemporality

func (*Sum) GetDataPoints 

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

func (*Sum) GetIsMonotonic 

func (m *Sum) GetIsMonotonic() bool

func (*Sum) Marshal 

func (m *Sum) Marshal() (dAtA []byte, err error)

func (*Sum) MarshalTo 

func (m *Sum) MarshalTo(dAtA []byte) (int, error)

func (*Sum) MarshalToSizedBuffer 

func (m *Sum) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Sum) ProtoMessage 

func (*Sum) ProtoMessage()

func (*Sum) Reset 

func (m *Sum) Reset()

func (*Sum) Size 

func (m *Sum) Size() (n int)

func (*Sum) String 

func (m *Sum) String() string

func (*Sum) Unmarshal 

func (m *Sum) Unmarshal(dAtA []byte) error

func (*Sum) XXX_DiscardUnknown 

func (m *Sum) XXX_DiscardUnknown()

func (*Sum) XXX_Marshal 

func (m *Sum) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Sum) XXX_Merge 

func (m *Sum) XXX_Merge(src proto.Message)

func (*Sum) XXX_Size 

func (m *Sum) XXX_Size() int

func (*Sum) XXX_Unmarshal 

func (m *Sum) XXX_Unmarshal(b []byte) error

type Summary 

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

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 

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

func (*Summary) GetDataPoints 

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

func (*Summary) Marshal 

func (m *Summary) Marshal() (dAtA []byte, err error)

func (*Summary) MarshalTo 

func (m *Summary) MarshalTo(dAtA []byte) (int, error)

func (*Summary) MarshalToSizedBuffer 

func (m *Summary) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Summary) ProtoMessage 

func (*Summary) ProtoMessage()

func (*Summary) Reset 

func (m *Summary) Reset()

func (*Summary) Size 

func (m *Summary) Size() (n int)

func (*Summary) String 

func (m *Summary) String() string

func (*Summary) Unmarshal 

func (m *Summary) Unmarshal(dAtA []byte) error

func (*Summary) XXX_DiscardUnknown 

func (m *Summary) XXX_DiscardUnknown()

func (*Summary) XXX_Marshal 

func (m *Summary) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Summary) XXX_Merge 

func (m *Summary) XXX_Merge(src proto.Message)

func (*Summary) XXX_Size 

func (m *Summary) XXX_Size() int

func (*Summary) XXX_Unmarshal 

func (m *Summary) XXX_Unmarshal(b []byte) error

type SummaryDataPoint 

type SummaryDataPoint struct {
	// The set of key/value pairs that uniquely identify the timeseries from
	// where this point belongs. The list may be empty (may contain 0 elements).
	// Attribute keys MUST be unique (it is not allowed to have more than one
	// attribute with the same key).
	Attributes []v11.KeyValue `protobuf:"bytes,7,rep,name=attributes,proto3" json:"attributes"`
	// StartTimeUnixNano is optional but strongly encouraged, see the
	// the detailed comments above Metric.
	//
	// Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
	// 1970.
	StartTimeUnixNano uint64 `protobuf:"fixed64,2,opt,name=start_time_unix_nano,json=startTimeUnixNano,proto3" json:"start_time_unix_nano,omitempty"`
	// TimeUnixNano is required, see the detailed comments above Metric.
	//
	// 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.
	//
	// Note: Sum should only be filled out when measuring non-negative discrete
	// events, and is assumed to be monotonic over the values of these events.
	// Negative events *can* be recorded, but sum should not be filled out when
	// doing so.  This is specifically to enforce compatibility w/ OpenMetrics,
	// see: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#summary
	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"`
	// Flags that apply to this specific data point.  See DataPointFlags
	// for the available flags and their meaning.
	Flags uint32 `protobuf:"varint,8,opt,name=flags,proto3" json:"flags,omitempty"`
}

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

func (*SummaryDataPoint) Descriptor 

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

func (*SummaryDataPoint) GetAttributes 

func (m *SummaryDataPoint) GetAttributes() []v11.KeyValue

func (*SummaryDataPoint) GetCount 

func (m *SummaryDataPoint) GetCount() uint64

func (*SummaryDataPoint) GetFlags 

func (m *SummaryDataPoint) GetFlags() uint32

func (*SummaryDataPoint) GetQuantileValues 

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

func (*SummaryDataPoint) GetStartTimeUnixNano 

func (m *SummaryDataPoint) GetStartTimeUnixNano() uint64

func (*SummaryDataPoint) GetSum 

func (m *SummaryDataPoint) GetSum() float64

func (*SummaryDataPoint) GetTimeUnixNano 

func (m *SummaryDataPoint) GetTimeUnixNano() uint64

func (*SummaryDataPoint) Marshal 

func (m *SummaryDataPoint) Marshal() (dAtA []byte, err error)

func (*SummaryDataPoint) MarshalTo 

func (m *SummaryDataPoint) MarshalTo(dAtA []byte) (int, error)

func (*SummaryDataPoint) MarshalToSizedBuffer 

func (m *SummaryDataPoint) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*SummaryDataPoint) ProtoMessage 

func (*SummaryDataPoint) ProtoMessage()

func (*SummaryDataPoint) Reset 

func (m *SummaryDataPoint) Reset()

func (*SummaryDataPoint) Size 

func (m *SummaryDataPoint) Size() (n int)

func (*SummaryDataPoint) String 

func (m *SummaryDataPoint) String() string

func (*SummaryDataPoint) Unmarshal 

func (m *SummaryDataPoint) Unmarshal(dAtA []byte) error

func (*SummaryDataPoint) XXX_DiscardUnknown 

func (m *SummaryDataPoint) XXX_DiscardUnknown()

func (*SummaryDataPoint) XXX_Marshal 

func (m *SummaryDataPoint) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SummaryDataPoint) XXX_Merge 

func (m *SummaryDataPoint) XXX_Merge(src proto.Message)

func (*SummaryDataPoint) XXX_Size 

func (m *SummaryDataPoint) XXX_Size() int

func (*SummaryDataPoint) XXX_Unmarshal 

func (m *SummaryDataPoint) XXX_Unmarshal(b []byte) error

type SummaryDataPoint_ValueAtQuantile 

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.
	//
	// Quantile values must NOT be negative.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
}

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 

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

func (*SummaryDataPoint_ValueAtQuantile) GetQuantile 

func (m *SummaryDataPoint_ValueAtQuantile) GetQuantile() float64

func (*SummaryDataPoint_ValueAtQuantile) GetValue 

func (m *SummaryDataPoint_ValueAtQuantile) GetValue() float64

func (*SummaryDataPoint_ValueAtQuantile) Marshal 

func (m *SummaryDataPoint_ValueAtQuantile) Marshal() (dAtA []byte, err error)

func (*SummaryDataPoint_ValueAtQuantile) MarshalTo 

func (m *SummaryDataPoint_ValueAtQuantile) MarshalTo(dAtA []byte) (int, error)

func (*SummaryDataPoint_ValueAtQuantile) MarshalToSizedBuffer 

func (m *SummaryDataPoint_ValueAtQuantile) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*SummaryDataPoint_ValueAtQuantile) ProtoMessage 

func (*SummaryDataPoint_ValueAtQuantile) ProtoMessage()

func (*SummaryDataPoint_ValueAtQuantile) Reset 

func (m *SummaryDataPoint_ValueAtQuantile) Reset()

func (*SummaryDataPoint_ValueAtQuantile) Size 

func (m *SummaryDataPoint_ValueAtQuantile) Size() (n int)

func (*SummaryDataPoint_ValueAtQuantile) String 

func (m *SummaryDataPoint_ValueAtQuantile) String() string

func (*SummaryDataPoint_ValueAtQuantile) Unmarshal 

func (m *SummaryDataPoint_ValueAtQuantile) Unmarshal(dAtA []byte) error

func (*SummaryDataPoint_ValueAtQuantile) XXX_DiscardUnknown 

func (m *SummaryDataPoint_ValueAtQuantile) XXX_DiscardUnknown()

func (*SummaryDataPoint_ValueAtQuantile) XXX_Marshal 

func (m *SummaryDataPoint_ValueAtQuantile) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*SummaryDataPoint_ValueAtQuantile) XXX_Merge 

func (m *SummaryDataPoint_ValueAtQuantile) XXX_Merge(src proto.Message)

func (*SummaryDataPoint_ValueAtQuantile) XXX_Size 

func (m *SummaryDataPoint_ValueAtQuantile) XXX_Size() int

func (*SummaryDataPoint_ValueAtQuantile) XXX_Unmarshal 

func (m *SummaryDataPoint_ValueAtQuantile) XXX_Unmarshal(b []byte) error

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.