telemetryapi

Documentation

Index

• Constants
• Variables
• type Client
  • func NewClient(p ClientParams) (Client, error)
• type ClientParams
• type Error
  • func (e *Error) Error() string
• type MultiError
  • func (m *MultiError) Error() string
• type Timeseries
  • func NewTimeseries(dataTypes []TimeseriesDataType) *Timeseries
  • func (ts *Timeseries) Len() int
• type TimeseriesDataField
• type TimeseriesDataType
  • func (t TimeseriesDataType) Parse(s string) (interface{}, error)
  • func (t TimeseriesDataType) String() string
  • func (t TimeseriesDataType) ZeroValue() interface{}
• type TimeseriesParams
• type TimeseriesTags

Constants

const (
	TimeseriesDataTypeUnknown = iota
	TimeseriesDataTypeFloat64
	TimeseriesDataTypeInt64
	TimeseriesDataTypeString
	TimeseriesDataTypeStringArray
	TimeseriesDataTypeBool
)

const DefaultTimeout = 15 * time.Second

Variables

var (
	ErrNoValues = errors.New("no values")
)

Types

type Client

type Client interface {
	Timeseries(ctx context.Context, p TimeseriesParams) (*Timeseries, error)
	Ready(ctx context.Context) error
	Close()
}

func NewClient

func NewClient(p ClientParams) (Client, error)

type ClientParams

type ClientParams struct {
	HTTPClient *http.Client
	BaseURL    string
	Token      string
}

type Error

type Error struct {
	Code    string                 `json:"code"`
	Message string                 `json:"message,omitempty"`
	Details map[string]interface{} `json:"details,omitempty"`
}

func (*Error) Error

func (e *Error) Error() string

type MultiError

type MultiError struct {
	Errors []Error `json:"errors"`
}

func (*MultiError) Error

func (m *MultiError) Error() string

type Timeseries

type Timeseries struct {
	TimeField  []time.Time
	DataFields []*TimeseriesDataField
}

func NewTimeseries

func NewTimeseries(dataTypes []TimeseriesDataType) *Timeseries

func (*Timeseries) Len

func (ts *Timeseries) Len() int

type TimeseriesDataField

type TimeseriesDataField struct {
	Tags   TimeseriesTags
	Type   TimeseriesDataType
	Values []interface{}
}

type TimeseriesDataType

type TimeseriesDataType uint8

func (TimeseriesDataType) Parse

func (t TimeseriesDataType) Parse(s string) (interface{}, error)

func (TimeseriesDataType) String

func (t TimeseriesDataType) String() string

func (TimeseriesDataType) ZeroValue

func (t TimeseriesDataType) ZeroValue() interface{}

type TimeseriesParams

type TimeseriesParams struct {
	User  string
	Query string
	From  time.Time
	To    time.Time
}

type TimeseriesTags

type TimeseriesTags map[string]string