metrics

Documentation

Index

• Constants
• func ConvertToFloat64(v interface{}) (float64, error)
• func UnixMilli(t time.Time) int64
• type Bucketpoint
• type Client
  • func NewHawkularClient(p Parameters) (*Client, error)
  • func (self *Client) Create(md MetricDefinition, o ...Modifier) (bool, error)
  • func (self *Client) Definition(t MetricType, id string, o ...Modifier) (*MetricDefinition, error)
  • func (self *Client) Definitions(o ...Modifier) ([]*MetricDefinition, error)
  • func (self *Client) DeleteTags(t MetricType, id string, tags map[string]string, o ...Modifier) error
  • func (self *Client) ReadBuckets(t MetricType, o ...Modifier) ([]*Bucketpoint, error)
  • func (self *Client) ReadMetric(t MetricType, id string, o ...Modifier) ([]*Datapoint, error)
  • func (self *Client) Send(o ...Modifier) (*http.Response, error)
  • func (self *Client) Tags(t MetricType, id string, o ...Modifier) (map[string]string, error)
  • func (self *Client) UpdateTags(t MetricType, id string, tags map[string]string, o ...Modifier) error
  • func (self *Client) Url(method string, e ...Endpoint) Modifier
  • func (self *Client) Write(metrics []MetricHeader, o ...Modifier) error
• type Datapoint
• type Endpoint
  • func DataEndpoint() Endpoint
  • func SingleMetricEndpoint(id string) Endpoint
  • func TagEndpoint() Endpoint
  • func TagsEndpoint(tags map[string]string) Endpoint
  • func TypeEndpoint(t MetricType) Endpoint
• type Filter
  • func BucketsFilter(buckets int) Filter
  • func EndTimeFilter(endTime time.Time) Filter
  • func IdFilter(regexp string) Filter
  • func Param(k string, v string) Filter
  • func PercentilesFilter(percentiles []float64) Filter
  • func StartTimeFilter(startTime time.Time) Filter
  • func TagsFilter(t map[string]string) Filter
  • func TypeFilter(t MetricType) Filter
• type HawkularClient
• type HawkularClientError
  • func (self *HawkularClientError) Error() string
• type HawkularError
• type MetricDefinition
• type MetricHeader
• type MetricType
  • func (self MetricType) MarshalJSON() ([]byte, error)
  • func (self MetricType) String() string
  • func (self *MetricType) UnmarshalJSON(b []byte) error
• type Modifier
  • func Data(data interface{}) Modifier
  • func Filters(f ...Filter) Modifier
  • func Tenant(tenant string) Modifier
• type Parameters
• type Percentile
• type SortKey

Constants

const (
	Gauge = iota
	Availability
	Counter
	Generic
)

Functions

func ConvertToFloat64

func ConvertToFloat64(v interface{}) (float64, error)

func UnixMilli

func UnixMilli(t time.Time) int64

Returns milliseconds since epoch

Types

type Bucketpoint

type Bucketpoint struct {
	Start       int64        `json:"start"`
	End         int64        `json:"end"`
	Min         float64      `json:"min"`
	Max         float64      `json:"max"`
	Avg         float64      `json:"avg"`
	Median      float64      `json:"median"`
	Empty       bool         `json:"empty"`
	Samples     int64        `json:"samples"`
	Percentiles []Percentile `json:"percentiles"`
}

TODO Fix the Start & End to return a time.Time

type Client

type Client struct {
	Tenant string

	Token string
	// contains filtered or unexported fields
}

func NewHawkularClient

func NewHawkularClient(p Parameters) (*Client, error)

func (*Client) Create

func (self *Client) Create(md MetricDefinition, o ...Modifier) (bool, error)

Create new Definition

func (*Client) Definition

func (self *Client) Definition(t MetricType, id string, o ...Modifier) (*MetricDefinition, error)

Return a single definition

func (*Client) Definitions

func (self *Client) Definitions(o ...Modifier) ([]*MetricDefinition, error)

Fetch definitions

func (*Client) DeleteTags

func (self *Client) DeleteTags(t MetricType, id string, tags map[string]string, o ...Modifier) error

Delete given tags from the definition

func (*Client) ReadBuckets

