Acesse a plataforma New Relic no conforto do seu terminal. Você pode usar a CLI do New Relic para gerenciar tags de entidade, definir carga de trabalho, registrar marcador de implantação e muito mais. Resumindo, você pode usar a CLI para automatizar tarefas comuns em seu fluxo de trabalho DevOps. Este guia orienta você nos fundamentos da CLI do New Relic, desde a instalação e configuração até o uso básico.
Antes de você começar
Para este guia você só precisa de:
- Sua chave de usuário do New Relic.
- Um aplicativo de instrumento em sua conta New Relic.
Instale a CLI do New Relic
Baixe a CLI do New Relic para o seu sistema operacional, conforme descrito abaixo. Você também pode baixar binários pré-construídos para todas as plataformas, incluindo .deb e .rpm pacotes e nosso Windows x64 .msi instalador.
Linux
Usando Snapcraft, execute:
$sudo snap install newrelic-cli
macOS
Usando Homebrew, execute:
$brew install newrelic-cli
Windows
Usando Scoop, execute:
$scoop bucket add newrelic-cli https://github.com/newrelic/newrelic-cli.git$scoop install newrelic-cli
Crie seu perfil CLI do New Relic
Depois de instalar a CLI do New Relic, é hora de criar seu primeiro perfil. Os perfis contêm credenciais e configurações que podem ser aplicadas a qualquer comando CLI, o que é útil ao alternar entre contas.
Execute o comando profiles add
:
$# Create the tutorial account for the US region$newrelic profiles add --profile tutorial --apiKey YOUR_NEW_RELIC_USER_KEY -r YOUR_REGION$# Set the profile as defaults$newrelic profiles default --profile tutorial
Importante
Você deve definir a região da sua conta New Relic. Use -r
para definir us
ou eu
.
Obtenha os detalhes do seu aplicativo
Agora, adicione tag ao aplicativo que você instrumentou com o New Relic. tag são pares de valor principal que podem ajudá-lo a organizar e filtrar sua entidade. Uma entidade (por exemplo, um aplicativo) pode ter no máximo 100 pares de valores principais vinculados a ela.
Antes de procurar seu aplicativo usando a CLI do New Relic, anote ou copie o ID da sua conta e o nome do seu aplicativo no New Relic - você precisa de ambos para encontrar aplicativos na plataforma New Relic.
Recupere os detalhes do seu aplicativo como um objeto JSON
Para procurar seu aplicativo APM, use o comando apm application search
:
$newrelic apm application search --accountId YOUR_ACCOUNT_ID --name NAME_OF_YOUR_APP
Dica
Se você receber um erro, verifique se o ID da sua conta e o nome do aplicativo estão corretos.
Encontre o valor guid
Se o ID da conta for válido e o nome do aplicativo existir na sua conta, apm application search
produzirá dados semelhantes a este exemplo:
[ { "accountId": YOUR_ACCOUNT_ID, "applicationId": YOUR_APP_ID, "domain": "APM", "entityType": "APM_APPLICATION_ENTITY", "guid": "A_LONG_GUID", "name": "NAME_OF_YOUR_APP", "permalink": "https://one.newrelic.com/redirect/entity/A_LONG_GUID", "reporting": true, "type": "APPLICATION" }]
Depois de pesquisar seu aplicativo com êxito, procure o valor guid
. É um identificador exclusivo para seu aplicativo. Você deve copiá-lo ou anotá-lo.
Adicione uma tag simples ao seu aplicativo
Agora que você tem o GUID, pode apontar a CLI do New Relic diretamente para seu aplicativo. Adicionar uma tag é a maneira mais simples de testar os recursos da CLI (não se preocupe, as tags podem ser excluídas usando entity tags delete
).
Aqui, você adiciona uma tag de ambiente ao seu aplicativo. Adicione a tag dev:testing
(ou qualquer outro par de valor principal) ao seu aplicativo usando o comando entities tags create
:
$newrelic entity tags create --guid YOUR_APP_GUID --tag devkit:testing
Adicionar conjuntos tag
E se você quiser adicionar várias tags? conjuntos tag para o resgate! Enquanto as tags são pares de valores principais separados por dois pontos, os conjuntos tag são listas de tags separadas por vírgula. Por exemplo:
tag1:value1,tag2:value2
Para adicionar várias tags ao seu aplicativo de uma vez, modifique e execute este trecho:
$newrelic entity tags create --guid YOUR_APP_GUID --tag tag1:test,tag2:test
Importante
Adicionar tag é uma operação assíncrona: isso significa que pode demorar um pouco para que a tag seja criada.
Recuperar a tag do seu aplicativo
Você criou e adicionou algumas tags ao seu aplicativo, mas para testar se elas estão funcionando, você precisa recuperá-las.
Execute o comando entity tags get
:
$newrelic entity tags get --guid YOUR_APP_GUID
Todas as tags associadas ao seu aplicativo são recuperadas como uma matriz JSON:
[ { "Key": "tag1", "Values": ["true"] }, { "Key": "tag2", "Values": ["test"] }, { "Key": "tag3", "Values": ["testing"] } // ...]
Etapa bônus: crie um marcador de implantação
A implantação do aplicativo muitas vezes dá errado. marcador de implantação são rótulos que, quando anexados aos dados do seu aplicativo, ajudam você a rastrear implantações e solucionar o que aconteceu.
Para criar um marcador de implantação, execute o comando apm deployment create
usando o mesmo ID do aplicativo da sua pesquisa anterior:
$newrelic apm deployment create --applicationId YOUR_APP_ID --revision $(git describe --tags --always)
Verifique a resposta JSON para a revisão e timestamp da implantação
Você pode construir esse fluxo de trabalho em um sistema de integração contínua ou implantação contínua (CI/CD) para indicar alterações no comportamento do seu aplicativo após a implantação.
Aqui está um exemplo:
{ "id": 37075986, "links": { "application": 204261368 }, "revision": "v1.2.4", "timestamp": "2020-03-04T15:11:44-08:00", "user": "Developer Toolkit Test Account"}
Próximos passos
Dê uma olhada em todos os comandos disponíveis na CLI do New Relic. Por exemplo, você pode criar um fluxo de trabalho New Relic usando workload create
Se você quiser interagir com outros membros da comunidade, visite nossa página New Relic Explorer Hub . Aceitamos solicitações de recursos ou relatórios de bugs no GitHub.