transformation

Documentation

Index

• type BinaryTransform
• type BinaryTransformFn
  • func (fn BinaryTransformFn) Evaluate(prev, curr Datapoint, flags FeatureFlags) Datapoint
• type Datapoint
  • func (dp Datapoint) IsEmpty() bool
• type FeatureFlags
• type Op
  • func (o Op) BinaryTransform() (BinaryTransform, bool)
  • func (o Op) Type() Type
  • func (o Op) UnaryMultiOutputTransform() (UnaryMultiOutputTransform, bool)
  • func (o Op) UnaryTransform() (UnaryTransform, bool)
• type Type
  • func ParseType(str string) (Type, error)
  • func (t Type) BinaryTransform() (BinaryTransform, error)
  • func (t *Type) FromProto(pb transformationpb.TransformationType) error
  • func (t Type) IsBinaryTransform() bool
  • func (t Type) IsUnaryMultiOutputTransform() bool
  • func (t Type) IsUnaryTransform() bool
  • func (t Type) IsValid() bool
  • func (t Type) MarshalText() (text []byte, err error)
  • func (t Type) MustBinaryTransform() BinaryTransform
  • func (t Type) MustUnaryMultiOutputTransform() UnaryMultiOutputTransform
  • func (t Type) MustUnaryTransform() UnaryTransform
  • func (t Type) NewOp() (Op, error)
  • func (i Type) String() string
  • func (t Type) ToProto(pb *transformationpb.TransformationType) error
  • func (t Type) UnaryMultiOutputTransform() (UnaryMultiOutputTransform, error)
  • func (t Type) UnaryTransform() (UnaryTransform, error)
  • func (t *Type) UnmarshalText(text []byte) error
  • func (t *Type) UnmarshalYAML(unmarshal func(interface{}) error) error
• type UnaryMultiOutputTransform
• type UnaryMultiOutputTransformFn
  • func (fn UnaryMultiOutputTransformFn) Evaluate(dp Datapoint, resolution time.Duration) (Datapoint, Datapoint)
• type UnaryTransform
• type UnaryTransformFn
  • func (fn UnaryTransformFn) Evaluate(dp Datapoint) Datapoint

Types

type BinaryTransform

type BinaryTransform interface {
	Evaluate(prev, curr Datapoint, flags FeatureFlags) Datapoint
}

BinaryTransform is a binary transformation that takes the previous and the current datapoint as input and produces a single datapoint as the transformation result. It can keep state if it requires.

type BinaryTransformFn

type BinaryTransformFn func(prev, curr Datapoint, flags FeatureFlags) Datapoint

BinaryTransformFn implements BinaryTransform as a function.

func (BinaryTransformFn) Evaluate

func (fn BinaryTransformFn) Evaluate(prev, curr Datapoint, flags FeatureFlags) Datapoint

Evaluate implements BinaryTransform as a function.

type Datapoint

type Datapoint struct {
	TimeNanos int64
	Value     float64
}

Datapoint is a metric data point containing a timestamp in Unix nanoseconds since epoch and a value.

func (Datapoint) IsEmpty

func (dp Datapoint) IsEmpty() bool

IsEmpty returns whether this is an empty datapoint.

type FeatureFlags

type FeatureFlags struct {
}

FeatureFlags holds options passed into transformations from the aggregator configuration file. nolint:gofumpt

type Op

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

Op represents a transform operation.

func (Op) BinaryTransform

func (o Op) BinaryTransform() (BinaryTransform, bool)

BinaryTransform returns the active binary transform if op is binary transform.

func (Op) Type

func (o Op) Type() Type

Type returns the op type.

func (Op) UnaryMultiOutputTransform

func (o Op) UnaryMultiOutputTransform() (UnaryMultiOutputTransform, bool)

UnaryMultiOutputTransform returns the active unary multi transform if op is unary multi transform.

func (Op) UnaryTransform

func (o Op) UnaryTransform() (UnaryTransform, bool)

UnaryTransform returns the active unary transform if op is unary transform.

type Type

type Type int32

Type defines a transformation function.

const (
	UnknownType Type = iota
	Absolute
	PerSecond
	Increase
	Add
	Reset
)

Supported transformation types.

func ParseType

