Logs contextualizados do agente Node.js

Com nosso APM de agente Node.js, você pode obter o logs contextualizados, o que permite ver o registro do seu aplicativo no contexto de outros dados New Relic . Para informações gerais sobre este recurso, consulte logs contextualizados APM.

Dica

Tem muitos logs do Node.js? Confira nosso tutorial sobre como otimizá-los e gerenciá-los.

Opções de logs contextualizadosn automático

Com o log do aplicativo, seu agente APM coleta e contextualiza automaticamente seus logs.

Se estiver usando um framework suportado, você tem três opções para configurar o logs contextualizados APM para enviar o log do seu aplicativo e vincular metadados automaticamente ao New Relic.

A estrutura suportada para logs contextualizados automático inclui:

Winston 3.0.0 ou mais alto.
Pino 7.0.0 ou superior.
Bunyan 1.8.12 ou superior (desde a versão 9.3.0 do agente)

Se você não estiver usando um framework suportado, você pode usar o método API de encaminhamento de logs do agente para realizar sua própria instrumentação. Para obter detalhes, consulte a documentação da API do agente Node.js.

Importante

As versões 8.16.0 e superiores do agente possuem esse recurso habilitado no arquivo de configuração do agente por padrão.

Agente encaminhamento de logs causará um aumento no consumo de dados quando uma frameworksuportada for detectada. A quantidade depende do aplicativo e da quantidade de log que ele produz. Este recurso pode ser desativado. Consulte Desativar o registro automático para obter mais informações sobre suas opções.

Se você já possui uma solução de encaminhamento de logs instalada, você deve desabilitar este recurso.

Esta é a abordagem mais simples e é uma ótima opção para desenvolvedores que podem não ter acesso ou interesse em configurar um direcionador de logs ou para contas que desejam ver o poder do log e outros metadados de vinculação no contexto de seus aplicativos sem muita sobrecarga.

Usando esta opção, o agente reporta todo o seu log e adiciona nossos atributos span.id, trace.id, hostname, entity.guid e entity.name. Esses atributos vinculam seu log a spans, rastreamento e outras telemetrias, facilitando a solução de problemas.

Tudo o que você precisa fazer é instalar uma versão do agente com recursos de encaminhamento de logs (Node.js agente 8.11.0 ou superior). Se o encaminhamento estiver desabilitado, você poderá usar esta configuração:

newrelic.js:

application_logging: {
  forwarding: {
    enabled: true
  }
}

Variável de ambiente:

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true

Esta opção está ativada por padrão desde a versão 8.16.0 do agente.

Optional adjustments:

Depois de habilitado, você também terá controle sobre o número máximo de logs enviados ao New Relic a cada minuto. O valor padrão é 10.000. Se mais de 10.000 logs forem recebidos em uma janela de 60 segundos, seu log começará a ser amostrado.

Defina-o para um número mais alto para receber mais log. Defina-o para um número menor para receber menos log. Qualquer número inteiro até 100.000 é válido. Aumentar esse valor pode aumentar a utilização de CPU e RAM do agente.

newrelic.js:

application_logging: {
  forwarding: {
    max_samples_stored: 10000
  }
}

Variável de ambiente:

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED: 10000

Se você tiver uma solução de encaminhamento de logs existente e estiver atualizando seu agente para usar o logs contextualizados automáticos, certifique-se de disable your manual log forwarder. Caso contrário, seu aplicativo enviará linhas de log duplas. Dependendo da sua conta, isso pode resultar em cobrança dupla. Para obter mais informações, siga os procedimentos para desabilitar seu direcionador de logs específico.

Já tem um encaminhador de logs que você gosta? Estamos protegendo você! O agente de linguagem pode decorar seu log com os metadados de link necessários para fornecer acesso ao recurso de log-in-context automático.

Esta opção não deve ser usada com encaminhamento no agente. Usar um encaminhador de logs externo para enviar log para New Relic enquanto o encaminhamento no agente estiver habilitado fará com que seu log seja enviado duas vezes para New Relic. Dependendo da sua conta, isso pode resultar em cobrança dupla.

Esta opção também não deve ser usada com o formatador manual de decoração log . Se você tiver referências ao formatador manual em sua base de código, remova-as antes de ativar esta opção.

