v1

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: Jun 16, 2020 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1 is a generated protocol buffer package.

It is generated from these files: 

opentelemetry/proto/metrics/v1/metrics.proto

It has these top-level messages: 

ResourceMetrics
InstrumentationLibraryMetrics
Metric
MetricDescriptor
Int64DataPoint
DoubleDataPoint
HistogramDataPoint
SummaryDataPoint

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")
)
View Source 
var MetricDescriptor_Temporality_name = map[int32]string{
	0: "INVALID_TEMPORALITY",
	1: "INSTANTANEOUS",
	2: "DELTA",
	3: "CUMULATIVE",
}
View Source 
var MetricDescriptor_Temporality_value = map[string]int32{
	"INVALID_TEMPORALITY": 0,
	"INSTANTANEOUS":       1,
	"DELTA":               2,
	"CUMULATIVE":          3,
}
View Source 
var MetricDescriptor_Type_name = map[int32]string{
	0: "INVALID_TYPE",
	1: "INT64",
	2: "MONOTONIC_INT64",
	3: "DOUBLE",
	4: "MONOTONIC_DOUBLE",
	5: "HISTOGRAM",
	6: "SUMMARY",
}
View Source 
var MetricDescriptor_Type_value = map[string]int32{
	"INVALID_TYPE":     0,
	"INT64":            1,
	"MONOTONIC_INT64":  2,
	"DOUBLE":           3,
	"MONOTONIC_DOUBLE": 4,
	"HISTOGRAM":        5,
	"SUMMARY":          6,
}

Functions

This section is empty.

Types

type DoubleDataPoint 

type DoubleDataPoint struct {
	// The set of labels that uniquely identify this timeseries.
	Labels []*opentelemetry_proto_common_v1.StringKeyValue `protobuf:"bytes,1,rep,name=labels" json:"labels,omitempty"`
	// start_time_unix_nano is the time when the cumulative value was reset to zero.
	// This is used for Counter type only. For Gauge the value is not specified and
	// defaults to 0.
	//
	// The cumulative 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 value was recorded.
	// 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 float64 `protobuf:"fixed64,4,opt,name=value,proto3" json:"value,omitempty"`
}

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

func (*DoubleDataPoint) Descriptor 

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

func (*DoubleDataPoint) GetLabels 

func (m *DoubleDataPoint) GetLabels() []*opentelemetry_proto_common_v1.StringKeyValue

func (*DoubleDataPoint) GetStartTimeUnixNano 

func (m *DoubleDataPoint) GetStartTimeUnixNano() uint64

func (*DoubleDataPoint) GetTimeUnixNano 

func (m *DoubleDataPoint) GetTimeUnixNano() uint64

func (*DoubleDataPoint) GetValue 

func (m *DoubleDataPoint) GetValue() float64

func (*DoubleDataPoint) Marshal 

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

func (*DoubleDataPoint) MarshalTo 

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

func (*DoubleDataPoint) ProtoMessage 

func (*DoubleDataPoint) ProtoMessage()

func (*DoubleDataPoint) Reset 

func (m *DoubleDataPoint) Reset()

func (*DoubleDataPoint) Size 

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

func (*DoubleDataPoint) String 

func (m *DoubleDataPoint) String() string

func (*DoubleDataPoint) Unmarshal 

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

type HistogramDataPoint 

