v1

package
v0.4.1 Latest Latest
Warning

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

Go to latest
Published: Sep 23, 2022 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Measure_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "INT64",
		2: "DOUBLE",
	}
	Measure_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"INT64":            1,
		"DOUBLE":           2,
	}
)

Enum value maps for Measure_Type.

View Source
var File_opencensus_proto_stats_v1_stats_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CountAggregation

type CountAggregation struct {
	// contains filtered or unexported fields
}

func (*CountAggregation) Descriptor deprecated

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

Deprecated: Use CountAggregation.ProtoReflect.Descriptor instead.

func (*CountAggregation) ProtoMessage

func (*CountAggregation) ProtoMessage()

func (*CountAggregation) ProtoReflect added in v0.3.0

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

func (*CountAggregation) Reset

func (x *CountAggregation) Reset()

func (*CountAggregation) String

func (x *CountAggregation) String() string

type DistributionAggregation

type DistributionAggregation struct {

	// A Distribution may optionally contain a histogram of the values in the
	// population. The bucket boundaries for that histogram are described by
	// `bucket_bounds`. This defines `size(bucket_bounds) + 1` (= N)
	// buckets. The boundaries for bucket index i are:
	//
	// (-infinity, bucket_bounds[i]) for i == 0
	// [bucket_bounds[i-1], bucket_bounds[i]) for 0 < i < N-2
	// [bucket_bounds[i-1], +infinity) for i == N-1
	//
	// i.e. an underflow bucket (number 0), zero or more finite buckets (1
	// through N - 2, and an overflow bucket (N - 1), with inclusive lower
	// bounds and exclusive upper bounds.
	//
	// If `bucket_bounds` has no elements (zero size), then there is no
	// histogram associated with the Distribution. If `bucket_bounds` has only
	// one element, there are no finite buckets, and that single element is the
	// common boundary of the overflow and underflow buckets. The values must
	// be monotonically increasing.
	BucketBounds []float64 `protobuf:"fixed64,1,rep,packed,name=bucket_bounds,json=bucketBounds,proto3" json:"bucket_bounds,omitempty"`
	// contains filtered or unexported fields
}

func (*DistributionAggregation) Descriptor deprecated

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

Deprecated: Use DistributionAggregation.ProtoReflect.Descriptor instead.

func (*DistributionAggregation) GetBucketBounds

func (x *DistributionAggregation) GetBucketBounds() []float64

func (*DistributionAggregation) ProtoMessage

func (*DistributionAggregation) ProtoMessage()

func (*DistributionAggregation) ProtoReflect added in v0.3.0

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

func (*DistributionAggregation) Reset

func (x *DistributionAggregation) Reset()

func (*DistributionAggregation) String

func (x *DistributionAggregation) String() string

type LastValueAggregation

type LastValueAggregation struct {
	// contains filtered or unexported fields
}

func (*LastValueAggregation) Descriptor deprecated

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

Deprecated: Use LastValueAggregation.ProtoReflect.Descriptor instead.

func (*LastValueAggregation) ProtoMessage

func (*LastValueAggregation) ProtoMessage()

func (*LastValueAggregation) ProtoReflect added in v0.3.0

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

func (*LastValueAggregation) Reset

func (x *LastValueAggregation) Reset()

func (*LastValueAggregation) String

func (x *LastValueAggregation) String() string

type Measure

