Traduzir dashboards do Grafana para dashboards do New Relic

Converta seus dashboards existentes do Grafana em dashboards nativos do New Relic usando nossa API REST de tradução. Seja para consolidar suas ferramentas de observabilidade, migrar toda a sua configuração de monitoramento para o New Relic ou simplesmente testar os dashboards do New Relic junto com sua configuração existente do Grafana, esta API facilita o início.

Esta API usa a lógica de tradução PromQL da New Relic para traduzir suas consultas. Para ver uma lista de recursos e funções PromQL suportados, consulte o guia de suporte de recursos PromQL.

Pré-requisitos

Antes de usar esta API, você precisará de:

• Uma chave de API de usuário da New Relic
• Seu ID da contada New Relic

Faça uma requisição aos endpoints da API

Para traduzir um dashboard do Grafana para um dashboard do New Relic, envie uma requisição POST para o endpoint apropriado para sua região com o dashboard que você deseja traduzir no corpo da requisição.

• NÓS: 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

Referência de API

Autenticação

Todas as chamadas de API exigem uma chave de API de usuário. Inclua esta chave no cabeçalho api-key da sua solicitação.

Corpo da requisição

O corpo da solicitação deve ser um objeto JSON com o seguinte formato:

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

Onde dashboard é o objeto JSON do dashboard do Grafana que você deseja traduzir. O campo accountId é opcional — se omitido, o dashboard traduzido consultará dados da conta do usuário que faz a solicitação.

Formato de resposta

A API retorna um objeto JSON contendo o dashboard New Relic traduzido:

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

Exemplos

$
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}'
$
}
$
}'

Resolução de erros de tradução

Quando o tradutor encontra problemas que impedem a tradução completa de um widget ou consulta, ele cria "Action Items" — widgets especiais em Markdown que explicam o que deu errado e sugerem correções.

Tipos de widget Grafana e New Relic

A seguir, apresentamos uma lista dos tipos de widget do Grafana que suportamos e seus correspondentes tipos de widget do New Relic.