Aggregation Rules API

Contents

• Aggregation Rules API

  • Creating Aggregation Rules

  • Listing Aggregations

  • Deleting Aggregates

  • Editing Your Aggregations

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.

Creating Aggregation Rules

Create aggregation rule

POST /v1/aggregates/

Path Parameters

Name	Type	Description
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.

200: OK The aggregation rule was created successfully. Returns created aggregation’s ID

400: Bad Request Creation failed. Pattern or output is an invalid input (or not provided). Or the aggregation rule creation failed because the pattern is too computationally expensive to match against your metric names.

403: Forbidden Creation failed, you have reached the limit for your account

409: Conflict Creation failed, aggregation with this pattern & output already exists.

500: Internal Server Error Creation failed due to a server error - this shouldn’t happen.

Curl Example:

curl -H "Content-Type: application/json" -X POST -d \
'{"pattern": "servers.*.requests.<response_code>", "output": "servers.all.requests.<response_code>"}' \
"https://[e-mail]/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.

---

Listing Aggregations

List aggregation rules

GET /v1/aggregates

200: OK List of your aggregation rules.

List aggregation rules by ID

GET /v1/aggregates/<aggregation_id>/

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

200: OK Aggregation with passed ID if it exists, empty list otherwise.

Curl Example:

curl "https://[e-mail]/v1/aggregates/<aggregation_id>/"

---

Deleting Aggregates

Delete aggregation rules

DELETE /v1/aggregates/<aggregate_id>/

Delete aggregation rule with passed ID

200: OK Aggregation was successfully deleted.

400: Bad Request No aggregation ID passed.

412: Precondition Failed Aggregation with passed ID does not exist.

500: Internal Server Error Delete failed, please try again.

Curl Example:

curl -X DELETE "https://[e-mail]/v1/aggregates/<aggregate_id>/"

---

Editing Your Aggregations

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.

Aggregate Rules UI