type HistogramDataPoint struct {
	// The set of labels that uniquely identify this timeseries.
	Labels []*opentelemetry_proto_common_v1.StringKeyValue `protobuf:"bytes,1,rep,name=labels" json:"labels,omitempty"`
	// start_time_unix_nano is the time when the cumulative value was reset to zero.
	//
	// The cumulative 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.
	// Note: this field is always unspecified and ignored if MetricDescriptor.type==GAUGE_HISTOGRAM.
	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 value was recorded.
	// 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:"varint,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"`
	// buckets is an optional field contains the values of histogram for each bucket.
	//
	// The sum of the values in the buckets "count" field must equal the value in the count field.
	//
	// The number of elements in buckets array must be by one greater than the
	// number of elements in bucket_bounds array.
	//
	// Note: if HistogramDataPoint.bucket_options defines bucket bounds then this field
	// must also be present and number of elements in this field must be equal to the
	// number of buckets defined by bucket_options.
	Buckets []*HistogramDataPoint_Bucket `protobuf:"bytes,6,rep,name=buckets" json:"buckets,omitempty"`
	// explicit_bounds specifies buckets with explicitly defined bounds for values.
	// The bucket boundaries are described by "bounds" field.
	//
	// This defines size(bounds) + 1 (= N) buckets. The boundaries for bucket
	// at index i are:
	//
	// [0, bounds[i]) for i == 0
	// [bounds[i-1], bounds[i]) for 0 < i < N-1
	// [bounds[i], +infinity) for i == N-1
	// The values in bounds array must be strictly increasing and > 0.
	//
	// Note: only [a, b) intervals are currently supported for each bucket. If we decides
	// to also support (a, b] intervals we should add support for these by defining a boolean
	// value which decides what type of intervals to use.
	ExplicitBounds []float64 `protobuf:"fixed64,7,rep,packed,name=explicit_bounds,json=explicitBounds" json:"explicit_bounds,omitempty"`
}

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.

func (*HistogramDataPoint) Descriptor 

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

func (*HistogramDataPoint) GetBuckets 

func (m *HistogramDataPoint) GetBuckets() []*HistogramDataPoint_Bucket

func (*HistogramDataPoint) GetCount 

func (m *HistogramDataPoint) GetCount() uint64

func (*HistogramDataPoint) GetExplicitBounds 

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

func (*HistogramDataPoint) GetLabels 

func (m *HistogramDataPoint) GetLabels() []*opentelemetry_proto_common_v1.StringKeyValue

func (*HistogramDataPoint) GetStartTimeUnixNano 

func (m *HistogramDataPoint) GetStartTimeUnixNano() uint64

func (*HistogramDataPoint) GetSum 

func (m *HistogramDataPoint) GetSum() float64

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

type HistogramDataPoint_Bucket 

type HistogramDataPoint_Bucket struct {
	// The number of values in each bucket of the histogram, as described by
	// bucket_options.
	Count uint64 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	// exemplar is an optional representative value of the bucket.
	Exemplar *HistogramDataPoint_Bucket_Exemplar `protobuf:"bytes,2,opt,name=exemplar" json:"exemplar,omitempty"`
}

Bucket contains values for a bucket.

func (*HistogramDataPoint_Bucket) Descriptor 

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

func (*HistogramDataPoint_Bucket) GetCount 

func (m *HistogramDataPoint_Bucket) GetCount() uint64

func (*HistogramDataPoint_Bucket) GetExemplar 

func (m *HistogramDataPoint_Bucket) GetExemplar() *HistogramDataPoint_Bucket_Exemplar

func (*HistogramDataPoint_Bucket) Marshal 

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

func (*HistogramDataPoint_Bucket) MarshalTo 

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

func (*HistogramDataPoint_Bucket) ProtoMessage 

func (*HistogramDataPoint_Bucket) ProtoMessage()

func (*HistogramDataPoint_Bucket) Reset 

func (m *HistogramDataPoint_Bucket) Reset()

func (*HistogramDataPoint_Bucket) Size 

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

func (*HistogramDataPoint_Bucket) String 

func (m *HistogramDataPoint_Bucket) String() string

func (*HistogramDataPoint_Bucket) Unmarshal 

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

type HistogramDataPoint_Bucket_Exemplar 

type HistogramDataPoint_Bucket_Exemplar struct {
	// Value of the exemplar point. It determines which bucket the exemplar belongs to.
	// If bucket_options define bounds for this bucket then this value must be within
	// the defined bounds.
	Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
	// time_unix_nano is the moment 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"`
	// exemplar_attachments are contextual information about the example value.
	// Keys in this list must be unique.
	Attachments []*opentelemetry_proto_common_v1.StringKeyValue `protobuf:"bytes,3,rep,name=attachments" json:"attachments,omitempty"`
}

Exemplars are example points that may be used to annotate aggregated Histogram values. They are metadata that gives information about a particular value added to a Histogram bucket.

func (*HistogramDataPoint_Bucket_Exemplar) Descriptor 

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