func (self *Client) ReadBuckets(t MetricType, o ...Modifier) ([]*Bucketpoint, error)

TODO ReadMetrics should be equal also, to read new tagsFilter aggregation..

func (*Client) ReadMetric

func (self *Client) ReadMetric(t MetricType, id string, o ...Modifier) ([]*Datapoint, error)

Read data from the server

func (*Client) Send

func (self *Client) Send(o ...Modifier) (*http.Response, error)

func (*Client) Tags

func (self *Client) Tags(t MetricType, id string, o ...Modifier) (map[string]string, error)

Fetch metric definition tags

func (*Client) UpdateTags

func (self *Client) UpdateTags(t MetricType, id string, tags map[string]string, o ...Modifier) error

Update tags

func (*Client) Url

func (self *Client) Url(method string, e ...Endpoint) Modifier

func (*Client) Write

func (self *Client) Write(metrics []MetricHeader, o ...Modifier) error

Write datapoints to the server

type Datapoint

type Datapoint struct {
	Timestamp int64             `json:"timestamp"`
	Value     interface{}       `json:"value"`
	Tags      map[string]string `json:"tags,omitempty"`
}

Value should be convertible to float64 for numeric values Timestamp is milliseconds since epoch

type Endpoint

type Endpoint func(u *url.URL)

func DataEndpoint

func DataEndpoint() Endpoint

func SingleMetricEndpoint

func SingleMetricEndpoint(id string) Endpoint

func TagEndpoint

func TagEndpoint() Endpoint

func TagsEndpoint

func TagsEndpoint(tags map[string]string) Endpoint

func TypeEndpoint

func TypeEndpoint(t MetricType) Endpoint

type Filter

type Filter func(r *http.Request)

func BucketsFilter

func BucketsFilter(buckets int) Filter

func EndTimeFilter

func EndTimeFilter(endTime time.Time) Filter

func IdFilter

func IdFilter(regexp string) Filter

Requires HWKMETRICS-233

func Param

func Param(k string, v string) Filter

Add query parameters

func PercentilesFilter

func PercentilesFilter(percentiles []float64) Filter

func StartTimeFilter

func StartTimeFilter(startTime time.Time) Filter

func TagsFilter

func TagsFilter(t map[string]string) Filter

func TypeFilter

func TypeFilter(t MetricType) Filter

type HawkularClient

type HawkularClient interface {
	Send(*http.Request) (*http.Response, error)
}

type HawkularClientError

type HawkularClientError struct {
	Code int
	// contains filtered or unexported fields
}

More detailed error

func (*HawkularClientError) Error

func (self *HawkularClientError) Error() string

type HawkularError

type HawkularError struct {
	ErrorMsg string `json:"errorMsg"`
}

type MetricDefinition

type MetricDefinition struct {
	Tenant        string            `json:"-"`
	Type          MetricType        `json:"type,omitempty"`
	Id            string            `json:"id"`
	Tags          map[string]string `json:"tags,omitempty"`
	RetentionTime int               `json:"dataRetention,omitempty"`
}

type MetricHeader

type MetricHeader struct {
	Tenant string      `json:"-"`
	Type   MetricType  `json:"-"`
	Id     string      `json:"id"`
	Data   []Datapoint `json:"data"`
}

type MetricType

type MetricType int

MetricType restrictions

func (MetricType) MarshalJSON

func (self MetricType) MarshalJSON() ([]byte, error)

func (MetricType) String

func (self MetricType) String() string

func (*MetricType) UnmarshalJSON

func (self *MetricType) UnmarshalJSON(b []byte) error

Custom unmarshaller

type Modifier

type Modifier func(*http.Request) error

func Data

func Data(data interface{}) Modifier

Add payload to the request

func Filters

func Filters(f ...Filter) Modifier

func Tenant

func Tenant(tenant string) Modifier

Override function to replace the Tenant (defaults to Client default)

type Parameters

type Parameters struct {
	Tenant    string // Technically optional, but requires setting Tenant() option everytime
	Url       string
	TLSConfig *tls.Config
	Token     string
}

type Percentile

type Percentile struct {
	Quantile float64 `json:"quantile"`
	Value    float64 `json:"value"`
}

type SortKey

type SortKey struct {
	Tenant string
	Type   MetricType
}