type Measure struct {

	// A string by which the measure will be referred to, e.g. "rpc_server_latency". Names MUST be
	// unique within the library.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Describes the measure, e.g. "RPC latency in seconds".
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Describes the unit used for the Measure. Follows the format described by
	// http://unitsofmeasure.org/ucum.html.
	Unit string `protobuf:"bytes,3,opt,name=unit,proto3" json:"unit,omitempty"`
	// The type used for this Measure.
	Type Measure_Type `protobuf:"varint,4,opt,name=type,proto3,enum=opencensus.proto.stats.v1.Measure_Type" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Measure .

func (*Measure) Descriptor deprecated

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

Deprecated: Use Measure.ProtoReflect.Descriptor instead.

func (*Measure) GetDescription

func (x *Measure) GetDescription() string

func (*Measure) GetName

func (x *Measure) GetName() string

func (*Measure) GetType

func (x *Measure) GetType() Measure_Type

func (*Measure) GetUnit

func (x *Measure) GetUnit() string

func (*Measure) ProtoMessage

func (*Measure) ProtoMessage()

func (*Measure) ProtoReflect added in v0.3.0

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

func (*Measure) Reset

func (x *Measure) Reset()

func (*Measure) String

func (x *Measure) String() string

type Measure_Type

type Measure_Type int32
const (
	// Unknown type.
	Measure_TYPE_UNSPECIFIED Measure_Type = 0
	// Indicates an int64 Measure.
	Measure_INT64 Measure_Type = 1
	// Indicates a double Measure.
	Measure_DOUBLE Measure_Type = 2
)

func (Measure_Type) Descriptor added in v0.3.0

func (Measure_Type) Enum added in v0.3.0

func (x Measure_Type) Enum() *Measure_Type

func (Measure_Type) EnumDescriptor deprecated

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

Deprecated: Use Measure_Type.Descriptor instead.

func (Measure_Type) Number added in v0.3.0

func (Measure_Type) String

func (x Measure_Type) String() string

func (Measure_Type) Type added in v0.3.0

type Measurement

type Measurement struct {
	Tags []*Tag `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"`
	// The name of the measure to which the value is applied.
	MeasureName string `protobuf:"bytes,2,opt,name=measure_name,json=measureName,proto3" json:"measure_name,omitempty"`
	// The recorded value, MUST have the appropriate type to match the Measure.
	//
	// Types that are assignable to Value:
	//	*Measurement_DoubleValue
	//	*Measurement_IntValue
	Value isMeasurement_Value `protobuf_oneof:"value"`
	// The time when this measurement was recorded. If the implementation uses a async buffer to
	// record measurements this may be the time when the measurement was read from the buffer.
	Time *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=time,proto3" json:"time,omitempty"`
	// contains filtered or unexported fields
}

Describes a data point to be collected for a Measure.

func (*Measurement) Descriptor deprecated

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

Deprecated: Use Measurement.ProtoReflect.Descriptor instead.

func (*Measurement) GetDoubleValue

func (x *Measurement) GetDoubleValue() float64

func (*Measurement) GetIntValue

func (x *Measurement) GetIntValue() int64

func (*Measurement) GetMeasureName

func (x *Measurement) GetMeasureName() string

func (*Measurement) GetTags

func (x *Measurement) GetTags() []*Tag

func (*Measurement) GetTime

func (x *Measurement) GetTime() *timestamppb.Timestamp

func (*Measurement) GetValue

func (m *Measurement) GetValue() isMeasurement_Value

func (*Measurement) ProtoMessage

func (*Measurement) ProtoMessage()

func (*Measurement) ProtoReflect added in v0.3.0

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

func (*Measurement) Reset

func (x *Measurement) Reset()

func (*Measurement) String

func (x *Measurement) String() string

type Measurement_DoubleValue

type Measurement_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,3,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type Measurement_IntValue

type Measurement_IntValue struct {
	IntValue int64 `protobuf:"varint,4,opt,name=int_value,json=intValue,proto3,oneof"`
}

type SumAggregation

type SumAggregation struct {
	// contains filtered or unexported fields
}

func (*SumAggregation) Descriptor deprecated

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

Deprecated: Use SumAggregation.ProtoReflect.Descriptor instead.

func (*SumAggregation) ProtoMessage

func (*SumAggregation) ProtoMessage()

func (*SumAggregation) ProtoReflect added in v0.3.0

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

func (*SumAggregation) Reset

func (x *SumAggregation) Reset()

func (*SumAggregation) String

func (x *SumAggregation) String() string

type Tag

