Configuração do agente Node.js

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.

Se você estiver usando New Relic CodeStream para monitor o desempenho do seu IDE, talvez você também queira associar o repositório aos seus serviços e associar SHAs de compilação ou tag de lançamento aos erros.

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.

O nome que a New Relic usa para identificar seu aplicativo. Por exemplo, app_name: ['MyNodeApp']. Para usar vários nomes para seu aplicativo, especifique uma lista de nomes delimitados por vírgulas.

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.

Esta configuração é obrigatória. Sua New Relic chave de licença. Por exemplo, license_key: '40HexadecimalCharacters'.

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.

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.

Configure seu Apdex T através da interface do New Relic.

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.

certificates: [ fs.readFileSync('myca.crt', {encoding: 'utf8'}) ]

Quando definido como true, ativa alta segurança v2. Você também deve ativar a configuração ssl e ativar alta segurança na interface.

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).

Número da porta para conexão ao coletor New Relic; por exemplo, port: 443.

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.
• Se você estiver usando o Infinite Tracing: veja como configurar um proxy para o Infinite Tracing.

Nome do host ou endereço IP do servidor proxy para conexão com a Internet.

Senha para autenticação no servidor proxy. O agente oferece suporte apenas à autenticação HTTP básica.

Número da porta do servidor proxy para conexão à Internet.

Nome de usuário para autenticação no servidor proxy. O agente oferece suporte apenas à autenticação HTTP básica.

Habilita ou desabilita o log específico do agente.

Define o nível de detalhe registrado no log do agente. Do menor ao maior detalhe, os valores possíveis são fatal, error, warn, info, debug ou trace.

Caminho completo para o log do agente New Relic, incluindo o nome do arquivo. O padrão é filepath: require('path').join(process.cwd(), 'newrelic_agent.log'). O agente encerrará o processo se não conseguir criar este arquivo. O agente cria um arquivo de log com as mesmas permissões que o processo pai do agente Node.js.

• Para gravar todos os registros em stdout, defina como stdout.
• Para gravar todos os registros em stderr, defina como stderr.

Quando definido como true, ativa o AI Monitoring. Permite que o agente capture dados de eventos LLM.

Quando definido como false, desativa a instrumentação para dados LLM transmitidos. Definido como true, captura dados transmitidos para evento LLM.

Se definido como false, o agente omite o conteúdo de entrada e saída (como sequências de texto de prompt e respostas) capturado no evento LLM. Esta é uma configuração de segurança opcional se você não quiser registrar dados confidenciais enviados e recebidos de seus LLMs.

O ID da conta AWS AWS associada a este aplicativo.

Quando habilitado, o agente registra a carga que envia ao coletor. Esses dados são incluídos no arquivo de log principal mesmo quando o nível de log está definido para o nível mais baixo.

O agente envia vários tipos diferentes de dados ao coletor em cargas separadas. Por padrão, todos eles estão incluídos no arquivo de log. Esta opção permite limitar o registo apenas a tipos específicos de dados.

Os valores válidos incluem:

• agent_settings
• analytic_event_data
• connect
• custom_event_data
• error_data
• error_event_data
• metric_data
• preconnect
• shutdown
• span_event_data
• sql_trace_data
• transaction_sample_data

Esta opção ativa newrelic.addCustomAttribute e newrelic.addCustomAttributes.

Esta opção ativa recordCustomEvent.

Esta opção habilita newrelic.noticeError.

Se true, habilita a captura de atributo para todos os destinos.

Prefixo de atributo para excluir de todos os destinos. Permite * como curinga no final.

Prefixo de atributo para incluir de todos os destinos. Permite * como curinga no final.

Quando true, os padrões podem ser adicionados à lista attributes.include .

Quando ativado, o agente coleta rastreamento de erros do seu aplicativo.

Lista delimitada por vírgulas de códigos de status HTTP para o coletor de erros ignorar.