func ParseType(str string) (Type, error)

ParseType parses a transformation type.

func (Type) BinaryTransform

func (t Type) BinaryTransform() (BinaryTransform, error)

BinaryTransform returns the binary transformation function associated with the transformation type if applicable, or an error otherwise.

func (*Type) FromProto

func (t *Type) FromProto(pb transformationpb.TransformationType) error

FromProto converts the protobuf message to a transformation type in place.

func (Type) IsBinaryTransform

func (t Type) IsBinaryTransform() bool

IsBinaryTransform returns whether this is a binary transformation.

func (Type) IsUnaryMultiOutputTransform

func (t Type) IsUnaryMultiOutputTransform() bool

func (Type) IsUnaryTransform

func (t Type) IsUnaryTransform() bool

IsUnaryTransform returns whether this is a unary transformation.

func (Type) IsValid

func (t Type) IsValid() bool

IsValid checks if the transformation type is valid.

func (Type) MarshalText

func (t Type) MarshalText() (text []byte, err error)

MarshalText serializes this type to its textual representation.

func (Type) MustBinaryTransform

func (t Type) MustBinaryTransform() BinaryTransform

MustBinaryTransform returns the binary transformation function associated with the transformation type if applicable, or an error otherwise.

func (Type) MustUnaryMultiOutputTransform

func (t Type) MustUnaryMultiOutputTransform() UnaryMultiOutputTransform

MustUnaryMultiOutputTransform returns the unary transformation function associated with the transformation type if applicable, or panics otherwise.

func (Type) MustUnaryTransform

func (t Type) MustUnaryTransform() UnaryTransform

MustUnaryTransform returns the unary transformation function associated with the transformation type if applicable, or panics otherwise.

func (Type) NewOp

func (t Type) NewOp() (Op, error)

NewOp returns a constructed operation that is allocated once and can be reused.

func (Type) String

func (i Type) String() string

func (Type) ToProto

func (t Type) ToProto(pb *transformationpb.TransformationType) error

ToProto converts the transformation type to a protobuf message in place.

func (Type) UnaryMultiOutputTransform

func (t Type) UnaryMultiOutputTransform() (UnaryMultiOutputTransform, error)

UnaryMultiOutputTransform returns the unary transformation function associated with the transformation type if applicable, or an error otherwise.

func (Type) UnaryTransform

func (t Type) UnaryTransform() (UnaryTransform, error)

UnaryTransform returns the unary transformation function associated with the transformation type if applicable, or an error otherwise.

func (*Type) UnmarshalText

func (t *Type) UnmarshalText(text []byte) error

UnmarshalText extracts this type from the textual representation

func (*Type) UnmarshalYAML

func (t *Type) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML unmarshals text-encoded data into an transformation type.

type UnaryMultiOutputTransform

type UnaryMultiOutputTransform interface {
	// Evaluate applies the transform on the provided datapoint.
	Evaluate(dp Datapoint, resolution time.Duration) (Datapoint, Datapoint)
}

UnaryMultiOutputTransform is like UnaryTransform, but can output an additional datapoint. The additional datapoint is not passed to subsequent transforms.

type UnaryMultiOutputTransformFn

type UnaryMultiOutputTransformFn func(dp Datapoint, resolution time.Duration) (Datapoint, Datapoint)

UnaryMultiOutputTransformFn implements UnaryMultiOutputTransform as a function.

func (UnaryMultiOutputTransformFn) Evaluate

func (fn UnaryMultiOutputTransformFn) Evaluate(dp Datapoint, resolution time.Duration) (Datapoint, Datapoint)

Evaluate applies the transform on the provided datapoint.

type UnaryTransform

type UnaryTransform interface {
	Evaluate(dp Datapoint) Datapoint
}

UnaryTransform is a unary transformation that takes a single datapoint as input and transforms it into a datapoint as output. It can keep state if it requires.

type UnaryTransformFn

type UnaryTransformFn func(dp Datapoint) Datapoint

UnaryTransformFn implements UnaryTransform as a function.

func (UnaryTransformFn) Evaluate

func (fn UnaryTransformFn) Evaluate(dp Datapoint) Datapoint

Evaluate implements UnaryTransform as a function.