Documentation

Index

Constants

View Source
const (
	Default_ExponentialBuckets_ScaleFactor = float32(1)
	Default_ExponentialBuckets_Base        = float32(2)
	Default_ExponentialBuckets_NumBuckets  = uint32(20)
)

    Default values for ExponentialBuckets fields.

    Variables

    View Source
    var File_github_com_google_cloudprober_metrics_proto_dist_proto protoreflect.FileDescriptor

    Functions

    This section is empty.

    Types

    type Dist

    type Dist struct {
    
    	// Types that are assignable to Buckets:
    	//	*Dist_ExplicitBuckets
    	//	*Dist_ExponentialBuckets
    	Buckets isDist_Buckets `protobuf_oneof:"buckets"`
    	// contains filtered or unexported fields
    }

      Dist defines a Distribution data type.

      func (*Dist) Descriptor

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

        Deprecated: Use Dist.ProtoReflect.Descriptor instead.

        func (*Dist) GetBuckets

        func (m *Dist) GetBuckets() isDist_Buckets

        func (*Dist) GetExplicitBuckets

        func (x *Dist) GetExplicitBuckets() string

        func (*Dist) GetExponentialBuckets

        func (x *Dist) GetExponentialBuckets() *ExponentialBuckets

        func (*Dist) ProtoMessage

        func (*Dist) ProtoMessage()

        func (*Dist) ProtoReflect

        func (x *Dist) ProtoReflect() protoreflect.Message

        func (*Dist) Reset

        func (x *Dist) Reset()

        func (*Dist) String

        func (x *Dist) String() string

        type Dist_ExplicitBuckets

        type Dist_ExplicitBuckets struct {
        	// Comma-separated list of lower bounds, where each lower bound is a float
        	// value. Example: 0.5,1,2,4,8.
        	ExplicitBuckets string `protobuf:"bytes,1,opt,name=explicit_buckets,json=explicitBuckets,oneof"`
        }

        type Dist_ExponentialBuckets

        type Dist_ExponentialBuckets struct {
        	// Exponentially growing buckets
        	ExponentialBuckets *ExponentialBuckets `protobuf:"bytes,2,opt,name=exponential_buckets,json=exponentialBuckets,oneof"`
        }

        type ExponentialBuckets

        type ExponentialBuckets struct {
        	ScaleFactor *float32 `protobuf:"fixed32,1,opt,name=scale_factor,json=scaleFactor,def=1" json:"scale_factor,omitempty"`
        	Base        *float32 `protobuf:"fixed32,2,opt,name=base,def=2" json:"base,omitempty"`
        	NumBuckets  *uint32  `protobuf:"varint,3,opt,name=num_buckets,json=numBuckets,def=20" json:"num_buckets,omitempty"`
        	// contains filtered or unexported fields
        }

          ExponentialBucket defines a set of num_buckets+2 buckets:

          bucket[0] covers (−Inf, 0)
          bucket[1] covers [0, scale_factor)
          bucket[2] covers [scale_factor, scale_factor*base)
          ...
          bucket[i] covers [scale_factor*base^(i−2), scale_factor*base^(i−1))
          ...
          bucket[num_buckets+1] covers [scale_factor*base^(num_buckets−1), +Inf)
          

          NB: Base must be at least 1.01.

          func (*ExponentialBuckets) Descriptor

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

            Deprecated: Use ExponentialBuckets.ProtoReflect.Descriptor instead.

            func (*ExponentialBuckets) GetBase

            func (x *ExponentialBuckets) GetBase() float32

            func (*ExponentialBuckets) GetNumBuckets

            func (x *ExponentialBuckets) GetNumBuckets() uint32

            func (*ExponentialBuckets) GetScaleFactor

            func (x *ExponentialBuckets) GetScaleFactor() float32

            func (*ExponentialBuckets) ProtoMessage

            func (*ExponentialBuckets) ProtoMessage()

            func (*ExponentialBuckets) ProtoReflect

            func (x *ExponentialBuckets) ProtoReflect() protoreflect.Message

            func (*ExponentialBuckets) Reset

            func (x *ExponentialBuckets) Reset()

            func (*ExponentialBuckets) String

            func (x *ExponentialBuckets) String() string

            Source Files