Esta página aborda as definições principais do agente Node.js, incluindo nome do aplicativo, chave de licença, configuração de proxy e como os métodos de configuração interagem.
A configuração license_key é obrigatória. Além disso, é altamente recomendável definir app_name para que seu aplicativo tenha um nome significativo em vez do My Application padrão.
Métodos de configuração e precedência
O método principal para configurar o agente Node.js é o arquivo de configuração do agente (newrelic.js). Você também pode definir a maioria das configurações com variáveis de ambiente. Você também pode ajustar algumas configurações com Configuração no lado do servidor.
O agente Node.js usa esta ordem de precedência para métodos de configuração:
Node.js configuration hierarchy: Configuração no lado do servidor as configurações substituem as variáveis de ambiente. As variáveis de ambiente substituem o arquivo de configuração do agente. O arquivo de configuração substitui os padrões do agente.
Aqui estão descrições detalhadas de cada método de configuração:
O arquivo de configuração (newrelic.js) contém todas as configurações do agente Node.js. Ao instalar o agente Node.js, você deve copiar newrelic.js no diretório raiz do seu aplicativo. A maioria das configurações está vazia por padrão; eles herdam seus valores de config/default.js.
Se seu aplicativo estiver rodando em CommonJS, basta alterar o tipo do arquivo de configuração para (newrelic.cjs). Este tipo de arquivo é suportado a partir da versão 7.5.0 do agente Node.js.
Todas as definições de configuração em newrelic.js possuem variáveis de ambiente equivalentes. Eles são úteis, por exemplo, se o seu agente for executado em um ambiente PaaS como Heroku ou Microsoft Azure. As variáveis de ambiente do agente Node.js sempre começam com NEW_RELIC_.
Essas variáveis de ambiente estão documentadas abaixo em opções de configuração individuais como Environ variable. Existem também duas configurações raramente usadas que só podem ser definidas por meio de variáveis de ambiente. Se você não tiver certeza de como especificar tipos mais complexos como variáveis de ambiente, use o guia de referência.
Proprietários e administradores podem visualizar e definir algumas configurações diretamente no New Relic. Quando disponíveis, os rótulos de interface para configuração do lado do servidor estão listados neste documento em opções de configuração individuais como Server-side label.
Exporta variáveis
Esta seção define as variáveis do agente Node.js na ordem em que normalmente aparecem na seção exports.config = { do arquivo de configuração newrelic.js do seu aplicativo.
Os dados de todos os aplicativos com o mesmo nome serão mesclados na interface do New Relic, portanto, defina isso com cuidado. Solicitamos highly recommend que você substitua o nome padrão por um nome descritivo para evitar confusão e agregação não intencional de dados.
Dica
Para usuário do Azure, o agente Node.js usará APP_POOL_ID se estiver definido, para que você possa usar o nome escolhido para o servidor Web do Azure sem configurá-lo duas vezes.
Defina como false para interromper a inicialização do agente. Isso é útil quando a depuração do seu código requer a desativação temporária do agente. Impede que o agente inicie sua instrumentação ou configure todas as suas peças, o que impede que o agente inicialize e se conecte aos servidores da New Relic.
Se true, permite a captura de todos os cabeçalhos HTTP, exceto aqueles filtrados pelas regras exclude . Se false, os cabeçalhos coletados serão limitados àqueles definidos no atributo do agente Node.js.
Quaisquer regras de inclusão/exclusão relacionadas ao cabeçalho devem estar no formato camelCase para serem filtradas.
Se o limite de compactação de dados for atingido na carga útil, o agente compactará os dados usando a compactação gzip por padrão. A opção de configuração compressed_content_encoding pode ser definida como deflate para usar compactação deflacionada.
Certificados adicionais para confiar em conexões SSL, especificados como uma matriz de strings no formato PEM. Isso afeta as conexões com um proxy HTTPS e as conexões com o New Relic.
Dica
Você também pode configurar o agente para ler seus certificados de um arquivo:
Não edite esse valor, a menos que o suporte da New Relic solicite que você o altere.
Nome do host para o coletor New Relic se conectar à Internet; por exemplo, host: 'collector.newrelic.com'.
Adiciona etiqueta. Especifique sua tag como objetos ou uma string delimitada por ponto e vírgula de pares separados por dois pontos (por exemplo, Server:One;Data Center:Primary).
Uma URL especificando o servidor proxy para conexão com a Internet. Por exemplo, proxy: 'http://user:pass@10.0.0.1:8000/'. Considerações importantes:
A configuração do arquivo de configuração proxy substitui as outras configurações de proxy do arquivo de configuração (proxy_host, proxy_port, proxy_user, proxy_pass), se usada. Da mesma forma, a variável de ambiente NEW_RELIC_PROXY_URL substitui as outras configurações de proxy da variável de ambiente (NEW_RELIC_PROXY_HOST, NEW_RELIC_PROXY_PORT, NEW_RELIC_PROXY_USER e NEW_RELIC_PROXY_PASS), se usada.