A API REST da New Relic permite recuperar dados e enviar dados para ferramentas New Relic, bem como configurar recursos e executar operações de exclusão. Você também pode usar o API Explorer para entender os dados disponíveis por meio da API REST, para obter o comando curl e para ver as respostas JSON.
Configurar
A estrutura de comando da API REST segue este modelo:
O comando GET também pode ser POST ou DELETE, dependendo da intenção da consulta.
Para entender o espaço reservado, continue lendo.
Dica
Nossos exemplos usam curl como uma ferramenta de linha de comando comum para extrair dados de métrica de fração de tempo da API REST. No entanto, você pode usar qualquer método para fazer suas solicitações REST. Os comandos curl incluem URLs de destino, informações de cabeçalho e dados relevantes para qualquer mecanismo de solicitação.
URL
A chamada de API requer uma URL para especificar o local de onde os dados serão acessados. Você deve substituir o espaço reservado <URL> pelo URL apropriado, que mudará dependendo do tipo de dados solicitados. Em geral, a URL segue este modelo:
https://api.newrelic.com/v2/applications/$APP_ID/metrics/data.jsonO $APP_ID especifica o aplicativo ou produto exato para o qual os dados estão sendo solicitados. As informações que seguem este parâmetro variam dependendo da solicitação de dados.
Se você tiver uma conta na região da UE, o URL será:
api.eu.newrelic.com/v2/applications/$APP_ID/metrics/data.jsonDica
Você pode recuperar dados XML em vez de JSON substituindo .json por .xml.
Chave de API $API_KEY
A chamada de API do New Relic requer uma chave de API. Esta pode ser uma das várias chaves de API:
- Uma chave de usuário: Isso é recomendado. É a nossa implementação de chave mais recente e tem menos limitações do que uma chave de API REST. A chave do usuário também é usada para nossa API NerdGraph.
- Uma chave de API REST: esta é nossa implementação de chave mais antiga. Para mais informações sobre isso, veja Chave de API REST. Se você usar essa chave, o cabeçalho necessário será
X-Api-Keye nãoApi-Key. - Se você tiver uma conta de parceria New Relic, usará uma chave diferente: consulte Autenticação de parceria.
Em nossos exemplos de API REST, pegamos emprestado o espaço reservado para chave de API $API_KEY da programação shell Unix. Certifique-se de substituir essa e outras variáveis específicas do usuário ao formar chamadas.
Detalhes da consulta (carga)
A carga contém os detalhes da consulta, que definem:
- O nome da métrica que deseja consultar e o valor que deseja recuperar
- O intervalo de tempo definido para recuperação da métrica
- (Opcional): A média dos dados da métrica de fração de tempo usando resumo
Exemplos
Consulte os documentos a seguir para ver exemplos de casos de uso da API REST:
Exemplos de APM (como recuperar dados de métrica de fração de tempo de
).
Exemplos de browser (como recuperar dados de métrica de fração de tempo de
). A API REST retorna apenas o script do agente do browser Lite. Para obter mais informações, consulte esta tabela comparando os tipos Lite, Pro e Pro+SPA.
Exemplos de alertas (criar condição do alerta e configurar canal de notificação e mais).