Aggregation Rules API

Contents

Aggregation rules consolidate the averaged values of many metrics into one, allowing for speedy graph rendering and visualization. Managing aggregation rules can be done easily with Hosted Graphite. Learn more about what our aggregation rules do, and how to use our Aggregation Feature here.

Create aggregation rule

POST /v1/aggregates/

Path Parameters

NameTypeDescription

pattern*

String

Regex or node pattern to match ingested metrics to.

output*

String

Metric output, when a metric is matched with the pattern, those metrics will be mapped to this output and appear in your account.

Curl Example:

curl -H "Content-Type: application/json" -X POST -d \
'{"pattern": "servers.*.requests.<response_code>", "output": "servers.all.requests.<response_code>"}' \
"https://YOUR-API-KEY@api.hostedgraphite.com/v1/aggregates/"

Creates an aggregation with the pattern: servers.*.requests.<response_code> and the output servers.all.requests.<response_code>.

For example, metrics that look like servers.server-0001.requests.404 and servers.server-0002.requests.404 would appear in your account as aggregates.servers.all.requests.404.


List aggregation rules

GET /v1/aggregates

List aggregation rules by ID

GET /v1/aggregates/<aggregation_id>/

Lists your aggregations or individual aggregation if the optional ID is passed.

Curl Example:

curl "https://YOUR-API-KEY@api.hostedgraphite.com/v1/aggregates/<aggregation_id>/"

Delete aggregation rules

DELETE /v1/aggregates/<aggregate_id>/

Delete aggregation rule with passed ID

Curl Example:

curl -X DELETE "https://YOUR-API-KEY@api.hostedgraphite.com/v1/aggregates/<aggregate_id>/"

To edit an aggregation rule, you can do this through the Hosted Graphite UI. Additionally, aggregation rules have no state, so it is safe to delete and re-create them. Learn more about our Aggregate Rules Feature.

Last updated