Package distribution

google/api/distribution.proto

Distribution

type Distribution ¶

Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram 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 specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).

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.
    Count int64 `protobuf:"varint,1,opt,name=count" 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" 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 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 `protobuf:"fixed64,3,opt,name=sum_of_squared_deviation,json=sumOfSquaredDeviation" 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" json:"range,omitempty"`
    // Defines the histogram bucket boundaries.
    BucketOptions *Distribution_BucketOptions `protobuf:"bytes,6,opt,name=bucket_options,json=bucketOptions" json:"bucket_options,omitempty"`
    // If `bucket_options` is given, then the sum of the values in `bucket_counts`
    // must equal the value in `count`.  If `bucket_options` is not given, no
    // `bucket_counts` fields may be given.
    //
    // Bucket counts are given in order under the numbering scheme described
    // above (the underflow bucket has number 0; the finite buckets, if any,
    // have numbers 1 through N-2; the overflow bucket has number N-1).
    //
    // The size of `bucket_counts` must be no greater than N as defined in
    // `bucket_options`.
    //
    // Any suffix of trailing zero bucket_count fields may be omitted.
    BucketCounts []int64 `protobuf:"varint,7,rep,packed,name=bucket_counts,json=bucketCounts" json:"bucket_counts,omitempty"`
}

func (*Distribution) Descriptor ¶

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

func (*Distribution) GetBucketCounts ¶

func (m *Distribution) GetBucketCounts() []int64

func (*Distribution) GetBucketOptions ¶

func (m *Distribution) GetBucketOptions() *Distribution_BucketOptions

func (*Distribution) GetCount ¶

func (m *Distribution) GetCount() int64

func (*Distribution) GetMean ¶

func (m *Distribution) GetMean() float64

func (*Distribution) GetRange ¶

func (m *Distribution) GetRange() *Distribution_Range

func (*Distribution) GetSumOfSquaredDeviation ¶

func (m *Distribution) GetSumOfSquaredDeviation() float64

func (*Distribution) ProtoMessage ¶

func (*Distribution) ProtoMessage()

func (*Distribution) Reset ¶

func (m *Distribution) Reset()

func (*Distribution) String ¶

func (m *Distribution) String() string

type Distribution_BucketOptions ¶

A Distribution may optionally contain a histogram of the values in the population. The histogram is given in `bucket_counts` as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by `bucket_options`.

A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is 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.

`BucketOptions` describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.

If `bucket_boundaries` is not given, then no `bucket_counts` may be given.

type Distribution_BucketOptions struct {
    // Exactly one of these three fields must be set.
    //
    // Types that are valid to be assigned to Options:
    //	*Distribution_BucketOptions_LinearBuckets
    //	*Distribution_BucketOptions_ExponentialBuckets
    //	*Distribution_BucketOptions_ExplicitBuckets
    Options isDistribution_BucketOptions_Options `protobuf_oneof:"options"`
}

func (*Distribution_BucketOptions) Descriptor ¶

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

func (*Distribution_BucketOptions) GetExplicitBuckets ¶

func (m *Distribution_BucketOptions) GetExplicitBuckets() *Distribution_BucketOptions_Explicit

func (*Distribution_BucketOptions) GetExponentialBuckets ¶

func (m *Distribution_BucketOptions) GetExponentialBuckets() *Distribution_BucketOptions_Exponential

func (*Distribution_BucketOptions) GetLinearBuckets ¶

func (m *Distribution_BucketOptions) GetLinearBuckets() *Distribution_BucketOptions_Linear

func (*Distribution_BucketOptions) GetOptions ¶

func (m *Distribution_BucketOptions) GetOptions() isDistribution_BucketOptions_Options

func (*Distribution_BucketOptions) ProtoMessage ¶

func (*Distribution_BucketOptions) ProtoMessage()

func (*Distribution_BucketOptions) Reset ¶

func (m *Distribution_BucketOptions) Reset()

func (*Distribution_BucketOptions) String ¶

func (m *Distribution_BucketOptions) String() string

func (*Distribution_BucketOptions) XXX_OneofFuncs ¶

func (*Distribution_BucketOptions) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Distribution_BucketOptions_Explicit ¶

A set of buckets with arbitrary widths.

Defines `size(bounds) + 1` (= N) buckets with these boundaries for bucket i:

Upper bound (0 <= i < N-1):     bounds[i]
Lower bound (1 <= i < N);       bounds[i - 1]

There must be at least one element in `bounds`. If `bounds` has only one element, 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" json:"bounds,omitempty"`
}

func (*Distribution_BucketOptions_Explicit) Descriptor ¶

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

func (*Distribution_BucketOptions_Explicit) GetBounds ¶

func (m *Distribution_BucketOptions_Explicit) GetBounds() []float64

func (*Distribution_BucketOptions_Explicit) ProtoMessage ¶

