storagemetadata

Documentation

Index

• func ValidateMetricsType(v MetricsType) error
• type Attributes
  • func (a Attributes) String() string
  • func (a Attributes) Validate() error
• type MetricsType
  • func ParseMetricsType(str string) (MetricsType, error)
  • func (t MetricsType) String() string
  • func (t *MetricsType) UnmarshalYAML(unmarshal func(interface{}) error) error

Functions

func ValidateMetricsType

func ValidateMetricsType(v MetricsType) error

ValidateMetricsType validates a stored metrics type.

Types

type Attributes

type Attributes struct {
	// MetricsType indicates the type of namespace this metric originated from.
	MetricsType MetricsType
	// Retention indicates the retention of the namespace this metric originated
	// from.
	Retention time.Duration
	// Resolution indicates the retention of the namespace this metric originated
	// from.
	Resolution time.Duration
}

Attributes is a set of stored metrics attributes.

func (Attributes) String

func (a Attributes) String() string

String returns a string detailing the attributes.

func (Attributes) Validate

func (a Attributes) Validate() error

Validate validates a storage attributes.

type MetricsType

type MetricsType uint

MetricsType is a type of stored metrics.

const (
	// UnknownMetricsType is the unknown metrics type and is invalid.
	UnknownMetricsType MetricsType = iota
	// UnaggregatedMetricsType is an unaggregated metrics type.
	UnaggregatedMetricsType
	// AggregatedMetricsType is an aggregated metrics type.
	AggregatedMetricsType

	// DefaultMetricsType is the default metrics type value.
	DefaultMetricsType = UnaggregatedMetricsType
)

func ParseMetricsType

func ParseMetricsType(str string) (MetricsType, error)

ParseMetricsType parses a metric type.

func (MetricsType) String

func (t MetricsType) String() string

func (*MetricsType) UnmarshalYAML

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

UnmarshalYAML unmarshals a stored merics type.