Se você quiser usar esta opção, certifique-se de ter a opção de configuração de encaminhamento no agente desabilitada.
newrelic.js:
```
application_logging: {
  forwarding: {
    enabled: false
  }
}
```
Habilite a decoração de log em sua configuração e reinicie o agente para começar a decorar seu log.
newrelic.js:
```
application_logging: {
  local_decorating: {
    enabled: true
  }
}
```
Variável de ambiente:
```
NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true
```
Nosso decorador adiciona cinco atributos a cada mensagem do log: entity.guid, entity.name, hostname, trace.id e span.id. Exemplo:
```
This is my log message. NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|
```
Se a mensagem do log estiver vazia ou em branco, a mensagem de saída também estará vazia. Exemplo:
```
NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|.
```
A mensagem do log de saída será uma string vazia.
Alguns atributos podem ficar vazios se o log ocorreu fora de uma transação ou se não forem aplicáveis ao contexto do seu aplicativo.
Recomendamos esta opção manualmente usando um de nossos enriquecedores de log.

Antes que o agente de linguagem tivesse a capacidade de encaminhar e decorar o log, você poderia ativar o logs contextualizados atualizando seu aplicativo para usar um framework log enriquecedor específico . Esta opção ainda é suportada, mas não é mais incentivada. Para obter instruções sobre como usar essa abordagem, consulte logs contextualizados manual na opção.

Além disso, este método requer que você instale um direcionador de logs antes de ativar o logs contextualizados. Se você não tiver um direcionador de logs, a interface do New Relic prompt que você use nosso agente de infraestrutura.

Se você decidir usar sua solução de encaminhamento de logs existente e posteriormente decidir atualizar seu agente para usar o logs contextualizados automático, certifique-se de disable your manual log forwarder. Caso contrário, seu aplicativo enviará linhas de log duplas. Dependendo da sua conta, isso pode resultar em cobrança dupla. Para obter mais informações, siga os procedimentos para desabilitar seu direcionador de logs específico.

Este documento ajudou você na instalação?

Proteja seus dados

Seu registro pode incluir informações confidenciais protegidas pela HIPAA ou outros protocolos de conformidade. Por padrão, ofuscamos padrões numéricos que parecem ser de itens como cartões de crédito ou números de Seguro Social, mas pode ser necessário aplicar hash ou mascarar informações adicionais.

Para mais informações, veja nossa documentação sobre expressão de ofuscação e regras. Você pode aplicar hash ou mascarar seus dados log usando a interface New Relic ou NerdGraph, nossa API GraphQL.

Explore seus dados

Para aproveitar ao máximo seus dados de registro:

Na página Summary doAPM , clique no gráfico Web transaction time para visualizar o registro associado a um momento específico.
Verifique Errors inbox do seu aplicativo para visualizar o registro associado aos seus erros.
Use distributed tracing para ver o log associado ao rastreamento individual.
Explore mais dados de registro em sua plataforma com nossa interface de registro.
Configure alertas com base na saída e na gravidade do log.
consulte seus dados usando nossa interface especializada para dados de log e crie um painel com os resultados.

Dicas de resolução de problemas

Normalmente, seu registro começará a aparecer menos de um minuto após você ativar o logs contextualizados. Verifique a seção Triage > Logs do seu aplicativo. Você também começará a ver Padrões de log relacionados ao erro ali.

Se você não vir nenhum log de erros ou rastreamento, talvez não haja nenhum para seu aplicativo. Tente atualizar a página da interface ou altere o período selecionado.

Desabilitar o registro automático

O logs contextualizados APM encaminha automaticamente os dados log do APM do agente. Ele está habilitado por padrão. Se você ativar o log do aplicativo, isso poderá ter um impacto negativo na segurança, na conformidade, no faturamento ou no desempenho do sistema. Para obter mais informações ou se precisar ajustar a configuração padrão, siga os procedimentos para desativar o registro automático.

Opção de logs contextualizados manual

Para ativar o logs contextualizados para aplicativos monitorados por Node.js, você pode usar nossa opção de instalação manual.

