Logs contextualizados do agente PHP

Se você estiver usando um framework suportado, você pode configurar o agente APM para enviar o log da sua app e vincular metadados automaticamente ao New Relic. A estrutura suportada para logs contextualizados automático inclui:

• Monólogo (versão 2 ou 3)

  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 adiciona span.id, trace.id, hostname, entity.guid e entity.name. Saiba mais sobre as limitações de encaminhamento de logs.

  Importante

  A partir da versão 10.3.0 do agente a métrica de registro e o recurso de encaminhamento de logs do agente estão habilitados por padrão.

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

  Arquivo de configuração (newrelic.ini):

  newrelic.application_logging.enabled = true
  newrelic.application_logging.metrics.enabled = true
  newrelic.application_logging.forwarding.enabled = true

  Copiar

  Os documentos de configuração do agente PHP explicam detalhadamente como configurar seu agente, mas aqui revisaremos e vincularemos alguns dos aspectos mais importantes da configuração de log do PHP.

  Há uma única opção para controlar se o recurso principal de registro em log está ativo:

• newrelic.application_logging.enabled

  Se você estiver usando uma framework de log suportada, o agente poderá enviar métricas que medem o número de gravidade da mensagem do log que seu aplicativo está gerando. Você pode ativar este recurso usando a configuração newrelic.application_logging.metrics.enabled .

  Se você estiver usando uma framework de log compatível e quiser usar o agente para enviar seu log do aplicativo para o New Relic, poderá controlar isso por meio de configurações newrelic.application_logging.forwarding configurações INI prefixadas. As opções disponíveis são:

• enabled

• max_samples_stored

• log_level

  Se você estiver usando a biblioteca de registro Monolog (versão 2 ou 3), você também poderá ativar o atributo de contexto log . Isso converte os dados de contexto de registro passados para o Monolog em atributo New Relic . Você pode controlar esse recurso por meio de configurações newrelic.application_logging.forwarding.context_data configurações INI prefixadas. As opções disponíveis são:

• enabled

• include

• exclude

  Importante

  Se você tiver uma solução de encaminhamento de logs existente e estiver atualizando seu agente para usar o logs contextualizados automático, certifique-se de disable your manual log forwarder. Caso contrário, seu aplicativo enviará o dobro dos dados de log. Dependendo da sua conta, isso pode resultar em cobrança dupla. Para obter mais informações, saiba como 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.

Este método requer que você instale um direcionador de logs externo 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.

Se você optar por usar a decoração log para ativar o clogs contextualizados para PHP, primeiro configure seu aplicativo PHP.

1. 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 os encaminha para o New Relic.

2. Instale ou atualize para a versão mais recente do agente PHP e ative distributed tracing. Use o agente PHP versão 10.13.0.1 ou superior para suporte à decoração de log.

3. Instale o Monolog versão 2 ou 3.

4. Configure a decoração de log para PHP usando a extensão Monolog.

   Para ativar a decoração de log local:

   1. Desative o encaminhamento automático de logs:

      newrelic.application_logging.forwarding.enabled = false

      Copiar

   2. Habilite a decoração de log local pelo agente PHP:

      newrelic.application_logging.local_decorating.enabled = true

      Copiar

   3. O agente PHP agora adicionará metadados de link a cada registro de log do Monolog. Para que esta informação apareça na própria mensagem do log é necessário configurar um Monolog Formatter para cada Monolog Handler que inclua a especificação de formato %extra.NR-LINKING% no final da mensagem. Estes são os dados de vinculação necessários para que o logs contextualizados funcione.

      Por exemplo:

      <?php
      use Monolog\Logger;
      use Monolog\Formatter\LineFormatter;
      use Monolog\Handler\StreamHandler;
      
      $logger = new Logger('log');
      $handler = new StreamHandler('php://stderr');
      $logfmt = "%channel%.%level_name%: %message% %extra.NR-LINKING%\n";
      $formatter = new LineFormatter($logfmt);
      $handler->setFormatter($formatter);
      $logger->pushHandler($handler);

      Copiar

      Nosso decorador adiciona cinco atributos a cada log message (texto simples): 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}|

      Copiar

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

   Copiar

   A mensagem do log de saída será uma string vazia.

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