Lista delimitada por vírgulas de tipos/classes de erros javascript para o coletor de erros ignorar.

A seguinte configuração

error_collector: {
    /* ... */
    ignore_classes: ["ReferenceError"]
}

Ignoraria todos os erros de referência.

Um objeto JavaScript que descreve uma lista de classes vinculadas à mensagem de erro para o coletor ignorar. A configuração a seguir ignoraria todos os erros do tipo Error com as sequências de mensagens exatas (diferenciando maiúsculas de minúsculas) de Undefined e Out of time:

error_collector: {
    /* ... */
    ignore_messages: {"Error":["Undefined", "Out of time"]}
}

Ignoraria todos os erros do tipo Error, com as sequências de mensagens exatas (diferenciando maiúsculas de minúsculas) de Undefined e Out of time.

Lista delimitada por vírgulas de códigos de status HTTP para o coletor de erros marcar como esperado.

A seguinte configuração

error_collector: {
    /* ... */
    expected_classes: ["ReferenceError"]
}

Marcaria todos os erros de referência como esperado.

Um objeto javascript que descreve uma lista de classes javascript vinculadas à mensagem de erro javascript para o coletor ignorar. A seguinte configuração.

error_collector: {
    /* ... */
    expected_messages: {"Error":["Undefined", "Out of time"]}
}

Marcaria todos os erros do tipo Error, com as sequências de mensagens exatas (diferenciando maiúsculas de minúsculas) de Undefined e Out of time.

Se true, o agente captura um atributo da coleta de erros.

Prefixo de atributo para excluir da coleta de erros. Permite * como curinga no final.

Prefixo do atributo a ser incluído na coleta de erros. Permite * como curinga no final.

Define o número máximo de eventos que o agente coleta por minuto. Se houver mais que esse número, o agente coleta uma amostragem estatística.

Quando habilitado, o agente coleta rastreamento lento da transação.

Duração mínima da consulta (em milissegundos) para que uma transação seja elegível para consulta lenta no rastreamento da transação.

Esta opção afeta tanto a consulta lenta quanto record_sql para rastreamento da transação. Pode ter estes valores: off, obfuscated ou raw.

Quando definido como off , nenhuma consulta lenta será capturada e backtraces e SQL não serão incluídos no rastreamento da transação. Se definido como raw ou obfuscated, o agente envia SQL bruto ou ofuscado e uma amostra de consulta lenta para o coletor. O agente também pode enviar SQL quando outros critérios forem atendidos, como quando slow_sql.enabled for definido.

Define o número máximo de solicitações elegíveis para rastreamento da transação.

Transações são nomeadas com base na solicitação e top_n refere-se às "transações principais e mais lentas" agrupadas por esses nomes. O módulo substitui um trace gravado por um novo trace apenas se o novo trace for mais lento que o trace anterior mais lento com esse nome. O valor padrão para esta configuração é top_n: 20, porque a páginaTransactions também assume como padrão as 20 transações mais lentas.

O agente Node.js captura pelo menos cinco transações lentas diferentes no primeiro ciclo de coleta após a inicialização. Ele também redefinirá e capturará diferentes transações se nenhuma transação lenta tiver sido capturada nos últimos cinco ciclos de coleta. Isso permite que você veja mais informações sobre mais caminhos de solicitação do seu aplicativo, ao possível custo de não focar na solicitação absolutamente mais lenta para aquele ciclo de coleta.

Define o tempo, em segundos, para que um trace da transação seja considerado lento. O valor padrão é apdex_f; isso define o limite trace para quatro vezes o Apdex T do seu aplicativo. Se for fornecido um número, ele será definido em segundos.

O apdex_t padrão é 500 milissegundos. Se o seu limite de transação estiver definido como apdex_f, uma transação "lenta" dura 2 segundos.

Se true, o agente captura o atributo do rastreamento da transação.

