Automatically apply recommendations from Adaptive Metrics

Use this template repository to set up auto-apply mode for Adaptive Metrics in Grafana Cloud.

Auto-apply mode for Adaptive Metrics is currently in public preview. This feature is still under development and support is limited at this time.

What to expect

By default, auto-apply mode runs at 04:00 UTC Monday through Friday. To configure this setting, edit the schedule parameter in the .github/workflows/pull_recommendations.yml file.

At the scheduled time, the GitHub Action pulls the latest recommendations and creates a pull request named "Scheduled refresh of the latest recommendations".

After you merge this pull request, the GitHub Action creates or updates the following files and pushes them to the main branch with the commit message, "Auto-apply updated aggregation rules":

• rules.json
• .terraform.lock.hcl
• terraform.tfstate

You can also set the pull request to merge automatically.

Automatically apply recommendations

Set up a GitHub Action to automatically apply Adaptive Metrics recommendations in Grafana Cloud.

1. Create a new repository by navigating to "Use this template" → "Create a new repository" at the top-right of the repository page in GitHub.

2. Go to "Settings" → "Secrets and variables" → "Actions" → "Variables" → " New repository variable" and add the following variable to the new repository:

   • grafana_am_api_url: This is your Grafana Cloud Prometheus URL. To find this URL, go to your grafana.com account (https://grafana.com → "My Account") and click on the "Details" button of your Grafana Cloud Prometheus stack. The URL is listed at the top of the page next to the Prometheus icon.

     Make sure to use only the host part of this URL. Remove any parameters after grafana.net.

3. Go to "Settings" → "Secrets and variables" → "Actions" → "New repository secret" and add the following secret to the new repository:

   • grafana_am_api_key: You must specify this key in the format <your-numeric-instance-id>:<your-cloud-access-policy-token>, where:
     • <your-numeric-instance-id> is the numeric instance ID for which you want to enable auto-apply mode. You can find this value in the "Query Endpoint" section of the Details page under "Username / Instance ID".
     • <your-cloud-access-policy-token> is a token from a Grafana Cloud Access Policy. Make sure the access policy has metrics:read and metrics:write scopes for the appropriate stack ID.

4. Go to "Settings" → "Actions" → "General" → "Workflow permissions" and select the checkbox for "Allow GitHub Actions to create and approve pull requests". Then, click "Save".

After you set up this configuration, you can manually run the workflow named "Pull Adaptive Metrics recommendations". By default, this workflow creates a pull request with the latest recommendations. After you merge this pull request, the workflow automatically creates the corresponding set of aggregation rules.

(Optional) Automatically merge rules

You can enable auto-merge mode to skip the manual pull request review and merge processes. To automatically merge the pull request containing the latest set of aggregation rules, define the following variable in your repository:

grafana_am_automerge_enabled = true

Control your recommendations

You can add exemptions resources to the main.tf file to control your recommendations. Refer to grafana-adaptive-metrics_exemption (Resource) for more information.

Pushing changes to the main.tf file automatically applies the new Terraform settings.

See also

• Grafana Adaptive Metrics
• Grafana Adaptive Metrics Terraform provider

Have feedback about this feature? Open an issue to let the team know!