Grafana Cloud

Adaptive Metrics HTTP API

Before you begin

To interact with the API, gather the following information:

  • URL: In the form https://<your-grafana-cloud-prom-url> To find your URL value, go to your account and check the Details page of your hosted Prometheus endpoint.
  • TENANT: The numeric instance ID where you want to use Adaptive Metrics. To find your TENANT value, go to your account and check the Details page of your hosted Prometheus endpoint for Username / Instance ID.
  • TOKEN: A token from a Grafana Cloud Access Policy, make sure the access policy has metrics:read and metrics:write scopes for the stack ID where you want to use Adaptive Metrics.

The format of an aggregation rule

Each aggregation rule looks similar to this:

    "metric": "agent_request_duration_seconds_sum",
    "drop_labels": [
     "aggregations": [

In the preceding example:

  • metric is the name of the metric to be aggregated.
  • drop_labels is an array of the labels that will be aggregated and their value will be set to <aggregated>.
  • aggregations is an array of the aggregation types to calculate for this metric.

You can use an aggregation rule file to define multiple rules simultaneously.

The following example rule file is an array of one or more aggregation rules:

    "metric": "agent_request_duration_seconds_sum",
    "drop_labels": ["namespace", "pod"],
    "aggregations": ["sum:counter"]

    "metric": "prometheus_request_duration_seconds_sum",
    "drop_labels": ["container", "instance", "ws"],
    "aggregations": ["sum:counter"]

The Adaptive Metrics API allows you to perform the following actions:

    List recommendations

    Download our recommendations for metrics to aggregate using command below. TOKEN and TENANT are variables defined within the requirements section.

    curl -u "$TENANT:$TOKEN" "$URL/aggregations/recommendations"

    TOKEN must belong to an access policy with the metrics:read scope.

    You can use an optional verbose flag to retrieve more information about each recommendation:

    curl -u "$TENANT:$TOKEN" "$URL/aggregations/recommendations?verbose=true"

    Any existing aggregation rules that have been previously applied will be included in the downloaded list of recommendations. This simplifies the process of viewing the recommended aggregation rules and applying them. By default, you can apply recommended rules and still maintain all of your existing rules.

    Note: Recommendations are generated asynchronously from the API calls; the API call only returns the most recently generated set of recommendations.

    List current recommendations configuration

    Download the current configuration of the recommendations service using the following command:

    curl -u "$TENANT:$TOKEN" "$URL/aggregations/recommendations/config"

    TOKEN must belong to an access policy with the metrics:read scope.

    The only tunable parameter exposed by the recommendations service is the keep_labels parameter. This parameter allows the user to define a list of labels that they never want recommended for aggregation. This can be useful at organizations where certain labels are always expected on metrics, regardless of whether or not those labels have been recently queried.

    Note: The keep_labels parameter only applies to new recommendations; existing rules that contain labels specified in keep_labels will remain unchanged.

    An example response from the /recommendations/config endpoint would look as follows:

      "keep_labels": ["instance", "pod"]

    The preceding response indicates that the recommendations service has been configured to never recommend aggregating the instance or pod labels.

    Update recommendations configuration

    Upload new recommendations configuration using the following command:

    curl -u "$TENANT:$TOKEN" --request POST --data @config.json "$URL/aggregations/recommendations/config"

    TOKEN must belong to an access policy with the metrics:write scope.

    This command uses the same endpoint described in List current recommendations configuration and expects the same JSON format.

    List currently applied aggregation rules

    Download your existing aggregation rules:

    curl -u "$TENANT:$TOKEN" "$URL/aggregations/rules"

    TOKEN must belong to an access policy with the metrics:read scope.

    Upload new aggregation rules

    Uploading new aggregation rules is a multi-step process:

    1. Fetch the currently applied rules.
    2. Modify rules locally.
    3. Upload rules back.

    There is a delay between uploading new aggregation rules and those metrics aggregations taking effect in your environment. In most cases, the delay is approximately 5-10 minutes, but we currently have no mechanism to let you know precisely when new aggregations take effect.

    We currently limit how often new aggregation rules can be applied. Although you can upload as many new versions of your aggregation rules as you like, those updates are only applied once every 10 minutes. If you make multiple updates in quick succession, the system applies your first received (oldest) update. Then, 10 minutes later, the most recently received update is applied. The intermediate updates never get applied.

    Fetch the currently applied rules

    Use this command:

    curl -u "$TENANT:$TOKEN" -D headers.txt "$URL/aggregations/rules" > rules.json

    TOKEN must belong to an access policy with the metrics:read scope.

    The preceding command uses an additional -D headers.txt argument, which stores the headers in a file called headers.txt.

    This step is required if you want to then upload a new rule file, for example if you want to update the existing aggregation rules you have in place. The information in these headers ensures there are no update collisions. An update collision is the scenario where multiple users try to edit the rules file at the same time and overwrite one another’s changes.

    Modify the rules locally

    Use your editor of choice to modify the rules.json file downloaded in the prior step.

    Upload rules back

    The API supports uploading an entire rules file.

    Warning: This action will overwrite your existing rule file.

    To upload your modified rules.json file from the previous step, use the following shell script:

    trap 'rm "$TMPFILE"' EXIT
    cat headers.txt | grep -i '^etag:' | sed 's/^ETag:/If-Match:/i' > "$TMPFILE"
    curl --request POST --header @"$TMPFILE" --data-binary @$1 -u "$TENANT:$TOKEN" "$URL/aggregations/rules"

    TOKEN must belong to an access policy with the metrics:write scope.

    The cat headers.txt command modifies the headers.txt file created in the previous curl call that pulled down the existing aggregation rules.

    The curl --request POST command uploads your new rules file, as well as the updated headers.

    Save the shell script as

    To run that script, use the following command:

    ./ <your_new_rules_file.json>

    Replace <your_new_rules_file.json> with the name of the rules file you wish to upload.

    Note: If, upon trying to POST the new rules file, you see the error the Etag supplied in the 'If-Match' header does not match the Etag of the rules you are trying to replace, the headers you provided are either missing or stale. To fix, re-fetch the rules file and headers, being careful to look for any changes that may have been introduced since your last edits. For more information on Etag headers, see Etag.
    Note: After you configure aggregation rules, the active series count might increase temporarily. Aggregated and unaggregated series will be considered active at the same time. After a short period of time, the unaggregated series will no longer be considered active, and you will see a net reduction in active series.