var File_google_api_distribution_proto protoreflect.FileDescriptor
`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.
The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.
Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.
type Distribution 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 arithmetic mean of the values in the population. If `count` is zero
// then this field must be zero.
Mean float64 `protobuf:"fixed64,2,opt,name=mean,proto3" json:"mean,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 232, 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 `protobuf:"fixed64,3,opt,name=sum_of_squared_deviation,json=sumOfSquaredDeviation,proto3" json:"sum_of_squared_deviation,omitempty"`
// If specified, contains the range of the population values. The field
// must not be present if the `count` is zero.
Range *Distribution_Range `protobuf:"bytes,4,opt,name=range,proto3" json:"range,omitempty"`
// Defines the histogram bucket boundaries. If the distribution does not
// contain a histogram, then omit this field.
BucketOptions *Distribution_BucketOptions `protobuf:"bytes,6,opt,name=bucket_options,json=bucketOptions,proto3" json:"bucket_options,omitempty"`
// The number of values in each bucket of the histogram, as described in
// `bucket_options`. If the distribution does not have a histogram, then omit
// this field. If there is a histogram, then the sum of the values in
// `bucket_counts` must equal the value in the `count` field of the
// distribution.
//
// If present, `bucket_counts` should contain N values, where N is the number
// of buckets specified in `bucket_options`. If you supply fewer than N
// values, the remaining values are assumed to be 0.
//
// The order of the values in `bucket_counts` follows the bucket numbering
// schemes described for the three bucket types. The first value must be the
// count for the underflow bucket (number 0). The next N-2 values are the
// counts for the finite buckets (number 1 through N-2). The N'th value in
// `bucket_counts` is the count for the overflow bucket (number N-1).
BucketCounts []int64 `protobuf:"varint,7,rep,packed,name=bucket_counts,json=bucketCounts,proto3" json:"bucket_counts,omitempty"`
// Must be in increasing order of `value` field.
Exemplars []*Distribution_Exemplar `protobuf:"bytes,10,rep,name=exemplars,proto3" json:"exemplars,omitempty"`
// contains filtered or unexported fields
}
func (*Distribution) Descriptor() ([]byte, []int)
Deprecated: Use Distribution.ProtoReflect.Descriptor instead.
func (x *Distribution) GetBucketCounts() []int64
func (x *Distribution) GetBucketOptions() *Distribution_BucketOptions
func (x *Distribution) GetCount() int64
func (x *Distribution) GetExemplars() []*Distribution_Exemplar
func (x *Distribution) GetMean() float64
func (x *Distribution) GetRange() *Distribution_Range
func (x *Distribution) GetSumOfSquaredDeviation() float64
func (*Distribution) ProtoMessage()
func (x *Distribution) ProtoReflect() protoreflect.Message
func (x *Distribution) Reset()
func (x *Distribution) String() string
`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket.
A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
type Distribution_BucketOptions struct {
// Exactly one of these three fields must be set.
//
// Types that are assignable to Options:
//
// *Distribution_BucketOptions_LinearBuckets
// *Distribution_BucketOptions_ExponentialBuckets
// *Distribution_BucketOptions_ExplicitBuckets
Options isDistribution_BucketOptions_Options `protobuf_oneof:"options"`
// contains filtered or unexported fields
}
func (*Distribution_BucketOptions) Descriptor() ([]byte, []int)
Deprecated: Use Distribution_BucketOptions.ProtoReflect.Descriptor instead.
func (x *Distribution_BucketOptions) GetExplicitBuckets() *Distribution_BucketOptions_Explicit
func (x *Distribution_BucketOptions) GetExponentialBuckets() *Distribution_BucketOptions_Exponential
func (x *Distribution_BucketOptions) GetLinearBuckets() *Distribution_BucketOptions_Linear
func (m *Distribution_BucketOptions) GetOptions() isDistribution_BucketOptions_Options
func (*Distribution_BucketOptions) ProtoMessage()
func (x *Distribution_BucketOptions) ProtoReflect() protoreflect.Message
func (x *Distribution_BucketOptions) Reset()
func (x *Distribution_BucketOptions) String() string
Specifies a set of buckets with arbitrary widths.
There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries:
Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1]
The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
type Distribution_BucketOptions_Explicit struct {
// The values must be monotonically increasing.
Bounds []float64 `protobuf:"fixed64,1,rep,packed,name=bounds,proto3" json:"bounds,omitempty"`
// contains filtered or unexported fields
}
func (*Distribution_BucketOptions_Explicit) Descriptor() ([]byte, []int)
Deprecated: Use Distribution_BucketOptions_Explicit.ProtoReflect.Descriptor instead.
func (x *Distribution_BucketOptions_Explicit) GetBounds() []float64
func (*Distribution_BucketOptions_Explicit) ProtoMessage()
func (x *Distribution_BucketOptions_Explicit) ProtoReflect() protoreflect.Message
func (x *Distribution_BucketOptions_Explicit) Reset()
func (x *Distribution_BucketOptions_Explicit) String() string
type Distribution_BucketOptions_ExplicitBuckets struct {
// The explicit buckets.
ExplicitBuckets *Distribution_BucketOptions_Explicit `protobuf:"bytes,3,opt,name=explicit_buckets,json=explicitBuckets,proto3,oneof"`
}
Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.
There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries:
Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
type Distribution_BucketOptions_Exponential struct {
// Must be greater than 0.
NumFiniteBuckets int32 `protobuf:"varint,1,opt,name=num_finite_buckets,json=numFiniteBuckets,proto3" json:"num_finite_buckets,omitempty"`
// Must be greater than 1.
GrowthFactor float64 `protobuf:"fixed64,2,opt,name=growth_factor,json=growthFactor,proto3" json:"growth_factor,omitempty"`
// Must be greater than 0.
Scale float64 `protobuf:"fixed64,3,opt,name=scale,proto3" json:"scale,omitempty"`
// contains filtered or unexported fields
}
func (*Distribution_BucketOptions_Exponential) Descriptor() ([]byte, []int)
Deprecated: Use Distribution_BucketOptions_Exponential.ProtoReflect.Descriptor instead.
func (x *Distribution_BucketOptions_Exponential) GetGrowthFactor() float64
func (x *Distribution_BucketOptions_Exponential) GetNumFiniteBuckets() int32
func (x *Distribution_BucketOptions_Exponential) GetScale() float64
func (*Distribution_BucketOptions_Exponential) ProtoMessage()
func (x *Distribution_BucketOptions_Exponential) ProtoReflect() protoreflect.Message
func (x *Distribution_BucketOptions_Exponential) Reset()
func (x *Distribution_BucketOptions_Exponential) String() string
type Distribution_BucketOptions_ExponentialBuckets struct {
// The exponential buckets.
ExponentialBuckets *Distribution_BucketOptions_Exponential `protobuf:"bytes,2,opt,name=exponential_buckets,json=exponentialBuckets,proto3,oneof"`
}
Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.
There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries:
Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
type Distribution_BucketOptions_Linear struct {
// Must be greater than 0.
NumFiniteBuckets int32 `protobuf:"varint,1,opt,name=num_finite_buckets,json=numFiniteBuckets,proto3" json:"num_finite_buckets,omitempty"`
// Must be greater than 0.
Width float64 `protobuf:"fixed64,2,opt,name=width,proto3" json:"width,omitempty"`
// Lower bound of the first bucket.
Offset float64 `protobuf:"fixed64,3,opt,name=offset,proto3" json:"offset,omitempty"`
// contains filtered or unexported fields
}
func (*Distribution_BucketOptions_Linear) Descriptor() ([]byte, []int)
Deprecated: Use Distribution_BucketOptions_Linear.ProtoReflect.Descriptor instead.
func (x *Distribution_BucketOptions_Linear) GetNumFiniteBuckets() int32
func (x *Distribution_BucketOptions_Linear) GetOffset() float64
func (x *Distribution_BucketOptions_Linear) GetWidth() float64
func (*Distribution_BucketOptions_Linear) ProtoMessage()
func (x *Distribution_BucketOptions_Linear) ProtoReflect() protoreflect.Message
func (x *Distribution_BucketOptions_Linear) Reset()
func (x *Distribution_BucketOptions_Linear) String() string
type Distribution_BucketOptions_LinearBuckets struct {
// The linear bucket.
LinearBuckets *Distribution_BucketOptions_Linear `protobuf:"bytes,1,opt,name=linear_buckets,json=linearBuckets,proto3,oneof"`
}
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, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.
type Distribution_Exemplar struct {
// Value of the exemplar point. This value determines to which bucket the
// exemplar belongs.
Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
// The observation (sampling) time of the above value.
Timestamp *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// Contextual information about the example value. Examples are:
//
// Trace: type.googleapis.com/google.monitoring.v3.SpanContext
//
// Literal string: type.googleapis.com/google.protobuf.StringValue
//
// Labels dropped during aggregation:
// type.googleapis.com/google.monitoring.v3.DroppedLabels
//
// There may be only a single attachment of any given message type in a
// single exemplar, and this is enforced by the system.
Attachments []*anypb.Any `protobuf:"bytes,3,rep,name=attachments,proto3" json:"attachments,omitempty"`
// contains filtered or unexported fields
}
func (*Distribution_Exemplar) Descriptor() ([]byte, []int)
Deprecated: Use Distribution_Exemplar.ProtoReflect.Descriptor instead.
func (x *Distribution_Exemplar) GetAttachments() []*anypb.Any
func (x *Distribution_Exemplar) GetTimestamp() *timestamppb.Timestamp
func (x *Distribution_Exemplar) GetValue() float64
func (*Distribution_Exemplar) ProtoMessage()
func (x *Distribution_Exemplar) ProtoReflect() protoreflect.Message
func (x *Distribution_Exemplar) Reset()
func (x *Distribution_Exemplar) String() string
The range of the population values.
type Distribution_Range struct {
// The minimum of the population values.
Min float64 `protobuf:"fixed64,1,opt,name=min,proto3" json:"min,omitempty"`
// The maximum of the population values.
Max float64 `protobuf:"fixed64,2,opt,name=max,proto3" json:"max,omitempty"`
// contains filtered or unexported fields
}
func (*Distribution_Range) Descriptor() ([]byte, []int)
Deprecated: Use Distribution_Range.ProtoReflect.Descriptor instead.
func (x *Distribution_Range) GetMax() float64
func (x *Distribution_Range) GetMin() float64
func (*Distribution_Range) ProtoMessage()
func (x *Distribution_Range) ProtoReflect() protoreflect.Message
func (x *Distribution_Range) Reset()
func (x *Distribution_Range) String() string