package aggregation

import "go.opentelemetry.io/otel/sdk/metric/aggregation"

Package aggregation contains configuration types that define the aggregation operation used to summarizes recorded measurements.

Index ¶

• type Aggregation
• type Default
• func (d Default) Copy() Aggregation
• func (Default) Err() error
• type Drop
• func (d Drop) Copy() Aggregation
• func (Drop) Err() error
• type ExplicitBucketHistogram
• func (h ExplicitBucketHistogram) Copy() Aggregation
• func (h ExplicitBucketHistogram) Err() error
• type LastValue
• func (l LastValue) Copy() Aggregation
• func (LastValue) Err() error
• type Sum
• func (s Sum) Copy() Aggregation
• func (Sum) Err() error

Types ¶

type Aggregation ¶

type Aggregation interface {

	// Copy returns a deep copy of the Aggregation.
	Copy() Aggregation

	// Err returns an error for any misconfigured Aggregation.
	Err() error
	// contains filtered or unexported methods
}

Aggregation is the aggregation used to summarize recorded measurements.

type Default ¶

type Default struct{} // Default has no parameters.

Default is an aggregation that uses the default instrument kind selection mapping to select another aggregation. A metric reader can be configured to make an aggregation selection based on instrument kind that differs from the default. This aggregation ensures the default is used.

See the "go.opentelemetry.io/otel/sdk/metric".DefaultAggregationSelector for information about the default instrument kind selection mapping.

func (Default) Copy ¶

func (d Default) Copy() Aggregation

Copy returns a deep copy of d.

func (Default) Err ¶

func (Default) Err() error

Err returns an error for any misconfiguration. A Default aggregation has no parameters and cannot be misconfigured, therefore this always returns nil.

type Drop ¶

type Drop struct{} // Drop has no parameters.

Drop is an aggregation that drops all recorded data.

func (Drop) Copy ¶

func (d Drop) Copy() Aggregation

Copy returns a deep copy of d.

func (Drop) Err ¶

func (Drop) Err() error

Err returns an error for any misconfiguration. A Drop aggregation has no parameters and cannot be misconfigured, therefore this always returns nil.

type ExplicitBucketHistogram ¶

type ExplicitBucketHistogram struct {
	// Boundaries are the increasing bucket boundary values. Boundary values
	// define bucket upper bounds. Buckets are exclusive of their lower
	// boundary and inclusive of their upper bound (except at positive
	// infinity). A measurement is defined to fall into the greatest-numbered
	// bucket with a boundary that is greater than or equal to the
	// measurement. As an example, boundaries defined as:
	//
	// []float64{0, 5, 10, 25, 50, 75, 100, 250, 500, 1000}
	//
	// Will define these buckets:
	//
	// (-∞, 0], (0, 5.0], (5.0, 10.0], (10.0, 25.0], (25.0, 50.0],
	// (50.0, 75.0], (75.0, 100.0], (100.0, 250.0], (250.0, 500.0],
	// (500.0, 1000.0], (1000.0, +∞)
	Boundaries []float64
	// NoMinMax indicates whether to not record the min and max of the
	// distribution. By default, these extrema are recorded.
	//
	// Recording these extrema for cumulative data is expected to have little
	// value, they will represent the entire life of the instrument instead of
	// just the current collection cycle. It is recommended to set this to true
	// for that type of data to avoid computing the low-value extrema.
	NoMinMax bool
}

ExplicitBucketHistogram is an aggregation that summarizes a set of measurements as an histogram with explicitly defined buckets.

func (ExplicitBucketHistogram) Copy ¶

func (h ExplicitBucketHistogram) Copy() Aggregation

Copy returns a deep copy of h.

func (ExplicitBucketHistogram) Err ¶

func (h ExplicitBucketHistogram) Err() error

Err returns an error for any misconfiguration.

type LastValue ¶

type LastValue struct{} // LastValue has no parameters.

LastValue is an aggregation that summarizes a set of measurements as the last one made.

func (LastValue) Copy ¶

func (l LastValue) Copy() Aggregation

Copy returns a deep copy of l.

func (LastValue) Err ¶

func (LastValue) Err() error

Err returns an error for any misconfiguration. A LastValue aggregation has no parameters and cannot be misconfigured, therefore this always returns nil.

type Sum ¶

type Sum struct{} // Sum has no parameters.

Sum is an aggregation that summarizes a set of measurements as their arithmetic sum.

func (Sum) Copy ¶

func (s Sum) Copy() Aggregation

Copy returns a deep copy of s.

func (Sum) Err ¶

func (Sum) Err() error

Err returns an error for any misconfiguration. A Sum aggregation has no parameters and cannot be misconfigured, therefore this always returns nil.

Source Files ¶

aggregation.go