Prefixo de atributo para excluir do rastreamento da transação. Permite * como curinga no final.

Prefixo do atributo a incluir no rastreamento da transação. Permite * como curinga no final.

Uma lista de regras delimitadas por vírgulas para corresponder aos URLs de solicitação recebida e nomear a transação New Relic associada. Usa o formato:

name: [
    { pattern: 'STRING_OR_REGEX', name: 'NAME' },
    { pattern: 'STRING_OR_REGEX', name: 'NAME' }
]

Ambos os parâmetros são obrigatórios. Para strings, você deve escapar dos caracteres de controle. Você não precisa escapar dos caracteres de controle em expressões regulares. Atributos adicionais são ignorados.

As expressões regulares suportam grupos de captura no estilo JavaScript e os nomes usam strings de substituição no estilo $1 . As expressões regulares encontram apenas o primeiro resultado correspondente; as correspondências subsequentes são ignoradas. Para obter mais informações, consulte API de nomenclatura de transação do Node.js.

Para a variável de ambiente NEW_RELIC_NAMING_RULES , transmita as regras como literais de objeto JSON delimitados por vírgula:

NEW_RELIC_NAMING_RULES='{"pattern":"^t","name":"u"},{"pattern":"^u","name":"t"}'

Defina uma lista de URLs de solicitação que você deseja que o agente ignore. Especifique a lista como padrões, que podem ser strings ou expressões regulares. O valor padrão é uma expressão regular para corresponder às solicitações de pesquisa longa do socket.io

