API de consulta de insights

A API de consulta insights da New Relic é uma API REST para fazer consultas NRQL.

Requisitos e recomendações

This API is no longer the preferred way to query New Relic data. Para melhores resultados, você deve usar o NerdGraph para consultar os dados.

O uso desta API pode ser restrito por permissões de usuário relacionadas à função.

Para adicionar dados personalizados ao New Relic, consulte Relatar dados personalizados.

Se a sua organização hospedar dados no data center da UE, verifique se você está usando o endpoint adequado da região da UE.

1. Cadastre uma chave de API

Para usar a API de consulta insights , você precisa de uma chave de consulta. Você pode ter várias chaves de consulta e qualquer chave de consulta pode ser usada para iniciar qualquer consulta de API insights . Se você tiver vários sistemas consultando insights ou destinos de dados diferentes, a New Relic recomenda usar várias chaves de consulta para aumentar a segurança dos dados.

Por questões de segurança, a chave de consulta não pode ser alterada ou lida através da API. Para alterar ou ler uma chave de consulta, use a interface do New Relic.

Para criar uma nova chave de consulta:

1. Acesse one.newrelic.com/api-keys. Se você estiver usando o datacenter da UE, acesse one.eu.newrelic.com/api-keys em vez de.
2. Clique em Create a key button localizado no canto superior direito da página da chave de API.
3. Configure a nova chave:

• Insira um nome para a nova chave no campo fornecido.
• Adicione uma descrição (como “chave de consulta”).

4. Clique em

   Save

   para gerar a nova chave.

2. Crie a solicitação de consulta da API

Ao criar ou editar uma chave de consulta, você verá um exemplo de consulta curl que pode usar como modelo. A consulta de exemplo não funcionará a menos que você siga estas regras de consulta:

• A string de consulta NRQL deve ser codificada em URL.
• A string de consulta deve ter menos de 4.000 bytes.
• O URL deve conter um ID de conta válido.
• O X-Query-Key deve conter uma chave de consulta válida.
• O Content-Type deve ser application/json.

Linux

Aqui está um exemplo de curl:

curl -H "Accept: application/json" -H "X-Query-Key: YOUR_QUERY_KEY" "https://insights-api.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/query?nrql=YOUR_URL_ENCODED_QUERY"

Microsoft Windows

Você pode usar Powershell para consultar evento via API:

Invoke-WebRequest -Uri https://insights-api.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/query?nrql=YOUR_URL_ENCODED_QUERY -Headers @{"X-Query-Key"="YOUR_QUERY_KEY"} -ContentType "application/json" -Method GET

3. Processe o JSON retornado

A API de consulta retorna resultados no formato JSON. Há um limite de 5.000 resultados por solicitação.

A estrutura dos dados JSON depende do NRQL usado na solicitação: diferentes combinações de instruções, cláusulas e funções SELECT retornam, cada uma, uma resposta apropriada. Ao escrever seu código para processar o JSON, você deve fazer um teste de sua consulta e examinar o JSON resultante.

Exemplo

A API de consulta insights retorna dados JSON. Aqui está um exemplo de consulta, seu formato de solicitação de consulta e seus dados retornados:

SELECT count(appName) FROM PageView SINCE '2014-08-04 00:00:00+0500'

curl -H "Accept: application/json" -H "X-Query-Key: YOUR_QUERY_KEY" "https://insights-api.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/query?nrql=SELECT+count%28appName%29+FROM+PageView+SINCE+%272014-08-04+00%3A00%3A00%2B0500%27"

{
  "results": [
    {
      "count": 80275388
    }
  ],
  "metadata": {
    "eventTypes": [
      "PageView"
    ],
    "eventType": "PageView",
    "openEnded": true,
    "beginTime": "2014-08-03T19:00:00Z",
    "endTime": "2017-01-18T23:18:41Z",
    "beginTimeMillis=": 1407092400000,
    "endTimeMillis": 1484781521198,
    "rawSince": "'2014-08-04 00:00:00+0500'",
    "rawUntil": "`now`",
    "rawCompareWith": "",
    "clippedTimeWindows": {
      "Browser": {
        "beginTimeMillis": 1483571921198,
        "endTimeMillis": 1484781521198,
        "retentionMillis": 1209600000
      }
    },
    "messages": [],
    "contents": [
      {
        "function": "count",
        "attribute": "appName",
        "simple": true
      }
    ]
  }
}

Diretrizes de limitação de taxa

Temos limites de taxa de consulta. Você provavelmente não encontrará esses limites, especialmente se seguir estas diretrizes gerais:

• Limite a quantidade de solicitações com consultas complexas (por exemplo, consultas com cláusulas FACET ou TIMESERIES , ou consultas com mais de um milhão de eventos) executadas ao mesmo tempo.
• Limite a quantidade de solicitações executadas simultaneamente durante longos períodos de tempo a um máximo de 5, especialmente se incluírem consultas complexas.

Se a New Relic aplicar limites de taxa em sua conta para o número de consultas por minuto, a API de consulta retornará um erro 429. Se a New Relic aplicar limites de taxa em sua conta para registros inspecionados, a API de consulta retornará um erro 503 e seus gráficos poderão exibir mensagem de erro de tempo limite.