func (*Distribution_BucketOptions_Explicit) ProtoMessage()

func (*Distribution_BucketOptions_Explicit) Reset ¶

func (m *Distribution_BucketOptions_Explicit) Reset()

func (*Distribution_BucketOptions_Explicit) String ¶

func (m *Distribution_BucketOptions_Explicit) String() string

type Distribution_BucketOptions_ExplicitBuckets ¶

type Distribution_BucketOptions_ExplicitBuckets struct {
    ExplicitBuckets *Distribution_BucketOptions_Explicit `protobuf:"bytes,3,opt,name=explicit_buckets,json=explicitBuckets,oneof"`
}

type Distribution_BucketOptions_Exponential ¶

Specify a 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.

Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket i:

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" json:"num_finite_buckets,omitempty"`
    // Must be greater than 1.
    GrowthFactor float64 `protobuf:"fixed64,2,opt,name=growth_factor,json=growthFactor" json:"growth_factor,omitempty"`
    // Must be greater than 0.
    Scale float64 `protobuf:"fixed64,3,opt,name=scale" json:"scale,omitempty"`
}

func (*Distribution_BucketOptions_Exponential) Descriptor ¶

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

func (*Distribution_BucketOptions_Exponential) GetGrowthFactor ¶

func (m *Distribution_BucketOptions_Exponential) GetGrowthFactor() float64

func (*Distribution_BucketOptions_Exponential) GetNumFiniteBuckets ¶

func (m *Distribution_BucketOptions_Exponential) GetNumFiniteBuckets() int32

func (*Distribution_BucketOptions_Exponential) GetScale ¶

func (m *Distribution_BucketOptions_Exponential) GetScale() float64

func (*Distribution_BucketOptions_Exponential) ProtoMessage ¶

func (*Distribution_BucketOptions_Exponential) ProtoMessage()

func (*Distribution_BucketOptions_Exponential) Reset ¶

func (m *Distribution_BucketOptions_Exponential) Reset()

func (*Distribution_BucketOptions_Exponential) String ¶

func (m *Distribution_BucketOptions_Exponential) String() string

type Distribution_BucketOptions_ExponentialBuckets ¶

type Distribution_BucketOptions_ExponentialBuckets struct {
    ExponentialBuckets *Distribution_BucketOptions_Exponential `protobuf:"bytes,2,opt,name=exponential_buckets,json=exponentialBuckets,oneof"`
}

type Distribution_BucketOptions_Linear ¶

Specify a 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.

Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for bucket `i`:

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" json:"num_finite_buckets,omitempty"`
    // Must be greater than 0.
    Width float64 `protobuf:"fixed64,2,opt,name=width" json:"width,omitempty"`
    // Lower bound of the first bucket.
    Offset float64 `protobuf:"fixed64,3,opt,name=offset" json:"offset,omitempty"`
}

func (*Distribution_BucketOptions_Linear) Descriptor ¶

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

func (*Distribution_BucketOptions_Linear) GetNumFiniteBuckets ¶

func (m *Distribution_BucketOptions_Linear) GetNumFiniteBuckets() int32

func (*Distribution_BucketOptions_Linear) GetOffset ¶

func (m *Distribution_BucketOptions_Linear) GetOffset() float64

func (*Distribution_BucketOptions_Linear) GetWidth ¶

func (m *Distribution_BucketOptions_Linear) GetWidth() float64

func (*Distribution_BucketOptions_Linear) ProtoMessage ¶

func (*Distribution_BucketOptions_Linear) ProtoMessage()

func (*Distribution_BucketOptions_Linear) Reset ¶

func (m *Distribution_BucketOptions_Linear) Reset()

func (*Distribution_BucketOptions_Linear) String ¶

func (m *Distribution_BucketOptions_Linear) String() string

type Distribution_BucketOptions_LinearBuckets ¶

type Distribution_BucketOptions_LinearBuckets struct {
    LinearBuckets *Distribution_BucketOptions_Linear `protobuf:"bytes,1,opt,name=linear_buckets,json=linearBuckets,oneof"`
}

type Distribution_Range ¶

The range of the population values.

type Distribution_Range struct {
    // The minimum of the population values.
    Min float64 `protobuf:"fixed64,1,opt,name=min" json:"min,omitempty"`
    // The maximum of the population values.
    Max float64 `protobuf:"fixed64,2,opt,name=max" json:"max,omitempty"`
}

func (*Distribution_Range) Descriptor ¶

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

func (*Distribution_Range) GetMax ¶

func (m *Distribution_Range) GetMax() float64

func (*Distribution_Range) GetMin ¶

func (m *Distribution_Range) GetMin() float64

func (*Distribution_Range) ProtoMessage ¶

func (*Distribution_Range) ProtoMessage()

func (*Distribution_Range) Reset ¶

func (m *Distribution_Range) Reset()

func (*Distribution_Range) String ¶

func (m *Distribution_Range) String() string