Nossas soluções de monitoramento e APIs utilizam chave de API para autenticar e verificar sua identidade. Essas chaves permitem que apenas pessoas aprovadas em sua organização relatem dados à New Relic, acessem esses dados e configurem recursos. As chaves primárias são a chave de licença (para gerar relatórios de dados) e a (para trabalhar com NerdGraph, nossa API GraphQL).
Chave de licença são usadas para reportar quase todos os dados (exceto navegador e dados móveis, que usam chaves próprias). Cada chave está vinculada a uma conta específica e você pode criar quantas quiser.
As chaves do navegador são usadas para reportar dados de monitoramento do navegador . Cada chave está vinculada a uma conta específica e você pode criar quantas quiser.
É necessária uma chave de usuário para utilizar o NerdGraph, nossa API GraphQL, que é utilizada para consulta de dados e configuração de recurso. Cada chave de usuário está vinculada a um usuário específico.
Se sua chave de API cair em mãos erradas, ela pode representar um risco à segurança. Por exemplo:
Alguém com seu pode enviar dados arbitrários para sua conta.
Alguém com uma das chaves de usuário de um membro da sua equipe poderá visualizar seus dados do New Relic e fazer alterações em sua conta do New Relic.
Você deve tratar sua chave de API de forma segura, como faria com senhas e outras informações confidenciais. Algumas recomendações:
Para a chave de licença e a chave do browser, considere implementar uma estratégia de rotação de chaves: criar novas chaves e excluir as antigas em um cronograma definido. Considerações:
Não é possível excluir as chaves de ingestão originais associadas a uma conta, por isso recomendamos criar chaves de ingestão adicionais que você pode excluir posteriormente. Isso garante que você esteja assumindo uma postura de segurança forte.
Observe que isso não se aplica ao token do aplicativo mobile; você não pode excluir um token ou criar tokens adicionais.
Para o :
Instrua os membros da sua equipe a manterem suas chaves de usuário seguras.
Quando os membros saírem da sua organização, remova os IDs de usuário deles do New Relic. Isso desabilita todas as chaves de usuário associadas ao seu ID de usuário.
Girar chave de API
Veja como alternar cada uma de nossas quatro chaves de API mais comuns:
chave de licença são utilizadas para reportar quase todos os dados (exceto dados de browser e monitoramento de Mobile, que utilizam chaves próprias). Cada chave está vinculada a uma conta específica e o usuário pode criar quantas quiser. a chave de licença não pode ser atualizada e deve ser excluída e substituída criando uma nova chave.
Por padrão, todas as contas New Relic são criadas com uma chave de licença de conta original, que é compartilhada por toda a organização. Você não pode excluir essa chave da interface de chave da API, mas pode entrar em contato com o suporte da New Relic para alternar sua chave.
Para alternar a chave de licença criada pelo usuário:
Login como o usuário do New Relic cuja chave você deseja girar.
Clique em Create a key no canto superior direito da página API keys .
Insira um novo nome de chave, selecione Ingest - License para Key type, adicione uma descrição opcional e clique em Save.
Atualize qualquer script ou código que faça referência à chave antiga com o novo valor principal. Você pode encontrar a nova chave clicando no ícone ... na mesma linha da nova chave e depois clicando em Copy key.
Depois que qualquer dependência externa tiver sido atualizada, você poderá excluir com segurança a chave antiga clicando no ícone ... na mesma linha da chave antiga e, em seguida, clicando em Delete.
Você verá esta mensagem no canto inferior direito quando a chave for excluída com sucesso:
As chaves do browser são usadas para reportar dados de monitoramento do browser. Cada chave está vinculada a uma conta específica e os clientes podem criar quantas quiserem.
Por padrão, todas as contas New Relic são criadas com uma chave de browser de conta original, que é compartilhada por toda a organização. Você não pode excluir essa chave da interface de chave da API, mas pode entrar em contato com o suporte da New Relic para alternar sua chave.
Para girar chaves do browser criadas pelo usuário:
Login como o usuário do New Relic cuja chave você deseja girar.
Clique em Create a key no canto superior direito da página API keys .
Insira um novo nome de chave, selecione Ingest - Browser para Key type, adicione uma descrição opcional e clique em Save.
Atualize qualquer script ou código que faça referência à chave antiga com o novo valor principal. Você pode encontrar a nova chave clicando no ícone ... na mesma linha da nova chave e depois clicando em Copy key.
Depois que qualquer dependência externa tiver sido atualizada, você poderá excluir com segurança a chave antiga clicando no ícone ... na mesma linha da chave antiga e, em seguida, clicando em Delete.
Você verá esta mensagem no canto inferior direito quando a chave for excluída com sucesso:
O Monitoramento de Mobile usa um token de aplicativo mobile para reportar dados, em vez da chave de licença. Os tokens de aplicativos móveis são únicos e gerados novamente cada vez que um aplicativo é registrado no NR1. Para alternar as chaves móveis associadas ao seu aplicativo, autorize novamente o aplicativo no New Relic.
As chaves de usuário New Relic, às vezes chamadas de “chave de API pessoal”, são necessárias para usar o NerdGraph e nossa API REST. As chaves podem pertencer à organização ou a um usuário específico.
Você pode encontrar chaves de usuário para sua conta na interface de chave de API em one.newrelic.com/api-keys (ou one.eu.newrelic.com/api-keys para nosso data center na UE). Você verá apenas as chaves que tem permissão para usar, a menos que tenha todas as permissões de administrador do produto ou uma função personalizada que permita ver essas chaves.
Importante
Se você acredita que uma chave de usuário foi comprometida, você deve alternar all chaves associadas a esse usuário ou criadas por esse usuário.
Para alternar sua chave de usuário, você criará uma nova chave, atualizará as referências à chave antiga em seu software e, em seguida, excluirá a chave antiga. Para girar chaves na interface:
Login como o usuário do New Relic cuja chave você deseja girar.
Clique em Create a key no canto superior direito da página API keys .
Insira um novo nome de chave, selecione User para Key type, adicione uma descrição opcional e clique em Save.
Atualize qualquer script ou código que faça referência à chave antiga com o novo valor principal. Você pode encontrar a nova chave clicando no ícone ... na mesma linha da nova chave e depois clicando em Copy key.
Depois que qualquer dependência externa tiver sido atualizada, você poderá excluir com segurança a chave antiga clicando no ícone ... na mesma linha da chave antiga e, em seguida, clicando em Delete.
Você verá esta mensagem no canto inferior direito quando a chave for excluída com sucesso:
Também temos vários tipos de chave de API mais antigos ou menos comuns. Para girar essas chaves:
Estas são chaves mais antigas que não são recomendadas para uso pelos clientes, mas ainda são suportadas pela New Relic. Essas chaves são usadas para ingestão de dados por meio de nossa métrica, evento, log e e se aplicam trace API a toda a organização.
Para girar essas chaves:
Log no New Relic em uma conta com permissões de administrador.
No lado esquerdo da página, encontre a seção Looking for other keys? e clique no link do tipo de chave que você deseja girar:
Clique no ícone + para criar uma nova inserção ou chave de consulta.
Atualize qualquer script ou código que faça referência à chave antiga com o novo valor principal.
Depois que qualquer dependência externa for atualizada, você poderá excluir com segurança a chave antiga. Para remover uma chave, passe o mouse sobre ela e clique em Delete.
Esta é uma chave mais antiga que está obsoleta, mas ainda é suportada pela New Relic. Agora recomendamos usar a chave de usuário em vez da chave de API REST.
Você não pode girar esta chave, mas pode excluí-la.
Log no New Relic em uma conta com permissões de administrador.
No lado esquerdo da página, encontre a seção Looking for other keys? e clique em REST API key.
Clique em Delete REST API Key.
As chaves de API Pixie são usadas para autenticar aplicativos personalizados na plataforma Pixie. A chave de API Pixie não pode ser modificada. Para girar a chave de API Pixie, você deve criar uma nova chave e, em seguida, excluir a antiga. Para obter mais informações sobre a chave de API Pixie, consulte Gerenciando chave de API na documentação do Pixie.
A API de parceria não está disponível para sua organização, a menos que você seja especificamente instruído por seu representante da New Relic para usá-la. Para obter mais informações sobre a API, consulte Referência da API de parceria.
Para visualizar ou regenerar suas chaves, login no New Relic usando suas credenciais de proprietário de parceria e vá para Partnerships > Edit settingss.
Nossa chave principal usada para ingestão de dados é chamada de chave de licença. Na interface da chave da API e no NerdGraph, essa chave às vezes é referenciada como ingest - license.
A chave de licença é necessária para quase toda ingestão de dados do New Relic. As exceções são monitoramento de dados do browser (que usa uma chave de browser) e monitoramento de dados móveis (que usa um token de aplicativo mobile).
A chave de licença é uma sequência hexadecimal de 40 caracteres associada a uma conta New Relic. Quando você se inscreve pela primeira vez no New Relic, uma organização com uma única conta e sua própria chave de licença é criada. Se mais contas forem adicionadas, cada conta começará com sua própria chave de licença. A chave de licença criada originalmente para uma conta não pode ser excluída, mas você pode criar chaves de licença adicionais que podem ser gerenciadas e excluídas, e isso é útil para implementar práticas de segurança, como rotação de chaves. Se você precisar alternar a chave de licença original de uma conta, entre em contato com o suporte.
O monitoramento de Browser usa uma chave de browser para reportar dados, em vez da chave de licença. A chave do browser é utilizada para associar os dados do agente de monitoramento do Browser à sua conta.
Você não pode gerenciar ou excluir a chave do browser original criada quando sua conta foi criada, mas pode criar novas chaves do browser e excluí-las. Para obter assistência na rotação da chave original do browser de uma conta, entre em contato com o suporte.
O Monitoramento de Mobile usa um token de aplicativo mobile para reportar dados, em vez da chave de licença. Consulte Token de aplicativo mobile para obter mais informações.
As chaves de usuário New Relic, às vezes chamadas de “chave de API pessoal”, são necessárias para usar o NerdGraph e nossa API REST.
Um está vinculado a um usuário específico do New Relic e não pode ser transferido. A chave de usuário permite que você consulte qualquer conta à qual tenha acesso, não apenas a conta específica à qual a chave estava associada. Se um usuário do New Relic for excluído no New Relic, suas chaves de usuário também serão desativadas e não funcionarão.
Embora forneçam ao usuário acesso a várias contas, as chaves de usuário estão vinculadas a uma única conta específica: a conta a partir da qual foram criadas. A importância disso é que, se uma conta for excluída, quaisquer chaves de usuário associadas a essa conta não funcionarão mais. (Além disso, para nossa API REST, as chamadas de API estão limitadas à conta associada a essa chave de usuário.)
Além da chave de API principal explicada acima, temos várias outras chaves de API mais antigas que alguns clientes da New Relic ainda usam. Se você ainda não usa essas chaves, provavelmente não precisará começar.
Importante
Essa chave ainda está em uso, mas é altamente recomendável usar , que pode ser usada para as mesmas coisas e muito mais.
Uma de nossas chaves de API mais antigas do New Relic usadas para ingestão de dados é a chave de inserção insights , também conhecida como chave de inserção. Observe que a chave de licença é usada para a mesma funcionalidade e muito mais, por isso recomendamos a chave de licença em vez desta chave.
Esta chave é utilizada para a ingestão de dados através de nossa de evento API, log API, métrica API e Trace API, ou através da integração que utiliza essas APIs.
Dicas sobre disponibilidade e acesso:
Como essas chaves estão associadas a uma conta e não a um usuário específico, qualquer pessoa na conta com acesso a uma chave pode usá-la.
Como práticas recomendadas para fins de segurança, recomendamos que você use diferentes chaves de inserção insights para diferentes aplicativos ou diferentes fontes de dados.
A chave admin é uma de nossas chaves de API mais antigas e obsoletas. A partir de 4 de dezembro de 2020, todas as chaves de administrador existentes foram migradas para serem chaves de usuário.
Se você estava usando chaves de administrador, não precisa fazer nada para que essas chaves permaneçam ativas. Eles serão automaticamente acessíveis por meio da interface de chave da API, rotulados como chaves de usuário e com permissões idênticas. Você pode gerenciá-los como faria com qualquer chave de usuário por meio do mesmo fluxo de trabalho.
Todas as chaves de administrador migradas terão uma nota que diz Migrated from an admin user key na tabela de chaves.
A chave de API REST é uma chave mais antiga para usar nossa APIREST. Agora recomendamos usar a chave de usuário em vez da chave de API REST. O usuário é específico do usuário e não específico da conta, o que dá à sua organização mais controle sobre o acesso dos membros da sua equipe. Além disso, recomendamos usar nossa API mais recente, NerdGraph, em vez da API REST.
Coisas a considerar:
Cada conta New Relic pode ter apenas one chave de API REST.
Recomendamos usar uma chave de usuário em vez da chave de API REST.
Recomendamos usar o NerdGraph em vez da API REST, se possível.
Requer permissões de usuário em nível de administrador. Se você não tiver acesso à chave de API REST ou ao REST API Explorer, pode ser por falta de permissões. Fale com seu gerente de conta New Relic ou use uma chave de usuário.
Para localizar e gerenciar a chave de API REST: No menu do usuário, clique em API keys (obtenha um link direto para a página da chave de API). Em seguida, clique em REST API key. Antes de configurar ou excluir uma chave de API, certifique-se de fazer isso para a conta correta.