Translate Grafana dashboards to New Relic dashboards

You can use the Grafana to New Relic Dashboard Translation REST API to convert your existing Grafana dashboards into New Relic native dashboards. This API can aid in the migration from Grafana to New Relic for customers who are currently using the Grafana plugin to visualize their New Relic data. Whether you're looking to consolidate your observability tools, migrate your entire monitoring setup to New Relic, or simply test out New Relic dashboards alongside your existing Grafana setup, this API makes it easier to get started.

This API uses New Relic's PromQL translation logic to translate your queries. To see a list of supported PromQL features and functions, see PromQL features support.

Prerequisites

Before using this API, you'll need:

• A New Relic user API key
• Your Grafana dashboard exported as JSON (in Grafana: Settings → JSON Model → Copy to Clipboard)
• Your New Relic account ID (if you want to override the default account)

Make a request to the API endpoints

To translate a Grafana dashboard to a New Relic dashboard, send a POST request to the appropriate endpoint for your region with the dashboard you want to translate in the body of the request.

• For the US, https://prometheus-api.newrelic.com/api/v1/translate/dashboard/grafana
• For EU, https://prometheus-api.eu.newrelic.com/api/v1/translate/dashboard/grafana

Authentication

All API calls require a user API key. Include this key in the x-api-key header of your request.

Request body

The request body should be a JSON object with the following format:

{
  "accountId": int [optional],
  "dashboard": object [required]
}

Where dashboard is the JSON object of the Grafana dashboard you want to translate, and accountId is the account you want your translated dashboard to query data from. If accountId is not included, the translated dashboard will query data from the account of the user making the request.

Response format

The API returns a JSON object containing the translated New Relic dashboard:

{
  "dashboard": {
    "name": "Translated Dashboard",
    "permissions": "PUBLIC_READ_WRITE",
    "pages": [...]
    }
}

Troubleshoot translation errors

When the translator encounters issues that prevent complete translation of a widget or query, it creates "Action Items" - special Markdown widgets that explain what went wrong and suggest fixes.

Examples

$
export NR_USER_KEY="your_user_key"
$
export JSON_FILE="my_grafana_dashboard.json"
$
export TRANSLATOR_ENDPOINT="<your-region-endpoint>" # (see API endpoints section above)
$

$
curl -s ${TRANSLATOR_ENDPOINT} \
>
-H "Content-Type: application/json" \
>
-H "x-api-key:${NR_USER_KEY}" \
>
-d "$(jq -c -n --slurpfile dashboard "${JSON_FILE}" '{dashboard: $dashboard[0]}')" \
>
| jq '.dashboard'

$
export NR_USER_KEY="your_user_key"
$
export ACCOUNT_ID="your_staging_account_id"
$
export JSON_FILE="my_grafana_dashboard.json"
$
export TRANSLATOR_ENDPOINT="<your-region-endpoint>" # (see API endpoints section above)
$

$
curl -s ${TRANSLATOR_ENDPOINT} \
>
-H "Content-Type: application/json" \
>
-H "x-api-key:${NR_USER_KEY}" \
>
-d "$(jq -c -n --arg accountId "$ACCOUNT_ID" --slurpfile dashboard "$JSON_FILE" '{accountId: $accountId, dashboard: $dashboard[0]}')" \
>
| jq '.dashboard'

$
export NR_USER_KEY="your_user_key"
$
export ACCOUNT_ID="your_staging_account_id"
$
export JSON_FILE="my_grafana_dashboard.json"
$
export TRANSLATOR_ENDPOINT="<your-region-endpoint>" # (see API endpoints section above)
$
export NERDGRAPH_ENDPOINT="US/EU Regional Nerdgraph endpoint"
$

$
NR_DASHBOARD=$(curl -s ${TRANSLATOR_ENDPOINT} \
>
-H "Content-Type: application/json" \
>
-H "x-api-key:${NR_USER_KEY}" \
>
-d "$(jq -c -n --arg accountId "$ACCOUNT_ID" --slurpfile dashboard "$JSON_FILE" '{accountId: $accountId, dashboard: $dashboard[0]}')" \
>
| jq '.dashboard')
$

$

$
curl -X POST ${NERDGRAPH_ENDPOINT} \
>
-H "Content-Type: application/json" \
>
-H "API-Key: ${NR_USER_KEY}" \
>
-d '{
$
"query": "mutation($accountId: Int!, $dashboard: DashboardInput!) { dashboardCreate(accountId: $accountId, dashboard: $dashboard) { entityResult { guid name } errors { description } } }",
$
"variables": {
$
"accountId": '${ACCOUNT_ID}',
$
"dashboard": '${NR_DASHBOARD}'
$
}
$
}'

Grafana and New Relic widget types

The following is a list of Grafana widget types that we support and their corresponding New Relic widget types.