Certifique-se de já ter configurado o login no New Relic. Isso inclui a configuração de um encaminhador de logs compatível que coleta seu log do aplicativo e estende os metadados que são encaminhados para New Relic.
Instale ou atualize para a versão mais recente do agente Node.js e ative distributed tracing. Use o agente Node.js versão 6.2.0 ou superior para logs contextualizados.
Instale uma framework compatível para enriquecer seus dados log ou use diretamente a API de encaminhamento de logs do agente.
Na configuração do seu agente, defina application_config.enabled como false. (Caso contrário, o agente irá automaticamente instrumentar o seu agente e chamar você mesmo esses enriquecedores não fará nada.)
Configure o logs contextualizados para Node.js usando a extensão log apropriada.
Para instalar o enriquecedor de log Winston, insira o seguinte comando em seu terminal ou interface de linha de comando:
bash
$npm install @newrelic/winston-enricher
No código do aplicativo, atualize a configuração de geração de registros para adicionar newrelicFormatter:
// index.js require('newrelic') const winston = require('winston') const newrelicFormatter = require('@newrelic/winston-enricher')(winston)
O Formatador do New Relic pode ser usado individualmente ou combinado com outros formatadores como formato final.
format: winston.format.combine( winston.format.label({label: 'test'}), newrelicFormatter() )
Para instalar o enriquecedor de log Pino, digite o seguinte comando em seu terminal ou interface de linha de comando:
bash
$npm install @newrelic/pino-enricher
No código do seu aplicativo, atualize sua configuração de log para adicionar o plug-in New Relic Pino:
// index.js require('newrelic') const nrPino = require('@newrelic/pino-enricher') const pino = require('pino') const logger = pino(nrPino())
O Formatador do New Relic pode ser usado individualmente ou combinado com outros formatadores como formato final.
Para verificar se você configurou o anexador log corretamente, execute seu aplicativo e verifique seus dados de log no New Relic usando o operador de consulta has:span.id has:trace.id.

Se tudo estiver configurado corretamente e seus dados estiverem sendo encaminhados para New Relic com os metadados enriquecidos, seu log agora deverá ser emitido como JSON e conter os campos trace.id e span.id. Se você não vir os dados log na interface, siga os procedimentos de resolução de problemas. Se você quiser ver um exemplo funcional de logs contextualizados, dê uma olhada em nosso aplicativo de exemplo.

Qual é o próximo?

Depois de configurar o logs contextualizados, aproveite ao máximo seus dados de registro:

Explore os dados de registro em sua plataforma com nossa interface de registro.
Veja seu logs contextualizados do desempenho do seu aplicativo na interfaceAPM . Solucione erros com distributed tracing, rastreamento de pilha, registro de aplicativo e muito mais.
Obtenha visibilidade mais profunda do seu aplicativo e dos dados de desempenho da plataforma encaminhando seu log com nosso agente de infraestrutura. Revise seu log de infraestrutura na interface.
Configure o alerta.
consulte seus dados e crie dashboard.

Esta tradução de máquina é fornecida para sua comodidade.

Logs contextualizados do agente Node.js

Dica

Opções de logs contextualizadosn automático

Importante

Opção 1 (mais simples): Deixe o agente decorar e encaminhar seu log.

Opção 2: Deixe o agente decorar seu log.

Opção 3: Use o processo manual para encaminhar e decorar o log.

Este documento ajudou você na instalação?

Proteja seus dados

Explore seus dados

Dicas de resolução de problemas

Desabilitar o registro automático

Opção de logs contextualizados manual

Configuração do Node.js com Winston

Configuração do Node.js com Pino

Qual é o próximo?

Esta tradução de máquina é fornecida para sua comodidade.

Logs contextualizados do agente Node.js

Dica

Opções de logs contextualizadosn automático .css-21sua1{background:none;border:none;width:0;padding:0;}

Importante

Opção 2: Deixe o agente decorar seu log.

Opção 3: Use o processo manual para encaminhar e decorar o log.

Este documento ajudou você na instalação?

Proteja seus dados

Explore seus dados

Dicas de resolução de problemas

Desabilitar o registro automático

Opção de logs contextualizados manual

Configuração do Node.js com Winston

Configuração do Node.js com Pino

Qual é o próximo?

Opções de logs contextualizadosn automático