Esta página aborda as configurações do agente Node.js para distributed tracing, incluindo cabeçalhos do W3C Trace Context, controles de amostragem, eventos de span, Infinite Tracing e instrumentação de servidor gRPC.
As variáveis do agente Node.js que controlam o rastreamento multiaplicativo normalmente aparecem na seção cross_application_tracer do arquivo de configuração newrelic.js do seu aplicativo:
Importante
O rastreamento multiaplicativo foi descontinuado em favor do Distributed tracing e será removido em uma versão futura do agente.
Quando definido como true, permite o rastreamento de transações em mais de um aplicativo monitor New Relic.
Importante
O rastreamento multiaplicativo (CAT) foi descontinuado e será removido em uma versão principal futura. Para visibilidade entre serviços, recomendamos usar distributed tracing, que é habilitado por padrão a partir da versão 8.3.0 do agente. Antes de ativar, leia o guia de transição.
Distributed tracing
distributed tracing permite ver o caminho que uma solicitação percorre ao percorrer sistemas distribuídos. Ao configurar por meio do arquivo de configuração, coloque a seguinte opção na seção distributed_tracing . Ele está ativado por padrão no agente Node.js 8.3.0 e superior.
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:
Controla como as decisões de amostragem são feitas para spans raiz — transações que não têm um pai remoto (o que significa que não possuem um cabeçalho de distributed tracing traceparent ou newrelic de entrada). Os valores válidos são:
adaptive (padrão): usa o algoritmo de amostragem adaptável integrado do New Relic.
always_on: amostra todos os spans.
always_off: não faz a amostragem de nenhum span.
trace_id_ratio_based: faz a amostragem de uma proporção fixa de traces, determinada de forma determinística pelo ID do trace.
Por exemplo, para definir isso no arquivo de configuração, você usaria:
distributed_tracing:{
enabled:true,
sampler:{
root:'always_on'
}
}
Quando definido como trace_id_ratio_based, você também deve fornecer um ratio (um número entre 0 e 1):
Quando você define isso como adaptive, pode opcionalmente substituir o destino de amostragem (para 1–120 transações/minuto) especificamente para este amostrador:
Quando o cabeçalho traceparent tem um sinalizador de amostragem de 01, isso controla como lidar com a amostragem de spans. Os valores de string permitidos são:
adaptive (padrão): usa o algoritmo de amostragem adaptável integrado do New Relic.
always_on: amostra todos os spans.
always_off: não faz a amostragem de nenhum span.
trace_id_ratio_based: faz a amostragem de uma proporção fixa de traces, determinada de forma determinística pelo ID do trace.
Esta configuração tem precedência sobre remote_parent_not_sampled quando ambas puderem ser aplicadas.
Por exemplo, para habilitar isso no arquivo de configuração, você usaria:
distributed_tracing:{
enabled:true,
sampler:{
remote_parent_sampled:'always_on'
}
}
Quando você define isso como trace_id_ratio_based, deve fornecer um valor ratio de 0–1. Quando você define isso como adaptive, pode opcionalmente sobrescrever o destino de amostragem especificamente para este amostrador. Para a sintaxe equivalente, consulte os exemplos de formato de objeto e de variável de ambiente em sampler.root e substitua remote_parent_sampled por root.
Quando o cabeçalho traceparent tem um sinalizador de amostragem de 00, isso controla como lidar com a amostragem de spans. Os valores de string permitidos são:
adaptive (padrão): usa o algoritmo de amostragem adaptável integrado do New Relic.
always_on: amostra todos os spans.
always_off: não faz a amostragem de nenhum span.
trace_id_ratio_based: faz a amostragem de uma proporção fixa de traces, determinada de forma determinística pelo ID do trace.
Esta configuração só entra em vigor quando remote_parent_sampled não se aplica (ou seja, o sinalizador de amostragem traceparent é 00).
Por exemplo, para habilitar isso no arquivo de configuração, você usaria:
distributed_tracing:{
enabled:true,
sampler:{
remote_parent_not_sampled:'always_on'
}
}
Quando você define isso como trace_id_ratio_based, deve fornecer um valor ratio de 0–1. Quando você define isso como adaptive, pode opcionalmente sobrescrever o destino de amostragem especificamente para este amostrador. Para a sintaxe equivalente, consulte os exemplos de formato de objeto e de variável de ambiente em sampler.root e substitua remote_parent_not_sampled por root.
O destino de amostragem para amostragem adaptativa, em transações por minuto, usado ao configurar o amostrador padrão/adaptativo. Deve estar dentro do intervalo [1, 120] (inclusive). Ao se conectar ao New Relic, esse valor é enviado ao coletor, e o valor sampling_target retornado na resposta de conexão é usado como o destino de amostragem efetivo para amostragem adaptativa no agente.
Por exemplo, para definir isso no arquivo de configuração, você usaria:
distributed_tracing:{
enabled:true,
sampler:{
adaptive_sampling_target:20
}
}
Instrumentação de servidor gRPC
A seção grpc controla o comportamento de como o servidor gRPC é instrumentado.
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.
Lista delimitada por vírgulas de códigos de status gRPC para o coletor de erros ignorar, tanto na instrumentação do lado do cliente quanto do lado do servidor.
Cuidado
Erros registrados usando newrelic.noticeError() não obedecem a este valor de configuração.
Evento de extensão
Os dados de extensão são relatados para distributed tracing. distributed tracing deve ser ativado para relatar períodos. Defina a configuração do intervalo na seção span_events . As opções incluem:
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.
Para ativar o Rastreamento infinito, adicione as configurações abaixo. Defina a configuração do Rastreamento infinito na seção infinite_tracing . Além disso, distributed tracing deve estar habilitado. Observe que distributed tracing é habilitado por padrão para o agente APM Node.js versões 8.3.0 e superiores.
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.