func (*HistogramDataPoint_Bucket_Exemplar) GetAttachments 

func (m *HistogramDataPoint_Bucket_Exemplar) GetAttachments() []*opentelemetry_proto_common_v1.StringKeyValue

func (*HistogramDataPoint_Bucket_Exemplar) GetTimeUnixNano 

func (m *HistogramDataPoint_Bucket_Exemplar) GetTimeUnixNano() uint64

func (*HistogramDataPoint_Bucket_Exemplar) GetValue 

func (m *HistogramDataPoint_Bucket_Exemplar) GetValue() float64

func (*HistogramDataPoint_Bucket_Exemplar) Marshal 

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

func (*HistogramDataPoint_Bucket_Exemplar) MarshalTo 

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

func (*HistogramDataPoint_Bucket_Exemplar) ProtoMessage 

func (*HistogramDataPoint_Bucket_Exemplar) ProtoMessage()

func (*HistogramDataPoint_Bucket_Exemplar) Reset 

func (m *HistogramDataPoint_Bucket_Exemplar) Reset()

func (*HistogramDataPoint_Bucket_Exemplar) Size 

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

func (*HistogramDataPoint_Bucket_Exemplar) String 

func (m *HistogramDataPoint_Bucket_Exemplar) String() string

func (*HistogramDataPoint_Bucket_Exemplar) Unmarshal 

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

type InstrumentationLibraryMetrics 

type InstrumentationLibraryMetrics struct {
	// The instrumentation library information for the metrics in this message.
	// If this field is not set then no library info is known.
	InstrumentationLibrary *opentelemetry_proto_common_v1.InstrumentationLibrary `protobuf:"bytes,1,opt,name=instrumentation_library,json=instrumentationLibrary" json:"instrumentation_library,omitempty"`
	// A list of metrics that originate from an instrumentation library.
	Metrics []*Metric `protobuf:"bytes,2,rep,name=metrics" json:"metrics,omitempty"`
}

A collection of Metrics produced by an InstrumentationLibrary.

func (*InstrumentationLibraryMetrics) Descriptor 

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

func (*InstrumentationLibraryMetrics) GetInstrumentationLibrary 

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

func (*InstrumentationLibraryMetrics) GetMetrics 

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

func (*InstrumentationLibraryMetrics) Marshal 

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

func (*InstrumentationLibraryMetrics) MarshalTo 