Quando ativado, o agente renomeia transações que não são afetadas por outra lógica de nomenclatura (como API, regras ou regras de normalização de métricas) para NormalizedUri/*. Se você definir isso como false, o agente definirá os nomes de transação como Uri/path/to/resource.

Quando habilitado, o agente envia evento de transação para New Relic. Esses dados do evento incluem o tempo da transação, o nome da transação e qualquer atributo personalizado. Se estiver desabilitado, o agente não coleta esses dados nem os envia para a New Relic.

Define o número máximo de eventos que o agente coleta por minuto. Se houver mais que esse número, o agente coleta uma amostragem estatística.

Não recomendamos configurar além de 10.000. O servidor limitará os dados a 10.000 por minuto.

Define o número máximo de eventos que o agente armazena caso não consiga se comunicar com o coletor New Relic. Os valores do ciclo de coleta anterior serão mesclados no próximo, limitando esta opção o número máximo. Certifique-se de que este número seja maior que max_samples_per_minute; por exemplo, defina-o para o dobro. Considere a sobrecarga de memória antes de aumentar esse valor.

Define o número máximo de eventos que o agente coleta por minuto. Se houver mais que esse número, o agente coleta uma amostragem estatística.

Se true, o agente captura o atributo do evento de transação.

Prefixo do atributo para excluir do evento de transação. Permite * como curinga no final.

Prefixo do atributo a ser incluído no evento da transação. Permite * como curinga no final.

Gere cabeçalhos JavaScript para instrumentação do browser. Se definido como true o agente não injetará automaticamente o código JS do browser, a menos que você tenha ativado manualmente monitoramento de browser. Mesmo que você tenha ativado e adicionado o cabeçalho de tempo do browser, você pode desativar o monitoramento do browser para seu aplicativo configurando-o como false.

Se true, solicite fontes não minificadas do servidor.

Se true, o agente envia um atributo personalizado ao monitoramento do Browser.

Prefixo de atributo para excluir do monitoramento de Browser. Permite * como curinga no final.

Prefixo de atributo a incluir no monitoramento de Browser. Permite * como curinga no final.

Quando habilitado, o agente envia evento personalizado gravado com recordCustomEvent() para New Relic. Se estiver desabilitado, o agente não coleta esses dados nem os envia para a New Relic.

• Define o número máximo de eventos personalizados que o agente coleta por minuto. Caso o número de eventos personalizados ultrapasse esse limite, o agente coleta uma amostragem estatística.

• Ao configurar o agente para AI Monitoring, defina o valor máximo 100000. Garante que a quantidade máxima de eventos LLM seja capturada.

  Importante

  Aumentar esse limite pode aumentar o uso de memória.

Quando ativado, o agente coleta detalhes da consulta lenta.

Define o número máximo de consultas lentas que o agente coleta por minuto. O agente descarta consultas adicionais após atingir o limite.

Especifique um nome do host personalizado para exibição no New Relic. Se você não definir este campo, o New Relic continuará usando o nome do host padrão encontrado chamando os.hostname().

• Se você usar as configurações padrão de nome do host, o New Relic encontrará o nome do host por meio de os.hostname().
• Se esta chamada falhar, o New Relic usará o IP do host como nome.
• Se você definir ipv_preference: 4 ou ipv_preference: 6, poderá selecionar o tipo de endereço IP (IPv4 ou IPv6) que aparece na interface do New Relic.

Quando habilitado, o agente coleta métricas de instância do datastore (como host e porta) para algum driver do banco de dados. Estes são relatados em consulta lenta trace e trace da transação.

Quando habilitado, o agente coleta o nome do banco de dados em consulta lenta trace e trace da transação para algum driver do banco de dados.

Quando definido como true, permite o rastreamento de transações em mais de um aplicativo monitor New Relic.

Quando true, o agente redigirá as mensagens de erros capturados.

Defina como false para desativar distributed tracing. Por exemplo, no arquivo de configuração, você usaria:

distributed_tracing: {
    enabled: false
}

Defina como true para excluir o cabeçalho New Relic anexado às solicitações de saída e, em vez disso, confiar apenas nos cabeçalhos W3C Trace Context para distributed tracing. Se for false , ambos os tipos de cabeçalho serão usados.

Por exemplo, para habilitar isso no arquivo de configuração, você usaria:

distributed_tracing: {
    enabled: true,
    exclude_newrelic_header: true
}

Quando habilitado, o agente enviará todos os códigos de status gRPC de erro para o New Relic, ou seja, códigos de status diferentes de zero. Se desativado, a instrumentação do servidor não enviará nenhum código de status diferente de zero para o New Relic.

Ativa ou desativa o relatório do evento span.

Esta configuração pode ser usada para ativar ou desativar o relatório de atributo para períodos. Se attributes.enabled no nível raiz for false, nenhum atributo será enviado com intervalos, independentemente de como isso for definido.

Se atributo estiver habilitado para spans, todas as chaves atributo encontradas nesta lista serão anexadas aos spans. Para mais informações, consulte as regras de atribuição de agentes.

Todas as chaves de atributo encontradas nesta lista não serão enviadas com spans. Para mais informações, consulte as regras de atribuição de agentes.

Para obter ajuda para obter uma entrada válida de host do observador trace do Infinite Tracing, consulte Localizar ou criar um endpoint do observador trace .

A quantidade de intervalos de rastreamento infinito que o agente manterá na memória antes de descartá-los.

Essa configuração raramente precisa ser alterada do padrão, pois a fila não está em uso na maior parte do tempo. A fila está em uso somente durante reconexões com o endpoint do Infinite Tracing enquanto o agente não consegue transmitir dados. É possível que o agente elimine períodos de rastreamento infinito durante esses períodos; nesse caso, aumentar esse número pode ajudar.

Permite a geração automática de logs contextualizados.

Por exemplo, para desabilitar esse recurso no arquivo de configuração, você usaria:

application_logging: {
    enabled: false
}

Alterna se o agente coleta métricas de Log usadas no gráfico Logs na página Resumo do APM.

Alterna se o agente coleta registros de log para enviar ao New Relic.

Número de registros de log a serem enviados por minuto para o New Relic. Controla o consumo geral de memória ao usar o encaminhamento de logs.

Defina um valor mais baixo para reduzir a quantidade de linhas de log enviadas (pode causar amostragem de log). Defina um valor mais alto para enviar mais linhas de log.

Cada log recebe a mesma prioridade que sua transação associada. log que ocorrem fora de uma transação receberão uma prioridade aleatória. Alguns registros podem não ser incluídos porque são limitados por max_samples_stored. Por exemplo, se o registro em log max_samples_stored estiver definido como 10.000 e a transação 1 tiver 10.000 entradas de log, somente as entradas de log da transação 1 serão registradas. Se a transação 1 tiver menos de 10.000 logs, você receberá todos os logs da transação 1. Se ainda houver espaço, você receberá todo o log da transação 2 e assim por diante.

Se após todos os logs de transação amostrados forem registrados, e eles não atingirem o limite em max_samples_stored, então será enviada a mensagem do log de transação amostrada que não estava em nossa amostragem. Se sobrar alguma, as mensagens do log fora da transação serão registradas.

Alterna se o agente executa a decoração log local na saída de log padrão.

Alterna se é necessário capturar atributo adicional em spans de middleware para toda a estrutura da web Node.js que ajuda a impulsionar o nível do código métrico. Os atributos adicionais são: code.filepath, code.function, code.lineno e code.column.

Ativa a ofuscação de URL do agente de nó com base em regex.

Especifica o padrão regex a ser usado para ofuscação de URL. Se isso não for definido, nenhuma ofuscação de URL será executada.

Especifica os sinalizadores regex a serem usados para correspondência de padrão de ofuscação de URL, por exemplo g para correspondência global, i para correspondência sem distinção entre maiúsculas e minúsculas, etc. Vários sinalizadores podem ser especificados como uma string, por exemplo gi. Se isso não for definido, nenhum sinalizador será usado.

Especifica a cadeia de caracteres de substituição a ser usada para ofuscação de URL. Pode conter referências para capturar grupos no padrão, por exemplo $1. Se não for definido, tudo será substituído por uma única string vazia.

Alterna se os dados do agente de segurança da New Relic são enviados para a New Relic ou não. Quando estiver desabilitado e security.agente.enabled for verdadeiro, o agente de segurança será cadastrado mas os dados não serão enviados.

Alterna se o agente New Relic Security está carregado. Esta propriedade é lida apenas uma vez no início do aplicativo.

Modo fornecido pela New Relic Security: IAST. O padrão é IAST. Devido à natureza invasiva da varredura IAST, NÃO ative esse modo em um ambiente de produção ou em um ambiente onde os dados de produção são processados.

URL de conexão New Relic Security. Este é o endpoint para o qual o agente de segurança envia dados; ele deve corresponder ao ambiente que você configurou para o agente Node.js.

Ative a detecção de eventos de segurança RCI.

Habilite a detecção de eventos de segurança RXSS.

Habilite a detecção de eventos de segurança de desserialização.

Se for verdade, o agente usa nomes dyno Heroku como nome do host.

Se for verdade, o agente será carregado quando estiver em um thread de trabalho, se especificado.

Caminho para o diretório que contém newrelic.js. Isso está disponível apenas como uma variável de ambiente. Você não pode configurá-lo em seu arquivo de configuração.

Se usado, evita que o agente leia as definições de configuração de newrelic.js. Os valores padrão e os valores das variáveis de ambiente ainda serão definidos.

Isso está disponível apenas como uma variável de ambiente. Você não pode configurá-lo em seu arquivo de configuração.

Tipos de matriz são definidos como strings delimitadas por vírgula.

NEW_RELIC_ERROR_COLLECTOR_IGNORE_ERROR_CODES=404,500,429

Os tipos de objeto são definidos como uma string json.

NEW_RELIC_ERROR_COLLECTOR_EXPECTED_MESSAGES='{"Error":["Undefined", "No soup for you!"]}'