sdata

README

Grafana dataplane sdata

This sdata package is still in experimental stage. Things may break

sdata package provides utilities to build data frames in a structural way and ensure the data frames adhere to data frame contract.

Documentation

Index

• func ValidValueFields() []data.FieldType
• type FrameFieldIndex
• type FrameFieldIndices
  • func (f FrameFieldIndices) Len() int
  • func (f FrameFieldIndices) Less(i, j int) bool
  • func (f FrameFieldIndices) Swap(i, j int)
• type VersionWarning
  • func (vw *VersionWarning) DataNewer() bool
  • func (vw *VersionWarning) Error() string

Functions

func ValidValueFields

func ValidValueFields() []data.FieldType

Types

type FrameFieldIndex

type FrameFieldIndex struct {
	FrameIdx int
	FieldIdx int    // -1 means no fields
	Reason   string // only meant for human consumption
}

FrameFieldIndex is for referencing data that is not considered part of the metric data when the data is valid. Reason states why the field was not part of the metric data.

type FrameFieldIndices

type FrameFieldIndices []FrameFieldIndex

func (FrameFieldIndices) Len

func (f FrameFieldIndices) Len() int

func (FrameFieldIndices) Less

func (f FrameFieldIndices) Less(i, j int) bool

func (FrameFieldIndices) Swap

func (f FrameFieldIndices) Swap(i, j int)

type VersionWarning

type VersionWarning struct {
	DataVersion    data.FrameTypeVersion
	LibraryVersion data.FrameTypeVersion
	DataType       data.FrameType
}

func (*VersionWarning) DataNewer

func (vw *VersionWarning) DataNewer() bool

func (*VersionWarning) Error

func (vw *VersionWarning) Error() string