basic

package
v0.31.0 Latest Latest
Warning

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

Go to latest
Published: Jul 8, 2022 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrInconsistentState = fmt.Errorf("inconsistent processor state")

ErrInconsistentState is returned when the sequence of collection's starts and finishes are incorrectly balanced.

View Source
var ErrInvalidTemporality = fmt.Errorf("invalid aggregation temporality")

ErrInvalidTemporality is returned for unknown metric.Temporality.

Functions

func NewFactory added in v0.24.0

NewFactory returns a new basic CheckpointerFactory.

Types

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures a basic processor configuration.

func WithMemory

func WithMemory(memory bool) Option

WithMemory sets the memory behavior of a Processor. If this is true, the processor will report metric instruments and attribute sets that were previously reported but not updated in the most recent interval.

type Processor

type Processor struct {
	aggregation.TemporalitySelector
	export.AggregatorSelector
	// contains filtered or unexported fields
}

Processor is a basic metric processor.

func New

func New(aselector export.AggregatorSelector, tselector aggregation.TemporalitySelector, opts ...Option) *Processor

New returns a basic Processor that is also a Checkpointer using the provided AggregatorSelector to select Aggregators. The TemporalitySelector is consulted to determine the kind(s) of exporter that will consume data, so that this Processor can prepare to compute Cumulative Aggregations as needed.

func (*Processor) FinishCollection

func (b *Processor) FinishCollection() error

FinishCollection signals to the Processor that a complete collection has finished and that ForEach will be called to access the Reader.

func (*Processor) ForEach

func (b *Processor) ForEach(exporter aggregation.TemporalitySelector, f func(export.Record) error) error

ForEach iterates through the Reader, passing an export.Record with the appropriate Cumulative or Delta aggregation to an exporter.

func (*Processor) Process

func (b *Processor) Process(accum export.Accumulation) error

Process implements export.Processor.

func (*Processor) Reader added in v0.24.0

func (b *Processor) Reader() export.Reader

Reader returns the associated Reader. Use the Reader Locker interface to synchronize access to this object. The Reader.ForEach() method cannot be called concurrently with Process().

func (*Processor) StartCollection

func (b *Processor) StartCollection()

StartCollection signals to the Processor one or more Accumulators will begin calling Process() calls during collection.

Jump to

Keyboard shortcuts

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