type Tag struct {
	Key   string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

TODO(bdrutu): Consider if this should be moved to a "tags" directory to match the API structure.

func (*Tag) Descriptor deprecated

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

Deprecated: Use Tag.ProtoReflect.Descriptor instead.

func (*Tag) GetKey

func (x *Tag) GetKey() string

func (*Tag) GetValue

func (x *Tag) GetValue() string

func (*Tag) ProtoMessage

func (*Tag) ProtoMessage()

func (*Tag) ProtoReflect added in v0.3.0

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

func (*Tag) Reset

func (x *Tag) Reset()

func (*Tag) String

func (x *Tag) String() string

type View

type View struct {

	// A string by which the View will be referred to, e.g. "rpc_latency". Names MUST be unique
	// within the library.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Describes the view, e.g. "RPC latency distribution"
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// The Measure to which this view is applied.
	Measure *Measure `protobuf:"bytes,3,opt,name=measure,proto3" json:"measure,omitempty"`
	// An array of tag keys. These values associated with tags of this name form the basis by which
	// individual stats will be aggregated (one aggregation per unique tag value). If none are
	// provided, then all data is recorded in a single aggregation.
	Columns []string `protobuf:"bytes,4,rep,name=columns,proto3" json:"columns,omitempty"`
	// The description of the aggregation used for this view which describes how data collected are
	// aggregated.
	//
	// Types that are assignable to Aggregation:
	//	*View_CountAggregation
	//	*View_SumAggregation
	//	*View_LastValueAggregation
	//	*View_DistributionAggregation
	Aggregation isView_Aggregation `protobuf_oneof:"aggregation"`
	// contains filtered or unexported fields
}

func (*View) Descriptor deprecated

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

Deprecated: Use View.ProtoReflect.Descriptor instead.

func (*View) GetAggregation

func (m *View) GetAggregation() isView_Aggregation

func (*View) GetColumns

func (x *View) GetColumns() []string

func (*View) GetCountAggregation

func (x *View) GetCountAggregation() *CountAggregation

func (*View) GetDescription

func (x *View) GetDescription() string

func (*View) GetDistributionAggregation

func (x *View) GetDistributionAggregation() *DistributionAggregation

func (*View) GetLastValueAggregation

func (x *View) GetLastValueAggregation() *LastValueAggregation

func (*View) GetMeasure

func (x *View) GetMeasure() *Measure

func (*View) GetName

func (x *View) GetName() string

func (*View) GetSumAggregation

func (x *View) GetSumAggregation() *SumAggregation

func (*View) ProtoMessage

func (*View) ProtoMessage()

func (*View) ProtoReflect added in v0.3.0

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

func (*View) Reset

func (x *View) Reset()

func (*View) String

func (x *View) String() string

type View_CountAggregation

type View_CountAggregation struct {
	// Counts the number of measurements recorded.
	CountAggregation *CountAggregation `protobuf:"bytes,5,opt,name=count_aggregation,json=countAggregation,proto3,oneof"`
}

type View_DistributionAggregation

type View_DistributionAggregation struct {
	// Indicates that the desired Aggregation is a histogram distribution. A distribution
	// Aggregation may contain a histogram of the values in the population. User should define the
	// bucket boundaries for that histogram (see DistributionAggregation).
	DistributionAggregation *DistributionAggregation `protobuf:"bytes,8,opt,name=distribution_aggregation,json=distributionAggregation,proto3,oneof"`
}

type View_LastValueAggregation

type View_LastValueAggregation struct {
	// Indicates that data collected and aggregated with this Aggregation will represent the last
	// recorded value. This is useful to support Gauges.
	LastValueAggregation *LastValueAggregation `protobuf:"bytes,7,opt,name=last_value_aggregation,json=lastValueAggregation,proto3,oneof"`
}

type View_SumAggregation

type View_SumAggregation struct {
	// Indicates that data collected and aggregated with this Aggregation will be summed up.
	SumAggregation *SumAggregation `protobuf:"bytes,6,opt,name=sum_aggregation,json=sumAggregation,proto3,oneof"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL