graphite

type Client ¶

type Client struct {
	Url    url.URL
	Client *http.Client
}

Client is client to `graphite web api` (http://graphite-api.readthedocs.io/en/latest/api.html). You can either instantiate it manually by providing `url` and `client` or use a `NewFromString` shortcut.

func NewFromString(urlString string) (*Client, error)

client, _ := NewFromString("http://my-graphite.tld")
fmt.Printf(client.Url.Host)

Output:

my-graphite.tld

func (c *Client) ExpandMetrics(r ExpandMetricRequest) (ExpandResult, error)

ts := createExpandMetricsTestServer()
defer ts.Close()

client, _ := NewFromString(ts.URL)
res, _ := client.ExpandMetrics(
	ExpandMetricRequest{
		Query: "cluster.*",
	},
)
fmt.Printf("%+v", res)

Output:

{Results:[cluster.one cluster.two]}

func (c *Client) FindMetrics(r FindMetricRequest) ([]Metric, error)

ts := createFindMetricsTestServer()
defer ts.Close()

client, _ := NewFromString(ts.URL)
res, _ := client.FindMetrics(
	FindMetricRequest{
		Query: "cluster.*",
	},
)
fmt.Printf("%+v", res)

Output:

[{Id:cluster.one Text:one Expandable:1 Leaf:0 AllowChildren:1} {Id:cluster.two Text:two Expandable:1 Leaf:0 AllowChildren:1}]

func (c *Client) QueryRender(r RenderRequest) ([]Series, error)

ts := createTestServer()
defer ts.Close()

client, _ := NewFromString(ts.URL)
res, _ := client.QueryRender(
	RenderRequest{
		Targets: []string{"main"},
	},
)
fmt.Printf(strconv.FormatInt(res[0].Datapoints[0].Timestamp.Unix(), 10))

Output:

1468339853

type DataPoint ¶

type DataPoint struct {
	Value     float64
	Timestamp time.Time
}

DataPoint describes concrete point of time series.

type ExpandMetricRequest ¶

type ExpandMetricRequest struct {
	Query       string
	GroupByExpr bool
	LeavesOnly  bool
}

type ExpandResult ¶

type ExpandResult struct {
	Results []string
}

Results is a list of metric ids.

type FindMetricRequest ¶

type FindMetricRequest struct {
	From      time.Time
	Until     time.Time
	Query     string
	Wildcards bool
}

FindMetricRequest is struct describing request to /metrics/find api.

type Metric ¶

type Metric struct {
	Id            string
	Text          string
	Expandable    int
	Leaf          int
	AllowChildren int
}

type RenderRequest ¶

type RenderRequest struct {
	From          time.Time
	Until         time.Time
	MaxDataPoints int
	Targets       []string
}

RenderRequest is struct, describing request to graphite `/render/` api. No fields are required. If field has zero value it'll be just skipped in request. RenderRequest.Targets are slice of strings, were every entry is a path identifying one or several metrics, optionally with functions acting on those metrics.

Warning. While wildcards could be used in Targets one should use them with caution, as using of the simple target like "main.cluster.*.cpu.*" could result in hundreds of series with megabytes of data inside.

type RequestError ¶

type RequestError struct {
	Query string
	Type  string
}

RequestError is special error, which not only implements an error interface, but also provides access to `Query` field, containing original query which cause an error.

func (e RequestError) Error() string

err := RequestError{
	Type: "Error type",
}
fmt.Printf(err.Error())

Output:

Error type

type Series ¶

type Series struct {
	Target     string
	Datapoints []DataPoint
}

Series describes time series data for given target.