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.
Chaves de ingestão (para conta): Ao criar uma chave de ingestão, fornecemos temporariamente a chave completa. No entanto, após a criação da chave, apenas os primeiros 8 caracteres são exibidos na interface do usuário de chaves de API. Se você precisar recuperar a chave completa após a criação, clique nas reticências na interface do usuário de chaves de API, copie a ID da chave e use o NerdGraph para consultar a chave completa.
Chaves de usuário (para seu próprio uso): Ao criar uma chave de usuário para seu próprio uso, fornecemos temporariamente a chave completa. No entanto, após a criação da chave, apenas os primeiros 8 caracteres são exibidos na interface do usuário de chaves de API. Se você precisar recuperar a chave completa após a criação, clique nas reticências na interface do usuário de chaves de API, copie a ID da chave e use o NerdGraph para consultar a chave completa.
Chaves de usuário (para outros usuários): Ao criar uma chave de usuário para outro usuário, você sempre verá apenas a versão truncada da chave na interface do usuário de chaves de API e via NerdGraph.
Recomendações para gerenciamento de chave de API
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.
Mostra quando uma chave esteve ativa pela última vez. Use isso para identificar chaves obsoletas antes de rotacioná-las ou excluí-las.
Apenas chaves de usuário
Consulte a coluna
Last used
.
Chaves de usuário: armazena de forma durável sem limite de tempo.
Chaves de ingestão de licença: não suportado.
Chaves de ingestão do Browser: não suportadas.
Owning team
Atribui uma ou mais equipes a uma chave para que você sempre saiba quem contatar antes de rotacioná-la ou desativá-la.
Apenas chaves de ingestão de licença
Passe o mouse sobre a linha de uma chave, clique em
Edit
na coluna
Team
, selecione as equipes e clique em
Save
. Use o filtro
Team
para encontrar todas as chaves atribuídas a uma equipe específica. Também é possível definir as equipes proprietárias ao criar ou atualizar chaves de ingestão via NerdGraph usando o parâmetro
owningTeamIds
.
Chaves de usuário: não disponíveis.
Chaves de ingestão de licença: suportado. Uma chave pode ter várias equipes.
Chaves de ingestão do Browser: não disponíveis.
Chave de conta padrão: N/A
Deactivate / Reactivate
Impede temporariamente que uma chave seja autenticada sem excluí-la. Use isso para conter um possível incidente de segurança ou para executar um scream test.
Todos os tipos de chave
Para desativar: clique em ... em uma linha de chave, selecione Deactivate key e confirme.
Para reativar: filtre por Status > Deactivated, clique em ... e selecione Activate key.
To manage keys via NerdGraph, use the enabled field in the create or update key mutations. Set enabled: false to deactivate a key. Set enabled: true to reactivate it. Omit the field to leave the key's status unchanged.
Chaves de usuário: suportadas.
Chaves de ingestão de licença: suportadas. Interrompe a ingestão de dados até que você a reative.
Chaves de ingestão do Browser: suportado.
Chave de conta padrão: você não pode desativar esta chave.
Permissões necessárias
Ação
Permissão necessária
Visualizar último uso, equipe proprietária
Acesso de leitura da chave
Atribuir ou remover equipe proprietária
Acesso de edição de chave
Desativar ou reativar sua própria chave
Nenhuma permissão adicional é necessária
Desativar ou reativar a chave de outro usuário
Gerenciar todas as chaves de API de usuário
Substituir chaves de API
Veja como substituir cada uma das 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 da New Relic são criadas com uma chave de licença da conta original, que é compartilhada por toda a organização. Você não pode excluir esta chave da interface de chaves de API, mas pode entrar em contato com o suporte da New Relic para regenerar esta chave.
Para substituir chaves de licença criadas pelo usuário:
Faça login como o usuário do New Relic cuja chave você deseja substituir.
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.
Uma mensagem de confirmação é exibida no canto inferior direito quando a chave é 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 da New Relic são criadas com uma chave de navegador da conta original, que é compartilhada por toda a organização. Você não pode excluir esta chave da interface de chaves de API, mas pode entrar em contato com o suporte da New Relic para regenerar esta chave.
Para substituir chaves de navegador criadas pelo usuário:
Faça login como o usuário do New Relic cuja chave você deseja substituir.
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.
Uma mensagem de confirmação é exibida no canto inferior direito quando a chave é excluída com sucesso.
O monitoramento de mobile usa um token de aplicativo móvel para reportar dados, em vez da chave de licença. Os tokens de aplicativo móvel são todos únicos e gerados novamente sempre que um aplicativo é registrado no NR1. Para substituir as chaves mobile associadas ao seu aplicativo, reautorize 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 as chaves de usuário para sua conta na interface da chave de API em one.newrelic.com/api-keys (ou one.eu.newrelic.com/api-keys para nosso data center da UE, ou one.jp.newrelic.com/api-keys para nosso data center do JP). 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 substituir all chaves associadas a esse usuário ou criadas por esse usuário.
Para substituir 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 substituir chaves na interface do usuário:
Faça login como o usuário do New Relic cuja chave você deseja substituir.
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.
Uma mensagem de confirmação é exibida no canto inferior direito quando a chave é excluída com sucesso.
Também temos vários tipos de chaves de API mais antigos ou menos comuns. Para substituir estas 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 substituir estas chaves:
Log no New Relic em uma conta com permissões de administrador.
No lado direito da página, encontre a seção Looking for other keys? e clique no link para o tipo de chave que você deseja substituir.
Clique no ícone + para criar uma nova chave de 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.
As chaves de API do Pixie são usadas para autenticar aplicativos personalizados na plataforma Pixie. As chaves de API do Pixie não podem ser modificadas. Para substituir as chaves de API do Pixie, você deve criar uma nova chave e, em seguida, excluir a antiga. Para mais informações sobre as chaves de API do Pixie, consulte Gerenciamento de chaves 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 string hexadecimal de 40 caracteres associada a uma conta da New Relic. Quando você se inscreve no New Relic pela primeira vez, uma organização com uma única conta e sua própria chave de licença são criadas. Se mais contas forem adicionadas, cada conta começa 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, o que é útil para implementar práticas de segurança, como a rotação de chaves. Se você precisar substituir 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.
