Logs en el contexto de agente Ruby

Con nuestro APMagente Ruby , puede obtener logs in context, que le permite ver el registro de su aplicación en el contexto de sus otros datos New Relic . Para obtener información general sobre esta característica, consulte logs en el contexto APM .

Opciones de logs en el contexto automático

Tienes tres opciones para configurar APMel logs en el contexto para enviar el registro de tu aplicación y vincular metadatos automáticamente a 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

Asegure sus datos

Su registro puede incluir información confidencial protegida por HIPAA u otros protocolos de cumplimiento. De forma predeterminada, ofuscamos los patrones numéricos que parecen corresponder a elementos como tarjetas de crédito o números de Seguro Social, pero es posible que deba aplicar hash o enmascarar información adicional.

Para más información, consulta nuestra documentación sobre expresión de ofuscación y reglas. Puede hash o enmascarar sus log datos utilizando la New Relic UI o utilizando NerdGraph, nuestra GraphQL.API

Explora tus datos

Para aprovechar al máximo sus datos de registro:

• En la páginaAPM Summary , haga clic en su gráfico Web transaction time para ver el registro asociado con un momento específico.
• Verifique Errors inbox de su aplicación para ver el registro asociado con sus errores.
• Utilice rastreo distribuido para ver el registro asociado a la traza individual.
• Explore más datos de registro en su plataforma con nuestra UI de logs.
• Configure alertas basadas en la salida log y la gravedad.
• consulte sus datos utilizando nuestra UI especializada para registrar datos y cree un panel con los resultados.

Consejos de resolución de problemas

Normalmente, su registro comenzará a aparecer menos de un minuto después de habilitar el inicio de APMlogs en el contexto. Consulta la sección Triage > Logs de tu aplicación. Allí también comenzará a ver patrones de registros relacionados con el error.

Si no ve ningún registro de errores o traza, es posible que no haya ninguno para su aplicación. Intente actualizar la página UI o cambie el período de tiempo seleccionado.

Deshabilitar el registro automático

El logs en el contexto APM reenvía automáticamente los datos log de APM del agente y está habilitado de forma predeterminada. Esto puede tener un impacto negativo en su seguridad, cumplimiento, facturación o rendimiento del sistema. Para obtener más información, o si necesita ajustar la configuración predeterminada, siga los procedimientos para desactivar el registro automático.

Opción de logs en el contexto manual

Si necesita utilizar el proceso manual para configurar el logs en el contexto para Ruby, siga estos pasos:

1. Asegúrate de haber configurado el inicio de sesión en New Relic. Esto incluye la configuración de un reenviador de registros compatible que recopile su registro de aplicación y extienda los metadatos que se reenvían a New Relic.

2. Instale o actualice a la última versión Ruby agente y habilite rastreo distribuido. Utilice Ruby agente versión 6.7.0 o superior para logs en el contexto.

3. Para la aplicación Rails, utilice una versión de Rails compatible.

4. Configurar logs en el contexto para Ruby.

   Configuración estándar Ruby on Rails

   El registro de Rails está controlado por dos componentes:

   • Un logger que puedes personalizar configurando config.logger

   • Un formateador log que puede personalizar configurando config.log_formatter)

     En la mayoría de los casos, debe configurar el logs en el contexto estableciendo config.log_formatter en DecoratingFormatter en su aplicación Rails. Para obtener más información sobre la configuración de Rails, consulte la documentación de rubyonrails.org.

     En la configuración de su aplicación, solicite newrelic_rpm y luego agregue la siguiente línea:

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

     Copia

     Esta configuración utiliza el Formateador de New Relic para mensajes de registro, pero la configuración restante la proporcionan las otras configuraciones de Rails.

   Gemas incompatibles

   Se sabe que New Relic de decoración de es incompatible con las siguientes gemas:logger

   • Inicio sesión
   • logger semántico
   • rails_stdout_logger
   • rails_12factor

   Configuración avanzada de Rails

   Si configurar la log_formatter opción no satisface sus necesidades, reemplace todo el Rails logger con una instancia del New Relic logger. Proporcione el parámetro al constructor del logger, así:

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

   Copia

   Configuración Ruby sin Rails

   Para aplicaciones que no sean Rails, use DecoratingLogger en lugar del estándar Ruby ::Logger, así:

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

   Copia

   El DecoratingLogger es un reemplazo directo del estándar Ruby ::Logger. Sus constructores aceptan el mismo parámetro.

   Configuración de registro

   Para configurar esta extensión con la gema lograge, siga los procedimientos estándar en este documento para la configuración de Ruby on Rails. No se requiere configuración adicional para la gema lograge.

   Otras extensiones de registro

   Para utilizar nuestra extensión de registro con una implementación de registro diferente o con su propio logger personalizado, utilice DecoratingFormatter. Por ejemplo:

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

   Copia

5. Para verificar que haya configurado log correctamente el agregador , ejecute su aplicación y luego verifique sus log datos en la New Relic UI usando el operador de consulta has:span.id has:trace.id.

Si todo está configurado correctamente y sus datos se reenvían a New Relic con los metadatos enriquecidos, su registro ahora debería emitirse como JSON y contener los campos trace.id y span.id.

Si ha configurado su inicio de sesión en /config/application.rb o en /config/environments/development.rb, ejecute su aplicación localmente y verifique su resultado de registro. Deberías ver un resultado como este:

{"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"}