Logs contextualizados do agente Ruby

Com nosso APMagente Ruby , você pode obter o logs in context, 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.

Opções de logs contextualizadosn automático

Você tem três opções para configurar o APMlog in context para enviar o log do seu aplicativo e vincular metadados automaticamente ao New Relic.

application_logging:
  forwarding:
    enabled: true

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true

application_logging:
  forwarding:
    max_samples_stored: 10000

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED=10000

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 APMlogs 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 e é habilitado por padrão. Isso pode 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

Se você precisar usar o processo manual para configurar o logs contextualizados para Ruby, siga estas etapas:

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 estende os metadados que são encaminhados para New Relic.

2. Instale ou atualize para a versão mais recente do agente Ruby e ative distributed tracing. Use o agenteRuby versão 6.7.0 ou superior para logs contextualizados.

3. Para o aplicativo Rails, use uma versão compatível do Rails.

4. Configure logs contextualizados para Ruby.

   Configuração padrão Ruby on Rails

   O log do Rails é controlado por dois componentes:

   • Um agente que você pode personalizar configurando config.logger

   • Um formatador log que você pode personalizar configurando config.log_formatter)

     Na maioria dos casos, você deve configurar o logs contextualizados definindo config.log_formatter como DecoratingFormatter em seu aplicativo Rails. Para obter mais informações sobre a configuração do Rails, consulte a documentação do rubyonrails.org.

     Na configuração do seu aplicativo, require newrelic_rpm e adicione a seguinte linha:

     module ________
       class Application < Rails::Application
     
       ...
     
       config.log_formatter = ::NewRelic::Agent::Logging::DecoratingFormatter.new
       end
     end

     Copiar

     Esta configuração utiliza o Formatador do New Relic para mensagem do log, mas o restante da configuração é fornecido pelas demais configurações do Rails.

   Gemas incompatíveis

   O agente de decoração da New Relic é conhecido por ser incompatível com as seguintes gemas:

   • logging
   • logger semântico
   • rails_stdout_logger
   • rails_12factor

   Configuração avançada do Rails

   Se a configuração da opção log_formatter não atender às suas necessidades, substitua todo o agente Rails por uma instância do agente New Relic . Forneça o parâmetro ao construtor do agente, assim:

   module ________
     class Application < Rails::Application
   
       ...
   
       config.logger = ::NewRelic::Agent::Logging::DecoratingLogger.new(
       "log/application.log", #etc...
       )
     end
   end

   Copiar

   Configuração Ruby sem Rails

   Para aplicativos não Rails, use DecoratingLogger no lugar do padrão Ruby ::Logger, assim:

   logger = ::NewRelic::Agent::Logging::DecoratingLogger.new(
     'log/application.log', #etc...
   )
   ...
   
   logger.info(...)

   Copiar

   O DecoratingLogger é um substituto imediato para o padrão Ruby ::Logger. Seus construtores aceitam o mesmo parâmetro.

   Configuração de log

   Para configurar esta extensão com a gem lograge, siga os procedimentos padrão neste documento para configuração do Ruby on Rails. Nenhuma configuração adicional é necessária para a gema lograge.

   Outras extensões de registro

   Para usar nossa extensão de geração de registros com uma implementação de geração de registros diferente ou com seu próprio agente personalizado, use DecoratingFormatter. Por exemplo:

   module ________
     class Application < Rails::Application
   
       ...
   
       config.logger = ::YourCustomLoggerImplementation.new(
         $stdout,
         formatter: ::NewRelic::Agent::Logging::DecoratingFormatter.new
       )
     end
   end

   Copiar

5. Para verificar se você configurou o anexador log corretamente, execute seu aplicativo e verifique seus dados log na interface do 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ê configurou seu registro em /config/application.rb ou em /config/environments/development.rb, execute seu aplicativo localmente e verifique sua saída de registro. Você deverá ver alguma saída como esta:

{"entity.name":"your_app_name","entity.type":"SERVICE","hostname":"79bcbf8d","trace.id":"79bcbf8d","span.id":"00fc7d46","timestamp":1567701375543,"message":"example log message one","log.level":"DEBUG"}
{"entity.name":"your_app_name","entity.type":"SERVICE","hostname":"79bcbf8d","trace.id":"79bcbf8d","span.id":"6754870b","timestamp":1567702843604,"message":"example log message two","log.level":"DEBUG"}