func (m *InstrumentationLibraryMetrics) MarshalTo(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

type Int64DataPoint 

type Int64DataPoint struct {
	// The set of labels that uniquely identify this timeseries.
	Labels []*opentelemetry_proto_common_v1.StringKeyValue `protobuf:"bytes,1,rep,name=labels" json:"labels,omitempty"`
	// start_time_unix_nano is the time when the cumulative value was reset to zero.
	// This is used for Counter type only. For Gauge the value is not specified and
	// defaults to 0.
	//
	// The cumulative 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 value was recorded.
	// 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:"varint,4,opt,name=value,proto3" json:"value,omitempty"`
}

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

func (*Int64DataPoint) Descriptor 

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

func (*Int64DataPoint) GetLabels 

func (m *Int64DataPoint) GetLabels() []*opentelemetry_proto_common_v1.StringKeyValue

func (*Int64DataPoint) GetStartTimeUnixNano 

func (m *Int64DataPoint) GetStartTimeUnixNano() uint64

func (*Int64DataPoint) GetTimeUnixNano 

func (m *Int64DataPoint) GetTimeUnixNano() uint64

func (*Int64DataPoint) GetValue 

func (m *Int64DataPoint) GetValue() int64

func (*Int64DataPoint) Marshal 

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

func (*Int64DataPoint) MarshalTo 

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

func (*Int64DataPoint) ProtoMessage 

func (*Int64DataPoint) ProtoMessage()

func (*Int64DataPoint) Reset 

func (m *Int64DataPoint) Reset()

func (*Int64DataPoint) Size 

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

func (*Int64DataPoint) String 

func (m *Int64DataPoint) String() string

func (*Int64DataPoint) Unmarshal 

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

type Metric 

type Metric struct {
	// metric_descriptor describes the Metric.
	MetricDescriptor *MetricDescriptor `protobuf:"bytes,1,opt,name=metric_descriptor,json=metricDescriptor" json:"metric_descriptor,omitempty"`
	// Data is a list of one or more DataPoints for a single metric. Only one of the
	// following fields is used for the data, depending on the type of the metric defined
	// by MetricDescriptor.type field.
	Int64DataPoints     []*Int64DataPoint     `protobuf:"bytes,2,rep,name=int64_data_points,json=int64DataPoints" json:"int64_data_points,omitempty"`
	DoubleDataPoints    []*DoubleDataPoint    `protobuf:"bytes,3,rep,name=double_data_points,json=doubleDataPoints" json:"double_data_points,omitempty"`
	HistogramDataPoints []*HistogramDataPoint `protobuf:"bytes,4,rep,name=histogram_data_points,json=histogramDataPoints" json:"histogram_data_points,omitempty"`
	SummaryDataPoints   []*SummaryDataPoint   `protobuf:"bytes,5,rep,name=summary_data_points,json=summaryDataPoints" json:"summary_data_points,omitempty"`
}

Defines a Metric which has one or more timeseries.

The data model and relation between entities is shown in the diagram below.

- Metric is composed of a MetricDescriptor and a list of data points. - MetricDescriptor contains a list of label keys (shown horizontally). - Data is a list of DataPoints (shown vertically). - DataPoint contains a list of label values and a value. 

   Metric
+----------+         +------------------------+
|descriptor|-------->| MetricDescriptor       |
|          |         |+-----+-----+   +-----+ |
|          |         ||label|label|...|label| |
|      data|--+      ||key1 |key2 |   |keyN | |
+----------+  |      |+-----+-----+   +-----+ |
              |      +------------------------+
              |
              |      +---------------------------+
              |      |DataPoint 1                |
              v      |+------+------+   +------+ |
           +-----+   ||label |label |...|label | |
           |  1  |-->||value1|value2|...|valueN| |
           +-----+   |+------+------+   +------+ |
           |  .  |   |+-----+                    |
           |  .  |   ||value|                    |
           |  .  |   |+-----+                    |
           |  .  |   +---------------------------+
           |  .  |                   .
           |  .  |                   .
           |  .  |                   .
           |  .  |   +---------------------------+
           |  .  |   |DataPoint M                |
           +-----+   |+------+------+   +------+ |
           |  M  |-->||label |label |...|label | |
           +-----+   ||value1|value2|...|valueN| |
                     |+------+------+   +------+ |
                     |+-----+                    |
                     ||value|                    |
                     |+-----+                    |
                     +---------------------------+

----------------------------------------------------------------------- DataPoint is a value of specific type corresponding to a given moment in time. Each DataPoint is timestamped.

DataPoint is strongly typed: each DataPoint type has a specific Protobuf message depending on the value type of the metric and thus there are currently 4 DataPoint messages, which correspond to the types of metric values.

func (*Metric) Descriptor 

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

func (*Metric) GetDoubleDataPoints 

func (m *Metric) GetDoubleDataPoints() []*DoubleDataPoint

func (*Metric) GetHistogramDataPoints 

func (m *Metric) GetHistogramDataPoints() []*HistogramDataPoint

func (*Metric) GetInt64DataPoints 

func (m *Metric) GetInt64DataPoints() []*Int64DataPoint

func (*Metric) GetMetricDescriptor 

func (m *Metric) GetMetricDescriptor() *MetricDescriptor

func (*Metric) GetSummaryDataPoints 

func (m *Metric) GetSummaryDataPoints() []*SummaryDataPoint

func (*Metric) Marshal 

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

func (*Metric) MarshalTo 

func (m *Metric) MarshalTo(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

type MetricDescriptor 

type MetricDescriptor 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"`
	// type is the type of values this metric has.
	Type MetricDescriptor_Type `protobuf:"varint,4,opt,name=type,proto3,enum=opentelemetry.proto.metrics.v1.MetricDescriptor_Type" json:"type,omitempty"`
	// temporality is the Temporality of values this metric has.
	Temporality MetricDescriptor_Temporality `` /* 141-byte string literal not displayed */
}

Defines a metric type and its schema.

func (*MetricDescriptor) Descriptor 

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

func (*MetricDescriptor) GetDescription 

func (m *MetricDescriptor) GetDescription() string

func (*MetricDescriptor) GetName 

func (m *MetricDescriptor) GetName() string

func (*MetricDescriptor) GetTemporality 

func (m *MetricDescriptor) GetTemporality() MetricDescriptor_Temporality

func (*MetricDescriptor) GetType 

func (m *MetricDescriptor) GetType() MetricDescriptor_Type

func (*MetricDescriptor) GetUnit 

func (m *MetricDescriptor) GetUnit() string

func (*MetricDescriptor) Marshal 

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

func (*MetricDescriptor) MarshalTo 

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

func (*MetricDescriptor) ProtoMessage 

func (*MetricDescriptor) ProtoMessage()

func (*MetricDescriptor) Reset 

func (m *MetricDescriptor) Reset()

func (*MetricDescriptor) Size 

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

func (*MetricDescriptor) String 

func (m *MetricDescriptor) String() string

func (*MetricDescriptor) Unmarshal 

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

type MetricDescriptor_Temporality 

type MetricDescriptor_Temporality int32

Temporality is the temporal quality values of a metric have. It describes how those values relate to the time interval over which they are reported. 

const (
	// INVALID_TEMPORALITY is the default Temporality, it MUST not be
	// used.
	MetricDescriptor_INVALID_TEMPORALITY MetricDescriptor_Temporality = 0
	// INSTANTANEOUS is a metric whose values are measured at a particular
	// instant. The values are not aggregated over any time interval and are
	// unique per timestamp. As such, these metrics are not expected to have
	// an associated start time.
	MetricDescriptor_INSTANTANEOUS MetricDescriptor_Temporality = 1
	// DELTA is a metric whose values are the aggregation of measurements
	// made over a time interval. 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.
	MetricDescriptor_DELTA MetricDescriptor_Temporality = 2
	// CUMULATIVE is a metric whose values are the aggregation of
	// successively made measurements from a fixed start time until the last
	// reported measurement. 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.
	MetricDescriptor_CUMULATIVE MetricDescriptor_Temporality = 3
)

func (MetricDescriptor_Temporality) EnumDescriptor 

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

func (MetricDescriptor_Temporality) String 

func (x MetricDescriptor_Temporality) String() string

type MetricDescriptor_Type 

type MetricDescriptor_Type int32

Type is the type of values a metric has. 

const (
	// INVALID_TYPE is the default Type, it MUST not be used.
	MetricDescriptor_INVALID_TYPE MetricDescriptor_Type = 0
	// INT64 values are signed 64-bit integers.
	//
	// A Metric of this Type MUST store its values as Int64DataPoint.
	MetricDescriptor_INT64 MetricDescriptor_Type = 1
	// MONOTONIC_INT64 values are monotonically increasing signed 64-bit
	// integers.
	//
	// A Metric of this Type MUST store its values as Int64DataPoint.
	MetricDescriptor_MONOTONIC_INT64 MetricDescriptor_Type = 2
	// DOUBLE values are double-precision floating-point numbers.
	//
	// A Metric of this Type MUST store its values as DoubleDataPoint.
	MetricDescriptor_DOUBLE MetricDescriptor_Type = 3
	// MONOTONIC_DOUBLE values are monotonically increasing double-precision
	// floating-point numbers.
	//
	// A Metric of this Type MUST store its values as DoubleDataPoint.
	MetricDescriptor_MONOTONIC_DOUBLE MetricDescriptor_Type = 4
	// Histogram measurement.
	// Corresponding values are stored in HistogramDataPoint.
	MetricDescriptor_HISTOGRAM MetricDescriptor_Type = 5
	// Summary value. Some frameworks implemented Histograms as a summary of observations
	// (usually things like request durations and response sizes). While it
	// also provides a total count of observations and a sum of all observed
	// values, it calculates configurable percentiles over a sliding time
	// window.
	// Corresponding values are stored in SummaryDataPoint.
	MetricDescriptor_SUMMARY MetricDescriptor_Type = 6
)

func (MetricDescriptor_Type) EnumDescriptor 

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

func (MetricDescriptor_Type) String 

func (x MetricDescriptor_Type) String() string

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 *opentelemetry_proto_resource_v1.Resource `protobuf:"bytes,1,opt,name=resource" json:"resource,omitempty"`
	// A list of metrics that originate from a resource.
	InstrumentationLibraryMetrics []*InstrumentationLibraryMetrics `` /* 143-byte string literal not displayed */
}

