Traduire les dashboards Grafana en dashboards New Relic

Convertissez vos dashboards Grafana existants en dashboards natifs New Relic à l'aide de notre API REST de traduction. Que vous cherchiez à consolider vos outils d'observabilité, à migrer l'ensemble de votre configuration de monitoring vers New Relic, ou simplement à tester les dashboards New Relic en parallèle de votre configuration Grafana existante, cette API facilite la prise en main.

Cette API utilise la logique de traduction PromQL de New Relic pour traduire vos requêtes. Pour consulter une liste des fonctionnalités et fonctions PromQL prises en charge, consultez le guide de prise en charge des fonctionnalités PromQL.

Prérequis

Avant d'utiliser cette API, vous aurez besoin de :

• Une clé API utilisateur New Relic
• Votre ID de compteNew Relic

Faites une requête aux points de terminaison d'API

Pour traduire un dashboard Grafana en un dashboard New Relic, envoyez une requête POST au point de terminaison approprié pour votre région avec le dashboard que vous souhaitez traduire dans le corps de la requête.

• NOUS: https://prometheus-api.newrelic.com/api/v1/translate/dashboard/grafana
• UE: https://prometheus-api.eu.newrelic.com/api/v1/translate/dashboard/grafana
• JP : https://prometheus-api.jp.newrelic.com/api/v1/translate/dashboard/grafana

Référence API

Authentification

Tous les appels d'API nécessitent une clé API utilisateur. Incluez cette clé dans l'en-tête api-key de votre requête.

Corps de la requête

Le corps de la requête doit être un objet JSON avec le format suivant :

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

Où dashboard est l'objet JSON du dashboard Grafana que vous souhaitez traduire. Le champ accountId est facultatif — s'il est omis, le dashboard traduit interrogera les données du compte de l'utilisateur effectuant la requête.

Format de réponse

L'API renvoie un objet JSON contenant le dashboard New Relic traduit :

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

Exemples

$
export NR_USER_KEY="YOUR_NEW_RELIC_USER_API_KEY"
$
export JSON_FILE="my_grafana_dashboard.json"
$
export TRANSLATOR_ENDPOINT="<TRANSLATOR_ENDPOINT_FOR_YOUR_REGION>" # (see API endpoints section above)
$

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

$
export NR_USER_KEY="YOUR_NEW_RELIC_USER_API_KEY"
$
export ACCOUNT_ID="YOUR_NEW_RELIC_STAGING_ACCOUNT_ID"
$
export JSON_FILE="my_grafana_dashboard.json"
$
export TRANSLATOR_ENDPOINT="<TRANSLATOR_ENDPOINT_FOR_YOUR_REGION>" # (see API endpoints section above)
$

$
curl -s ${TRANSLATOR_ENDPOINT} \
>
-H "Content-Type: application/json" \
>
-H "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_NEW_RELIC_USER_API_KEY"
$
export ACCOUNT_ID="YOUR_NEW_RELIC_STAGING_ACCOUNT_ID"
$
export JSON_FILE="my_grafana_dashboard.json"
$
export TRANSLATOR_ENDPOINT="<TRANSLATOR_ENDPOINT_FOR_YOUR_REGION>" # (see API endpoints section above)
$
export NERDGRAPH_ENDPOINT="<NERDGRAPH_ENDPOINT_FOR_YOUR_REGION>"
$

$
NR_DASHBOARD=$(curl -s ${TRANSLATOR_ENDPOINT} \
>
-H "Content-Type: application/json" \
>
-H "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}'
$
}
$
}'

Résoudre les erreurs de traduction

Lorsque le traducteur rencontre des problèmes qui empêchent la traduction complète d'un widget ou d'une requête, il crée des « Action Items » — des widgets Markdown spéciaux qui expliquent ce qui n'a pas fonctionné et suggèrent des correctifs.

Types de widgets Grafana et New Relic

Voici une liste des types de widgets Grafana que nous prenons en charge et de leurs types de widgets New Relic correspondants.