Logs en contexte des agents Ruby

Avec notre agent Ruby APM, vous pouvez obtenir logs in context, qui vous permet de voir le log de votre application dans le contexte de vos autres données New Relic. Pour des informations générales sur cette fonctionnalité, consultez Logs en contexte APM.

Options de logs en contexte automatiques

Vous avez trois options pour configurer APMlogs en contexte pour envoyer automatiquement le log de votre application et les métadonnées de liaison à 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

Sécurisez vos données

Votre log peut inclure des informations sensibles protégées par la loi HIPAA ou d’autres protocoles de conformité. Par défaut, nous masquons les modèles de numéros qui semblent correspondre à des éléments tels que des cartes de crédit ou des numéros de sécurité sociale, mais vous devrez peut-être hacher ou masquer des informations supplémentaires.

Pour plus d'informations, consultez notre documentation sur l'expression d'obfuscation et les règles. Vous pouvez hacher ou masquer vos données log en utilisant l'interface utilisateur de New Relic ou en utilisant NerdGraph, notre API GraphQL .

Explorez vos données

Pour tirer le meilleur parti de vos données de logging :

• Sur la page APM Summary , cliquez sur votre graphique Web transaction time pour afficher le log associé à un moment précis.
• Vérifiez Errors inbox de votre application pour afficher le log associé à vos erreurs.
• Utilisez le tracing distribué pour voir le log associé à une trace individuelle.
• Explorez davantage de données de logging sur votre plateforme avec notre interface utilisateur de logs.
• Configurez des alertes en fonction de la sortie log et de la gravité.
• Interrogez vos données à l'aide de notre interface utilisateur spécialisée pour les données de log et créez des dashboards avec les résultats.

Conseils de dépannage

En règle générale, votre log commencera à apparaître moins d'une minute après avoir activé APMlogs dans ce contexte. Vérifiez la section Triage > Logs de votre application. Vous commencerez également à voir log patterns liés à l’erreur.

Si vous ne voyez aucun log d'erreurs ou de trace, il se peut qu'il n'y en ait pas pour votre application. Essayez d'actualiser la page de l'interface utilisateur ou de modifier la période sélectionnée.

Désactiver le logging automatique

Les logs APM dans le contexte transmettent automatiquement les données log de l'agent APM et sont activés par défaut. Cela peut avoir un impact négatif sur votre sécurité, votre conformité, votre facturation ou les performances de votre système. Pour plus d'informations, ou si vous devez ajuster le paramètre par défaut, suivez les procédures pour désactiver le logging automatique.

Option logs en contexte manuels

Si vous devez utiliser le processus manuel pour configurer les logs en contexte pour Ruby, suivez ces étapes :

1. Assurez-vous d'avoir déjà configuré le logging dans New Relic. Cela inclut la configuration d'un redirecteur de logpris en charge qui collecte votre log d'application et étend les métadonnées qui sont transmises à New Relic.

2. Installez ou mettez à jour vers la dernière version de l'agent Ruby et activez le tracing distribué. Utilisez l'agent Ruby version 6.7.0 ou supérieure pour les logs en contexte.

3. Pour les applications Rails, utilisez une version Rails prise en charge.

4. Configurer les logs en contexte pour Ruby.

   standard de Ruby on Rails configuration

   Le logging Rails est contrôlé par deux composants :

   • Un enregistreur que vous pouvez personnaliser en définissant config.logger

   • Un formateur log que vous pouvez personnaliser en définissant config.log_formatter)

     Dans la plupart des cas, vous devez configurer les logs en contexte en définissant config.log_formatter sur DecoratingFormatter dans votre application Rails . Pour plus d'informations sur la configuration de Rails, consultez la documentation rubyonrails.org.

     Dans la configuration de votre application, require newrelic_rpm, puis ajoutez la ligne suivante :

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

     Copier

     Cette configuration utilise le New Relic Formatter pour les messages de log, mais la configuration restante est fournie par les autres paramètres Rails .

   Gems incompatibles

   L'enregistreur de décoration de New Relic est connu pour être incompatible avec les gems suivantes :

   • enregistrement
   • enregistreur sémantique
   • rails_stdout_logger
   • rails_12factor

   Rails avancée configuration

   Si la définition de l'option log_formatter ne répond pas à vos besoins, remplacez l'intégralité de l'enregistreur Rails par une instance de l'enregistreur New Relic. Fournissez les paramètres au constructeur de l'enregistreur, comme ceci :

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

   Copier

   Ruby configuration sans Rails

   Pour les applications non-Rails, utilisez le DecoratingLogger à la place du ::Logger standard Ruby, comme ceci :

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

   Copier

   Le DecoratingLogger est un remplacement direct du standard Ruby ::Logger. Leurs constructeurs acceptent les mêmes paramètres.

   Configuration de Lograge

   Pour configurer cette extension avec le gemme lograge, suivez les procédures standard de cette documentation pour la configuration de Ruby on Rails. Aucune configuration supplémentaire n'est requise pour la gemme lograge.

   Autres extensions de logging

   Pour utiliser notre extension de logging avec une implémentation de logging différente ou avec votre propre enregistreur personnalisé, utilisez DecoratingFormatter. Par exemple:

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

   Copier

5. Pour vérifier que vous avez correctement configuré l'appender log , exécutez votre application, puis vérifiez vos données log dans l'interface utilisateur de New Relic à l'aide de l'opérateur de requête has:span.id has:trace.id.

Si tout est configuré correctement et que vos données sont transmises à New Relic avec la métadonnées enrichie, votre log devrait maintenant être émistre en JSON et contenir les champs trace.id et span.id .

Si vous avez configuré votre logging dans /config/application.rb ou dans /config/environments/development.rb, exécutez votre application localement et vérifiez sa sortie de logging. Vous devriez voir un résultat comme celui-ci :

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