A collection of InstrumentationLibraryMetrics from a Resource.

func (*ResourceMetrics) Descriptor 

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

func (*ResourceMetrics) GetInstrumentationLibraryMetrics 

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

func (*ResourceMetrics) GetResource 

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

func (*ResourceMetrics) Marshal 

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

func (*ResourceMetrics) MarshalTo 

func (m *ResourceMetrics) MarshalTo(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

type SummaryDataPoint 

type SummaryDataPoint struct {
	// The set of labels that uniquely identify this timeseries.
	Labels []*opentelemetry_proto_common_v1.StringKeyValue `protobuf:"bytes,1,rep,name=labels" json:"labels,omitempty"`
	// start_time_unix_nano is the time when the cumulative value was reset to zero.
	//
	// The cumulative 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 value was recorded.
	// 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 total number of recorded values since start_time. Optional since
	// some systems don't expose this.
	Count uint64 `protobuf:"varint,4,opt,name=count,proto3" json:"count,omitempty"`
	// The total sum of recorded values since start_time. Optional since some
	// systems don't expose this. If count is zero then this field must be zero.
	Sum float64 `protobuf:"fixed64,5,opt,name=sum,proto3" json:"sum,omitempty"`
	// A list of values at different percentiles of the distribution calculated
	// from the current snapshot. The percentiles must be strictly increasing.
	PercentileValues []*SummaryDataPoint_ValueAtPercentile `protobuf:"bytes,6,rep,name=percentile_values,json=percentileValues" json:"percentile_values,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) GetCount 

func (m *SummaryDataPoint) GetCount() uint64

func (*SummaryDataPoint) GetLabels 

func (m *SummaryDataPoint) GetLabels() []*opentelemetry_proto_common_v1.StringKeyValue

func (*SummaryDataPoint) GetPercentileValues 

func (m *SummaryDataPoint) GetPercentileValues() []*SummaryDataPoint_ValueAtPercentile

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

type SummaryDataPoint_ValueAtPercentile 

type SummaryDataPoint_ValueAtPercentile struct {
	// The percentile of a distribution. Must be in the interval
	// [0.0, 100.0].
	Percentile float64 `protobuf:"fixed64,1,opt,name=percentile,proto3" json:"percentile,omitempty"`
	// The value at the given percentile of a distribution.
	Value float64 `protobuf:"fixed64,2,opt,name=value,proto3" json:"value,omitempty"`
}

Represents the value at a given percentile of a distribution.

To record Min and Max values following conventions are used: - The 100th percentile is equivalent to the maximum value observed. - The 0th percentile 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_ValueAtPercentile) Descriptor 

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

func (*SummaryDataPoint_ValueAtPercentile) GetPercentile 

func (m *SummaryDataPoint_ValueAtPercentile) GetPercentile() float64

func (*SummaryDataPoint_ValueAtPercentile) GetValue 

func (m *SummaryDataPoint_ValueAtPercentile) GetValue() float64

func (*SummaryDataPoint_ValueAtPercentile) Marshal 

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

func (*SummaryDataPoint_ValueAtPercentile) MarshalTo 

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

func (*SummaryDataPoint_ValueAtPercentile) ProtoMessage 

func (*SummaryDataPoint_ValueAtPercentile) ProtoMessage()

func (*SummaryDataPoint_ValueAtPercentile) Reset 

func (m *SummaryDataPoint_ValueAtPercentile) Reset()

func (*SummaryDataPoint_ValueAtPercentile) Size 

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

func (*SummaryDataPoint_ValueAtPercentile) String 

func (m *SummaryDataPoint_ValueAtPercentile) String() string

func (*SummaryDataPoint_ValueAtPercentile) Unmarshal 

func (m *SummaryDataPoint_ValueAtPercentile) Unmarshal(dAtA []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.