NerdGraph é nossa API no formato GraphQL que permite consultar dados do New Relic e configurar alguns recursos do New Relic. Depois de se inscrever para uma conta gratuita da New Relic e instalar qualquer um de nossos serviços de monitoramento, você pode começar a usar o NerdGraph.
O que é NerdGraph?
NerdGraph é uma das várias API da New Relic. NerdGraph é a API que recomendamos para consultar dados do New Relic e realizar algumas configurações específicas (saiba mais sobre recurso). NerdGraph fornece uma interface API única para retornar dados de várias APIs e microsserviços da New Relic. Com o tempo, outros recursos de configuração serão adicionados ao NerdGraph.
Importante
NerdGraph não é usado para ingestão de dados. Para isso, você usaria nossa API de ingestão de dados.
NerdGraph é construído usando GraphQL, que é um formato de API de código aberto que permite solicitar exatamente os dados necessários, sem busca excessiva ou insuficiente.
Requisitos
Antes de começar:
- Você precisa de uma conta New Relic e, com essa conta, poderá acessar sua API que precisa incluir com consultas e mutações.
- O tipo de usuário e as funções atribuídas podem afetar suas permissões do NerdGraph. Para obter mais detalhes, consulte Fatores que afetam o acesso.
Ponto final
Os endpoints da API que você usa dependem da região do seu data center:
- Endpoint principal:
https://api.newrelic.com/graphql
- Endpoint para contas que usam data center da UE:
https://api.eu.newrelic.com/graphql
Para acessar o endpoint, você pode fazer chamadas a partir do seu código, usar o NerdGraph API Explorer ou fazer um comando curl
semelhante a este:
$curl -X POST https://api.newrelic.com/graphql \> -H 'Content-Type: application/json' \> -H 'API-Key: YOUR_NEW_RELIC_USER_KEY' \> -d '{ "query": "{ requestContext { userId apiKey } }" }'
Use o explorador de API NerdGraph
Uma maneira fácil de experimentar a API NerdGraph é usar o NerdGraph API Explorer. Para obter ajuda para começar a usar esta ferramenta, consulte Tutorial do NerdGraph API Explorer.
Funcionalidade NerdGraph
A funcionalidade do NerdGraph pode ser dividida em duas categorias principais:
- Querying data. Você pode buscar dados para diversas finalidades, incluindo usá-los em um fluxo de trabalho programático ou criar um aplicativo New Relic para visualizações de dados personalizadas.
- Configuring features. Há uma variedade de configurações disponíveis e mais serão adicionadas ao longo do tempo. Você pode fazer coisas como adicionar tags, configurar carga de trabalho ou personalizar "métricas clássicas".
Você pode usar o NerdGraph para retornar e configurar uma ampla variedade de dados. Uma maneira de ver o que o NerdGraph pode fazer é começar a construir a consulta e explorar o esquema usando o explorador NerdGraph.
Estes são alguns dos recursos NerdGraph mais comumente usados:
- Obtenha dados sobre sua entidade monitor
- Consulte seus dados usando NRQL (nossa linguagem de consulta)
- Criar painel
Aqui estão todos os nossos documentos NerdGraph disponíveis:
Tema | Tutoriais |
---|---|
Gerenciamento de contas |
|
alerta |
|
agente | |
Monitoramento de Alterações | |
Painel | |
Integração na nuvem (AWS, Azure, GCP) | |
Gestão de dados | |
Distributed tracing | |
Entidade |
|
Gerenciamento de toras | |
Monitoramento de Mobile | |
Aplicativos New Relic | |
Consultas e gráficos | |
Nível de serviço | |
Monitoramento sintético | |
Marcação | |
Carga de trabalho |
Terminologia NerdGraph
A seguir estão os termos originados do GraphQL, o formato de API que o NerdGraph usa.
Prazo | Definição |
---|---|
Consulta e mutações | Existem duas classes de operações GraphQL:
|
Tipo | Os dados no GraphQL são organizados em tipos. Os tipos podem ser escalares (como strings, números ou booleanos) ou tipos de objetos. Um tipo de objeto é um tipo personalizado composto por uma coleção de campos. Por exemplo, um tipo de objeto chamado |
Campo | Um campo representa uma informação sobre um tipo de objeto que pode ser consultado. Os campos podem ser escalares, listas ou objetos. Por exemplo, um tipo de objeto |
Interface | Uma interface é um tipo abstrato que representa uma coleção de campos comuns que outros tipos de objetos podem |