Documentation ¶
Index ¶
- Variables
- type DistributionValue
- func (*DistributionValue) Descriptor() ([]byte, []int)
- func (m *DistributionValue) GetBucketOptions() *DistributionValue_BucketOptions
- func (m *DistributionValue) GetBuckets() []*DistributionValue_Bucket
- func (m *DistributionValue) GetCount() int64
- func (m *DistributionValue) GetSum() float64
- func (m *DistributionValue) GetSumOfSquaredDeviation() float64
- func (*DistributionValue) ProtoMessage()
- func (m *DistributionValue) Reset()
- func (m *DistributionValue) String() string
- func (m *DistributionValue) XXX_DiscardUnknown()
- func (m *DistributionValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DistributionValue) XXX_Merge(src proto.Message)
- func (m *DistributionValue) XXX_Size() int
- func (m *DistributionValue) XXX_Unmarshal(b []byte) error
- type DistributionValue_Bucket
- func (*DistributionValue_Bucket) Descriptor() ([]byte, []int)
- func (m *DistributionValue_Bucket) GetCount() int64
- func (m *DistributionValue_Bucket) GetExemplar() *DistributionValue_Exemplar
- func (*DistributionValue_Bucket) ProtoMessage()
- func (m *DistributionValue_Bucket) Reset()
- func (m *DistributionValue_Bucket) String() string
- func (m *DistributionValue_Bucket) XXX_DiscardUnknown()
- func (m *DistributionValue_Bucket) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DistributionValue_Bucket) XXX_Merge(src proto.Message)
- func (m *DistributionValue_Bucket) XXX_Size() int
- func (m *DistributionValue_Bucket) XXX_Unmarshal(b []byte) error
- type DistributionValue_BucketOptions
- func (*DistributionValue_BucketOptions) Descriptor() ([]byte, []int)
- func (m *DistributionValue_BucketOptions) GetExplicit() *DistributionValue_BucketOptions_Explicit
- func (m *DistributionValue_BucketOptions) GetType() isDistributionValue_BucketOptions_Type
- func (*DistributionValue_BucketOptions) ProtoMessage()
- func (m *DistributionValue_BucketOptions) Reset()
- func (m *DistributionValue_BucketOptions) String() string
- func (m *DistributionValue_BucketOptions) XXX_DiscardUnknown()
- func (m *DistributionValue_BucketOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DistributionValue_BucketOptions) XXX_Merge(src proto.Message)
- func (*DistributionValue_BucketOptions) XXX_OneofWrappers() []interface{}
- func (m *DistributionValue_BucketOptions) XXX_Size() int
- func (m *DistributionValue_BucketOptions) XXX_Unmarshal(b []byte) error
- type DistributionValue_BucketOptions_Explicit
- func (*DistributionValue_BucketOptions_Explicit) Descriptor() ([]byte, []int)
- func (m *DistributionValue_BucketOptions_Explicit) GetBounds() []float64
- func (*DistributionValue_BucketOptions_Explicit) ProtoMessage()
- func (m *DistributionValue_BucketOptions_Explicit) Reset()
- func (m *DistributionValue_BucketOptions_Explicit) String() string
- func (m *DistributionValue_BucketOptions_Explicit) XXX_DiscardUnknown()
- func (m *DistributionValue_BucketOptions_Explicit) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DistributionValue_BucketOptions_Explicit) XXX_Merge(src proto.Message)
- func (m *DistributionValue_BucketOptions_Explicit) XXX_Size() int
- func (m *DistributionValue_BucketOptions_Explicit) XXX_Unmarshal(b []byte) error
- type DistributionValue_BucketOptions_Explicit_
- type DistributionValue_Exemplar
- func (*DistributionValue_Exemplar) Descriptor() ([]byte, []int)
- func (m *DistributionValue_Exemplar) GetAttachments() map[string]string
- func (m *DistributionValue_Exemplar) GetTimestamp() *timestamp.Timestamp
- func (m *DistributionValue_Exemplar) GetValue() float64
- func (*DistributionValue_Exemplar) ProtoMessage()
- func (m *DistributionValue_Exemplar) Reset()
- func (m *DistributionValue_Exemplar) String() string
- func (m *DistributionValue_Exemplar) XXX_DiscardUnknown()
- func (m *DistributionValue_Exemplar) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *DistributionValue_Exemplar) XXX_Merge(src proto.Message)
- func (m *DistributionValue_Exemplar) XXX_Size() int
- func (m *DistributionValue_Exemplar) XXX_Unmarshal(b []byte) error
- type LabelKey
- func (*LabelKey) Descriptor() ([]byte, []int)
- func (m *LabelKey) GetDescription() string
- func (m *LabelKey) GetKey() string
- func (*LabelKey) ProtoMessage()
- func (m *LabelKey) Reset()
- func (m *LabelKey) String() string
- func (m *LabelKey) XXX_DiscardUnknown()
- func (m *LabelKey) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *LabelKey) XXX_Merge(src proto.Message)
- func (m *LabelKey) XXX_Size() int
- func (m *LabelKey) XXX_Unmarshal(b []byte) error
- type LabelValue
- func (*LabelValue) Descriptor() ([]byte, []int)
- func (m *LabelValue) GetHasValue() bool
- func (m *LabelValue) GetValue() string
- func (*LabelValue) ProtoMessage()
- func (m *LabelValue) Reset()
- func (m *LabelValue) String() string
- func (m *LabelValue) XXX_DiscardUnknown()
- func (m *LabelValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *LabelValue) XXX_Merge(src proto.Message)
- func (m *LabelValue) XXX_Size() int
- func (m *LabelValue) XXX_Unmarshal(b []byte) error
- type Metric
- func (*Metric) Descriptor() ([]byte, []int)
- func (m *Metric) GetMetricDescriptor() *MetricDescriptor
- func (m *Metric) GetResource() *v1.Resource
- func (m *Metric) GetTimeseries() []*TimeSeries
- func (*Metric) ProtoMessage()
- func (m *Metric) Reset()
- func (m *Metric) String() string
- func (m *Metric) XXX_DiscardUnknown()
- func (m *Metric) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Metric) XXX_Merge(src proto.Message)
- func (m *Metric) XXX_Size() int
- func (m *Metric) XXX_Unmarshal(b []byte) error
- type MetricDescriptor
- func (*MetricDescriptor) Descriptor() ([]byte, []int)
- func (m *MetricDescriptor) GetDescription() string
- func (m *MetricDescriptor) GetLabelKeys() []*LabelKey
- func (m *MetricDescriptor) GetName() string
- func (m *MetricDescriptor) GetType() MetricDescriptor_Type
- func (m *MetricDescriptor) GetUnit() string
- func (*MetricDescriptor) ProtoMessage()
- func (m *MetricDescriptor) Reset()
- func (m *MetricDescriptor) String() string
- func (m *MetricDescriptor) XXX_DiscardUnknown()
- func (m *MetricDescriptor) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *MetricDescriptor) XXX_Merge(src proto.Message)
- func (m *MetricDescriptor) XXX_Size() int
- func (m *MetricDescriptor) XXX_Unmarshal(b []byte) error
- type MetricDescriptor_Type
- type Point
- func (*Point) Descriptor() ([]byte, []int)
- func (m *Point) GetDistributionValue() *DistributionValue
- func (m *Point) GetDoubleValue() float64
- func (m *Point) GetInt64Value() int64
- func (m *Point) GetSummaryValue() *SummaryValue
- func (m *Point) GetTimestamp() *timestamp.Timestamp
- func (m *Point) GetValue() isPoint_Value
- func (*Point) ProtoMessage()
- func (m *Point) Reset()
- func (m *Point) String() string
- func (m *Point) XXX_DiscardUnknown()
- func (m *Point) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Point) XXX_Merge(src proto.Message)
- func (*Point) XXX_OneofWrappers() []interface{}
- func (m *Point) XXX_Size() int
- func (m *Point) XXX_Unmarshal(b []byte) error
- type Point_DistributionValue
- type Point_DoubleValue
- type Point_Int64Value
- type Point_SummaryValue
- type SummaryValue
- func (*SummaryValue) Descriptor() ([]byte, []int)
- func (m *SummaryValue) GetCount() *wrappers.Int64Value
- func (m *SummaryValue) GetSnapshot() *SummaryValue_Snapshot
- func (m *SummaryValue) GetSum() *wrappers.DoubleValue
- func (*SummaryValue) ProtoMessage()
- func (m *SummaryValue) Reset()
- func (m *SummaryValue) String() string
- func (m *SummaryValue) XXX_DiscardUnknown()
- func (m *SummaryValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *SummaryValue) XXX_Merge(src proto.Message)
- func (m *SummaryValue) XXX_Size() int
- func (m *SummaryValue) XXX_Unmarshal(b []byte) error
- type SummaryValue_Snapshot
- func (*SummaryValue_Snapshot) Descriptor() ([]byte, []int)
- func (m *SummaryValue_Snapshot) GetCount() *wrappers.Int64Value
- func (m *SummaryValue_Snapshot) GetPercentileValues() []*SummaryValue_Snapshot_ValueAtPercentile
- func (m *SummaryValue_Snapshot) GetSum() *wrappers.DoubleValue
- func (*SummaryValue_Snapshot) ProtoMessage()
- func (m *SummaryValue_Snapshot) Reset()
- func (m *SummaryValue_Snapshot) String() string
- func (m *SummaryValue_Snapshot) XXX_DiscardUnknown()
- func (m *SummaryValue_Snapshot) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *SummaryValue_Snapshot) XXX_Merge(src proto.Message)
- func (m *SummaryValue_Snapshot) XXX_Size() int
- func (m *SummaryValue_Snapshot) XXX_Unmarshal(b []byte) error
- type SummaryValue_Snapshot_ValueAtPercentile
- func (*SummaryValue_Snapshot_ValueAtPercentile) Descriptor() ([]byte, []int)
- func (m *SummaryValue_Snapshot_ValueAtPercentile) GetPercentile() float64
- func (m *SummaryValue_Snapshot_ValueAtPercentile) GetValue() float64
- func (*SummaryValue_Snapshot_ValueAtPercentile) ProtoMessage()
- func (m *SummaryValue_Snapshot_ValueAtPercentile) Reset()
- func (m *SummaryValue_Snapshot_ValueAtPercentile) String() string
- func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_DiscardUnknown()
- func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Merge(src proto.Message)
- func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Size() int
- func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Unmarshal(b []byte) error
- type TimeSeries
- func (*TimeSeries) Descriptor() ([]byte, []int)
- func (m *TimeSeries) GetLabelValues() []*LabelValue
- func (m *TimeSeries) GetPoints() []*Point
- func (m *TimeSeries) GetStartTimestamp() *timestamp.Timestamp
- func (*TimeSeries) ProtoMessage()
- func (m *TimeSeries) Reset()
- func (m *TimeSeries) String() string
- func (m *TimeSeries) XXX_DiscardUnknown()
- func (m *TimeSeries) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *TimeSeries) XXX_Merge(src proto.Message)
- func (m *TimeSeries) XXX_Size() int
- func (m *TimeSeries) XXX_Unmarshal(b []byte) error
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type DistributionValue ¶
type DistributionValue struct { // The number of values in the population. Must be non-negative. This value // must equal the sum of the values in bucket_counts if a histogram is // provided. Count int64 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"` // The sum of the values in the population. If count is zero then this field // must be zero. Sum float64 `protobuf:"fixed64,2,opt,name=sum,proto3" json:"sum,omitempty"` // The sum of squared deviations from the mean of the values in the // population. For values x_i this is: // // Sum[i=1..n]((x_i - mean)^2) // // Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition // describes Welford's method for accumulating this sum in one pass. // // If count is zero then this field must be zero. SumOfSquaredDeviation float64 `` /* 130-byte string literal not displayed */ // Don't change bucket boundaries within a TimeSeries if your backend doesn't // support this. // TODO(issue #152): consider not required to send bucket options for // optimization. BucketOptions *DistributionValue_BucketOptions `protobuf:"bytes,4,opt,name=bucket_options,json=bucketOptions,proto3" json:"bucket_options,omitempty"` // If the distribution does not have a histogram, then omit this field. // If there is a histogram, then the sum of the values in the Bucket counts // must equal the value in the count field of the distribution. Buckets []*DistributionValue_Bucket `protobuf:"bytes,5,rep,name=buckets,proto3" json:"buckets,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.
func (*DistributionValue) Descriptor ¶
func (*DistributionValue) Descriptor() ([]byte, []int)
func (*DistributionValue) GetBucketOptions ¶
func (m *DistributionValue) GetBucketOptions() *DistributionValue_BucketOptions
func (*DistributionValue) GetBuckets ¶
func (m *DistributionValue) GetBuckets() []*DistributionValue_Bucket
func (*DistributionValue) GetCount ¶
func (m *DistributionValue) GetCount() int64
func (*DistributionValue) GetSum ¶
func (m *DistributionValue) GetSum() float64
func (*DistributionValue) GetSumOfSquaredDeviation ¶
func (m *DistributionValue) GetSumOfSquaredDeviation() float64
func (*DistributionValue) ProtoMessage ¶
func (*DistributionValue) ProtoMessage()
func (*DistributionValue) Reset ¶
func (m *DistributionValue) Reset()
func (*DistributionValue) String ¶
func (m *DistributionValue) String() string
func (*DistributionValue) XXX_DiscardUnknown ¶
func (m *DistributionValue) XXX_DiscardUnknown()
func (*DistributionValue) XXX_Marshal ¶
func (m *DistributionValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DistributionValue) XXX_Merge ¶
func (m *DistributionValue) XXX_Merge(src proto.Message)
func (*DistributionValue) XXX_Size ¶
func (m *DistributionValue) XXX_Size() int
func (*DistributionValue) XXX_Unmarshal ¶
func (m *DistributionValue) XXX_Unmarshal(b []byte) error
type DistributionValue_Bucket ¶
type DistributionValue_Bucket struct { // The number of values in each bucket of the histogram, as described in // bucket_bounds. Count int64 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"` // If the distribution does not have a histogram, then omit this field. Exemplar *DistributionValue_Exemplar `protobuf:"bytes,2,opt,name=exemplar,proto3" json:"exemplar,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*DistributionValue_Bucket) Descriptor ¶
func (*DistributionValue_Bucket) Descriptor() ([]byte, []int)
func (*DistributionValue_Bucket) GetCount ¶
func (m *DistributionValue_Bucket) GetCount() int64
func (*DistributionValue_Bucket) GetExemplar ¶
func (m *DistributionValue_Bucket) GetExemplar() *DistributionValue_Exemplar
func (*DistributionValue_Bucket) ProtoMessage ¶
func (*DistributionValue_Bucket) ProtoMessage()
func (*DistributionValue_Bucket) Reset ¶
func (m *DistributionValue_Bucket) Reset()
func (*DistributionValue_Bucket) String ¶
func (m *DistributionValue_Bucket) String() string
func (*DistributionValue_Bucket) XXX_DiscardUnknown ¶
func (m *DistributionValue_Bucket) XXX_DiscardUnknown()
func (*DistributionValue_Bucket) XXX_Marshal ¶
func (m *DistributionValue_Bucket) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DistributionValue_Bucket) XXX_Merge ¶
func (m *DistributionValue_Bucket) XXX_Merge(src proto.Message)
func (*DistributionValue_Bucket) XXX_Size ¶
func (m *DistributionValue_Bucket) XXX_Size() int
func (*DistributionValue_Bucket) XXX_Unmarshal ¶
func (m *DistributionValue_Bucket) XXX_Unmarshal(b []byte) error
type DistributionValue_BucketOptions ¶
type DistributionValue_BucketOptions struct { // Types that are valid to be assigned to Type: // *DistributionValue_BucketOptions_Explicit_ Type isDistributionValue_BucketOptions_Type `protobuf_oneof:"type"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A Distribution may optionally contain a histogram of the values in the population. The bucket boundaries for that histogram are described by BucketOptions.
If bucket_options has no type, then there is no histogram associated with the Distribution.
func (*DistributionValue_BucketOptions) Descriptor ¶
func (*DistributionValue_BucketOptions) Descriptor() ([]byte, []int)
func (*DistributionValue_BucketOptions) GetExplicit ¶
func (m *DistributionValue_BucketOptions) GetExplicit() *DistributionValue_BucketOptions_Explicit
func (*DistributionValue_BucketOptions) GetType ¶
func (m *DistributionValue_BucketOptions) GetType() isDistributionValue_BucketOptions_Type
func (*DistributionValue_BucketOptions) ProtoMessage ¶
func (*DistributionValue_BucketOptions) ProtoMessage()
func (*DistributionValue_BucketOptions) Reset ¶
func (m *DistributionValue_BucketOptions) Reset()
func (*DistributionValue_BucketOptions) String ¶
func (m *DistributionValue_BucketOptions) String() string
func (*DistributionValue_BucketOptions) XXX_DiscardUnknown ¶
func (m *DistributionValue_BucketOptions) XXX_DiscardUnknown()
func (*DistributionValue_BucketOptions) XXX_Marshal ¶
func (m *DistributionValue_BucketOptions) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DistributionValue_BucketOptions) XXX_Merge ¶
func (m *DistributionValue_BucketOptions) XXX_Merge(src proto.Message)
func (*DistributionValue_BucketOptions) XXX_OneofWrappers ¶
func (*DistributionValue_BucketOptions) XXX_OneofWrappers() []interface{}
XXX_OneofWrappers is for the internal use of the proto package.
func (*DistributionValue_BucketOptions) XXX_Size ¶
func (m *DistributionValue_BucketOptions) XXX_Size() int
func (*DistributionValue_BucketOptions) XXX_Unmarshal ¶
func (m *DistributionValue_BucketOptions) XXX_Unmarshal(b []byte) error
type DistributionValue_BucketOptions_Explicit ¶
type DistributionValue_BucketOptions_Explicit struct { // The values must be strictly increasing and > 0. Bounds []float64 `protobuf:"fixed64,1,rep,packed,name=bounds,proto3" json:"bounds,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Specifies a set of buckets with arbitrary upper-bounds. This defines size(bounds) + 1 (= N) buckets. The boundaries for bucket index i are:
[0, bucket_bounds[i]) for i == 0 [bucket_bounds[i-1], bucket_bounds[i]) for 0 < i < N-1 [bucket_bounds[i], +infinity) for i == N-1
func (*DistributionValue_BucketOptions_Explicit) Descriptor ¶
func (*DistributionValue_BucketOptions_Explicit) Descriptor() ([]byte, []int)
func (*DistributionValue_BucketOptions_Explicit) GetBounds ¶
func (m *DistributionValue_BucketOptions_Explicit) GetBounds() []float64
func (*DistributionValue_BucketOptions_Explicit) ProtoMessage ¶
func (*DistributionValue_BucketOptions_Explicit) ProtoMessage()
func (*DistributionValue_BucketOptions_Explicit) Reset ¶
func (m *DistributionValue_BucketOptions_Explicit) Reset()
func (*DistributionValue_BucketOptions_Explicit) String ¶
func (m *DistributionValue_BucketOptions_Explicit) String() string
func (*DistributionValue_BucketOptions_Explicit) XXX_DiscardUnknown ¶
func (m *DistributionValue_BucketOptions_Explicit) XXX_DiscardUnknown()
func (*DistributionValue_BucketOptions_Explicit) XXX_Marshal ¶
func (m *DistributionValue_BucketOptions_Explicit) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DistributionValue_BucketOptions_Explicit) XXX_Merge ¶
func (m *DistributionValue_BucketOptions_Explicit) XXX_Merge(src proto.Message)
func (*DistributionValue_BucketOptions_Explicit) XXX_Size ¶
func (m *DistributionValue_BucketOptions_Explicit) XXX_Size() int
func (*DistributionValue_BucketOptions_Explicit) XXX_Unmarshal ¶
func (m *DistributionValue_BucketOptions_Explicit) XXX_Unmarshal(b []byte) error
type DistributionValue_BucketOptions_Explicit_ ¶
type DistributionValue_BucketOptions_Explicit_ struct {
Explicit *DistributionValue_BucketOptions_Explicit `protobuf:"bytes,1,opt,name=explicit,proto3,oneof"`
}
type DistributionValue_Exemplar ¶
type DistributionValue_Exemplar struct { // Value of the exemplar point. It determines which bucket the exemplar // belongs to. Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"` // The observation (sampling) time of the above value. Timestamp *timestamp.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // Contextual information about the example value. Attachments map[string]string `` /* 163-byte string literal not displayed */ XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Exemplars are example points that may be used to annotate aggregated Distribution values. They are metadata that gives information about a particular value added to a Distribution bucket.
func (*DistributionValue_Exemplar) Descriptor ¶
func (*DistributionValue_Exemplar) Descriptor() ([]byte, []int)
func (*DistributionValue_Exemplar) GetAttachments ¶
func (m *DistributionValue_Exemplar) GetAttachments() map[string]string
func (*DistributionValue_Exemplar) GetTimestamp ¶
func (m *DistributionValue_Exemplar) GetTimestamp() *timestamp.Timestamp
func (*DistributionValue_Exemplar) GetValue ¶
func (m *DistributionValue_Exemplar) GetValue() float64
func (*DistributionValue_Exemplar) ProtoMessage ¶
func (*DistributionValue_Exemplar) ProtoMessage()
func (*DistributionValue_Exemplar) Reset ¶
func (m *DistributionValue_Exemplar) Reset()
func (*DistributionValue_Exemplar) String ¶
func (m *DistributionValue_Exemplar) String() string
func (*DistributionValue_Exemplar) XXX_DiscardUnknown ¶
func (m *DistributionValue_Exemplar) XXX_DiscardUnknown()
func (*DistributionValue_Exemplar) XXX_Marshal ¶
func (m *DistributionValue_Exemplar) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*DistributionValue_Exemplar) XXX_Merge ¶
func (m *DistributionValue_Exemplar) XXX_Merge(src proto.Message)
func (*DistributionValue_Exemplar) XXX_Size ¶
func (m *DistributionValue_Exemplar) XXX_Size() int
func (*DistributionValue_Exemplar) XXX_Unmarshal ¶
func (m *DistributionValue_Exemplar) XXX_Unmarshal(b []byte) error
type LabelKey ¶
type LabelKey struct { // The key for the label. Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // A human-readable description of what this label key represents. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Defines a label key associated with a metric descriptor.
func (*LabelKey) XXX_Marshal ¶
type LabelValue ¶
type LabelValue struct { // The value for the label. Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // If false the value field is ignored and considered not set. // This is used to differentiate a missing label from an empty string. HasValue bool `protobuf:"varint,2,opt,name=has_value,json=hasValue,proto3" json:"has_value,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
func (*LabelValue) Descriptor ¶
func (*LabelValue) Descriptor() ([]byte, []int)
func (*LabelValue) GetHasValue ¶
func (m *LabelValue) GetHasValue() bool
func (*LabelValue) GetValue ¶
func (m *LabelValue) GetValue() string
func (*LabelValue) ProtoMessage ¶
func (*LabelValue) ProtoMessage()
func (*LabelValue) Reset ¶
func (m *LabelValue) Reset()
func (*LabelValue) String ¶
func (m *LabelValue) String() string
func (*LabelValue) XXX_DiscardUnknown ¶
func (m *LabelValue) XXX_DiscardUnknown()
func (*LabelValue) XXX_Marshal ¶
func (m *LabelValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*LabelValue) XXX_Merge ¶
func (m *LabelValue) XXX_Merge(src proto.Message)
func (*LabelValue) XXX_Size ¶
func (m *LabelValue) XXX_Size() int
func (*LabelValue) XXX_Unmarshal ¶
func (m *LabelValue) XXX_Unmarshal(b []byte) error
type Metric ¶
type Metric struct { // The descriptor of the Metric. // TODO(issue #152): consider only sending the name of descriptor for // optimization. MetricDescriptor *MetricDescriptor `protobuf:"bytes,1,opt,name=metric_descriptor,json=metricDescriptor,proto3" json:"metric_descriptor,omitempty"` // One or more timeseries for a single metric, where each timeseries has // one or more points. Timeseries []*TimeSeries `protobuf:"bytes,2,rep,name=timeseries,proto3" json:"timeseries,omitempty"` // The resource for the metric. If unset, it may be set to a default value // provided for a sequence of messages in an RPC stream. Resource *v1.Resource `protobuf:"bytes,3,opt,name=resource,proto3" json:"resource,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Defines a Metric which has one or more timeseries.
func (*Metric) GetMetricDescriptor ¶
func (m *Metric) GetMetricDescriptor() *MetricDescriptor
func (*Metric) GetTimeseries ¶
func (m *Metric) GetTimeseries() []*TimeSeries
func (*Metric) XXX_Marshal ¶
type MetricDescriptor ¶
type MetricDescriptor struct { // The metric type, including its DNS name prefix. It must be unique. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // A detailed description of the metric, which can be used in documentation. Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"` // The 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 MetricDescriptor_Type `protobuf:"varint,4,opt,name=type,proto3,enum=opencensus.proto.metrics.v1.MetricDescriptor_Type" json:"type,omitempty"` // The label keys associated with the metric descriptor. LabelKeys []*LabelKey `protobuf:"bytes,5,rep,name=label_keys,json=labelKeys,proto3" json:"label_keys,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
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) GetLabelKeys ¶
func (m *MetricDescriptor) GetLabelKeys() []*LabelKey
func (*MetricDescriptor) GetName ¶
func (m *MetricDescriptor) GetName() string
func (*MetricDescriptor) GetType ¶
func (m *MetricDescriptor) GetType() MetricDescriptor_Type
func (*MetricDescriptor) GetUnit ¶
func (m *MetricDescriptor) GetUnit() string
func (*MetricDescriptor) ProtoMessage ¶
func (*MetricDescriptor) ProtoMessage()
func (*MetricDescriptor) Reset ¶
func (m *MetricDescriptor) Reset()
func (*MetricDescriptor) String ¶
func (m *MetricDescriptor) String() string
func (*MetricDescriptor) XXX_DiscardUnknown ¶
func (m *MetricDescriptor) XXX_DiscardUnknown()
func (*MetricDescriptor) XXX_Marshal ¶
func (m *MetricDescriptor) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*MetricDescriptor) XXX_Merge ¶
func (m *MetricDescriptor) XXX_Merge(src proto.Message)
func (*MetricDescriptor) XXX_Size ¶
func (m *MetricDescriptor) XXX_Size() int
func (*MetricDescriptor) XXX_Unmarshal ¶
func (m *MetricDescriptor) XXX_Unmarshal(b []byte) error
type MetricDescriptor_Type ¶
type MetricDescriptor_Type int32
The kind of metric. It describes how the data is reported.
A gauge is an instantaneous measurement of a value.
A cumulative measurement is a value accumulated over a time interval. In a time series, cumulative measurements should have the same start time, increasing values and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
const ( // Do not use this default value. MetricDescriptor_UNSPECIFIED MetricDescriptor_Type = 0 // Integer gauge. The value can go both up and down. MetricDescriptor_GAUGE_INT64 MetricDescriptor_Type = 1 // Floating point gauge. The value can go both up and down. MetricDescriptor_GAUGE_DOUBLE MetricDescriptor_Type = 2 // Distribution gauge measurement. The count and sum can go both up and // down. Recorded values are always >= 0. // Used in scenarios like a snapshot of time the current items in a queue // have spent there. MetricDescriptor_GAUGE_DISTRIBUTION MetricDescriptor_Type = 3 // Integer cumulative measurement. The value cannot decrease, if resets // then the start_time should also be reset. MetricDescriptor_CUMULATIVE_INT64 MetricDescriptor_Type = 4 // Floating point cumulative measurement. The value cannot decrease, if // resets then the start_time should also be reset. Recorded values are // always >= 0. MetricDescriptor_CUMULATIVE_DOUBLE MetricDescriptor_Type = 5 // Distribution cumulative measurement. The count and sum cannot decrease, // if resets then the start_time should also be reset. MetricDescriptor_CUMULATIVE_DISTRIBUTION MetricDescriptor_Type = 6 // 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. This is not recommended, since it cannot be aggregated. MetricDescriptor_SUMMARY MetricDescriptor_Type = 7 )
func (MetricDescriptor_Type) EnumDescriptor ¶
func (MetricDescriptor_Type) EnumDescriptor() ([]byte, []int)
func (MetricDescriptor_Type) String ¶
func (x MetricDescriptor_Type) String() string
type Point ¶
type Point struct { // The moment when this point was recorded. Inclusive. // If not specified, the timestamp will be decided by the backend. Timestamp *timestamp.Timestamp `protobuf:"bytes,1,opt,name=timestamp,proto3" json:"timestamp,omitempty"` // The actual point value. // // Types that are valid to be assigned to Value: // *Point_Int64Value // *Point_DoubleValue // *Point_DistributionValue // *Point_SummaryValue Value isPoint_Value `protobuf_oneof:"value"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A timestamped measurement.
func (*Point) GetDistributionValue ¶
func (m *Point) GetDistributionValue() *DistributionValue
func (*Point) GetSummaryValue ¶
func (m *Point) GetSummaryValue() *SummaryValue
func (*Point) XXX_Marshal ¶
type Point_DistributionValue ¶
type Point_DistributionValue struct {
DistributionValue *DistributionValue `protobuf:"bytes,4,opt,name=distribution_value,json=distributionValue,proto3,oneof"`
}
type Point_DoubleValue ¶
type Point_DoubleValue struct {
DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}
type Point_Int64Value ¶
type Point_Int64Value struct {
Int64Value int64 `protobuf:"varint,2,opt,name=int64_value,json=int64Value,proto3,oneof"`
}
type Point_SummaryValue ¶
type Point_SummaryValue struct {
SummaryValue *SummaryValue `protobuf:"bytes,5,opt,name=summary_value,json=summaryValue,proto3,oneof"`
}
type SummaryValue ¶
type SummaryValue struct { // The total number of recorded values since start_time. Optional since // some systems don't expose this. Count *wrappers.Int64Value `protobuf:"bytes,1,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. // This field must be unset if the sum is not available. Sum *wrappers.DoubleValue `protobuf:"bytes,2,opt,name=sum,proto3" json:"sum,omitempty"` // Values calculated over an arbitrary time window. Snapshot *SummaryValue_Snapshot `protobuf:"bytes,3,opt,name=snapshot,proto3" json:"snapshot,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The start_timestamp only applies to the count and sum in the SummaryValue.
func (*SummaryValue) Descriptor ¶
func (*SummaryValue) Descriptor() ([]byte, []int)
func (*SummaryValue) GetCount ¶
func (m *SummaryValue) GetCount() *wrappers.Int64Value
func (*SummaryValue) GetSnapshot ¶
func (m *SummaryValue) GetSnapshot() *SummaryValue_Snapshot
func (*SummaryValue) GetSum ¶
func (m *SummaryValue) GetSum() *wrappers.DoubleValue
func (*SummaryValue) ProtoMessage ¶
func (*SummaryValue) ProtoMessage()
func (*SummaryValue) Reset ¶
func (m *SummaryValue) Reset()
func (*SummaryValue) String ¶
func (m *SummaryValue) String() string
func (*SummaryValue) XXX_DiscardUnknown ¶
func (m *SummaryValue) XXX_DiscardUnknown()
func (*SummaryValue) XXX_Marshal ¶
func (m *SummaryValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SummaryValue) XXX_Merge ¶
func (m *SummaryValue) XXX_Merge(src proto.Message)
func (*SummaryValue) XXX_Size ¶
func (m *SummaryValue) XXX_Size() int
func (*SummaryValue) XXX_Unmarshal ¶
func (m *SummaryValue) XXX_Unmarshal(b []byte) error
type SummaryValue_Snapshot ¶
type SummaryValue_Snapshot struct { // The number of values in the snapshot. Optional since some systems don't // expose this. Count *wrappers.Int64Value `protobuf:"bytes,1,opt,name=count,proto3" json:"count,omitempty"` // The sum of values in the snapshot. Optional since some systems don't // expose this. If count is zero then this field must be zero or not set // (if not supported). Sum *wrappers.DoubleValue `protobuf:"bytes,2,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 []*SummaryValue_Snapshot_ValueAtPercentile `protobuf:"bytes,3,rep,name=percentile_values,json=percentileValues,proto3" json:"percentile_values,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
The values in this message can be reset at arbitrary unknown times, with the requirement that all of them are reset at the same time.
func (*SummaryValue_Snapshot) Descriptor ¶
func (*SummaryValue_Snapshot) Descriptor() ([]byte, []int)
func (*SummaryValue_Snapshot) GetCount ¶
func (m *SummaryValue_Snapshot) GetCount() *wrappers.Int64Value
func (*SummaryValue_Snapshot) GetPercentileValues ¶
func (m *SummaryValue_Snapshot) GetPercentileValues() []*SummaryValue_Snapshot_ValueAtPercentile
func (*SummaryValue_Snapshot) GetSum ¶
func (m *SummaryValue_Snapshot) GetSum() *wrappers.DoubleValue
func (*SummaryValue_Snapshot) ProtoMessage ¶
func (*SummaryValue_Snapshot) ProtoMessage()
func (*SummaryValue_Snapshot) Reset ¶
func (m *SummaryValue_Snapshot) Reset()
func (*SummaryValue_Snapshot) String ¶
func (m *SummaryValue_Snapshot) String() string
func (*SummaryValue_Snapshot) XXX_DiscardUnknown ¶
func (m *SummaryValue_Snapshot) XXX_DiscardUnknown()
func (*SummaryValue_Snapshot) XXX_Marshal ¶
func (m *SummaryValue_Snapshot) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SummaryValue_Snapshot) XXX_Merge ¶
func (m *SummaryValue_Snapshot) XXX_Merge(src proto.Message)
func (*SummaryValue_Snapshot) XXX_Size ¶
func (m *SummaryValue_Snapshot) XXX_Size() int
func (*SummaryValue_Snapshot) XXX_Unmarshal ¶
func (m *SummaryValue_Snapshot) XXX_Unmarshal(b []byte) error
type SummaryValue_Snapshot_ValueAtPercentile ¶
type SummaryValue_Snapshot_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"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
Represents the value at a given percentile of a distribution.
func (*SummaryValue_Snapshot_ValueAtPercentile) Descriptor ¶
func (*SummaryValue_Snapshot_ValueAtPercentile) Descriptor() ([]byte, []int)
func (*SummaryValue_Snapshot_ValueAtPercentile) GetPercentile ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) GetPercentile() float64
func (*SummaryValue_Snapshot_ValueAtPercentile) GetValue ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) GetValue() float64
func (*SummaryValue_Snapshot_ValueAtPercentile) ProtoMessage ¶
func (*SummaryValue_Snapshot_ValueAtPercentile) ProtoMessage()
func (*SummaryValue_Snapshot_ValueAtPercentile) Reset ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) Reset()
func (*SummaryValue_Snapshot_ValueAtPercentile) String ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) String() string
func (*SummaryValue_Snapshot_ValueAtPercentile) XXX_DiscardUnknown ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_DiscardUnknown()
func (*SummaryValue_Snapshot_ValueAtPercentile) XXX_Marshal ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*SummaryValue_Snapshot_ValueAtPercentile) XXX_Merge ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Merge(src proto.Message)
func (*SummaryValue_Snapshot_ValueAtPercentile) XXX_Size ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Size() int
func (*SummaryValue_Snapshot_ValueAtPercentile) XXX_Unmarshal ¶
func (m *SummaryValue_Snapshot_ValueAtPercentile) XXX_Unmarshal(b []byte) error
type TimeSeries ¶
type TimeSeries struct { // Must be present for cumulative metrics. The time when the cumulative value // was reset to zero. Exclusive. The cumulative value is over the time interval // (start_timestamp, timestamp]. If not specified, the backend can use the // previous recorded value. StartTimestamp *timestamp.Timestamp `protobuf:"bytes,1,opt,name=start_timestamp,json=startTimestamp,proto3" json:"start_timestamp,omitempty"` // The set of label values that uniquely identify this timeseries. Applies to // all points. The order of label values must match that of label keys in the // metric descriptor. LabelValues []*LabelValue `protobuf:"bytes,2,rep,name=label_values,json=labelValues,proto3" json:"label_values,omitempty"` // The data points of this timeseries. Point.value type MUST match the // MetricDescriptor.type. Points []*Point `protobuf:"bytes,3,rep,name=points,proto3" json:"points,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` XXX_sizecache int32 `json:"-"` }
A collection of data points that describes the time-varying values of a metric.
func (*TimeSeries) Descriptor ¶
func (*TimeSeries) Descriptor() ([]byte, []int)
func (*TimeSeries) GetLabelValues ¶
func (m *TimeSeries) GetLabelValues() []*LabelValue
func (*TimeSeries) GetPoints ¶
func (m *TimeSeries) GetPoints() []*Point
func (*TimeSeries) GetStartTimestamp ¶
func (m *TimeSeries) GetStartTimestamp() *timestamp.Timestamp
func (*TimeSeries) ProtoMessage ¶
func (*TimeSeries) ProtoMessage()
func (*TimeSeries) Reset ¶
func (m *TimeSeries) Reset()
func (*TimeSeries) String ¶
func (m *TimeSeries) String() string
func (*TimeSeries) XXX_DiscardUnknown ¶
func (m *TimeSeries) XXX_DiscardUnknown()
func (*TimeSeries) XXX_Marshal ¶
func (m *TimeSeries) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*TimeSeries) XXX_Merge ¶
func (m *TimeSeries) XXX_Merge(src proto.Message)
func (*TimeSeries) XXX_Size ¶
func (m *TimeSeries) XXX_Size() int
func (*TimeSeries) XXX_Unmarshal ¶
func (m *TimeSeries) XXX_Unmarshal(b []byte) error