コンテキスト内の Ruby エージェント ログ

Ruby APMエージェントを使用すると、 logs in contextを取得できます。これにより、他の New Relic データのコンテキストでアプリのログを表示できます。 この機能の一般的な情報については、 「コンテキスト内の APM ログ」を参照してください。

コンテキストオプションの自動ログ

アプリのログとリンク メタデータを自動的に New Relic に送信するようにコンテキスト内のAPMログを構成するには、3 つのオプションがあります。

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

データを保護する

ログには、HIPAAまたはその他のコンプライアンスプロトコルによって保護されている機密情報が含まれている場合があります。デフォルトでは、クレジットカードや社会保障番号などのアイテムのように見える番号パターンを難読化しますが、追加情報をハッシュまたはマスクする必要がある場合があります。

詳細については、難読化の式とルールに関するドキュメントを参照してください。 New Relic UIを使用するか、GraphQL APIであるNerdGraphを使用して、ログデータをハッシュまたはマスクできます。

データを調べる

ログデータを最大限に活用するには：

• APM

  Summary

  ページで、

  Web transaction time

  チャートをクリックして、特定の時点に関連付けられたログを表示します。

• アプリの

  Errors inbox

  をチェックして、エラーに関連するログを表示します。

• 分散トレースを使用して、個々のトレースに関連付けられているログを確認します。

• ログ UIを使用して、プラットフォーム全体でさらに多くのログ データを探索します。

• ログ出力と重大度に基づいてアラートを設定します。

• ログデータ専用のUIを使用してデータをクエリし、結果を含むダッシュボードを作成します。

トラブルシューティングのヒント

通常、コンテキストでAPMログを有効にしてから 1 分以内にログが表示され始めます。 アプリのTriage > Logsセクションを確認してください。 また、そこにエラーに関連するログパターンも表示され始めます。

エラーまたはトレースのログが表示されない場合は、アプリにログがない可能性があります。 UIページを更新するか、選択した期間を変更してみてください。

自動ロギングを無効にする

APMログインコンテキストは、APMエージェントログデータを自動的に転送し、デフォルトで有効になっています。これは、セキュリティ、コンプライアンス、請求、またはシステムパフォーマンスに悪影響を与える可能性があります。詳細について、またはデフォルト設定を調整する必要がある場合は、手順に従って自動ロギングを無効にしてください。

コンテキストオプションの手動ログ

手動プロセスを使用してRubyのコンテキストでログを設定する必要がある場合は、次の手順に従います。

1. NewRelicでのロギングをすでに設定していることを確認してください。これには、アプリケーションログを収集し、NewRelicに転送されるメタデータを拡張するサポートされているログフォワーダーの構成が含まれます。

2. をインストールするか、 を最新の Ruby エージェントバージョンに更新し、 分散型トレーシングを有効にする 。 Rubyエージェントのバージョン6.7.0以降を使用 コンテキストのログを取得します。

3. Railsアプリケーションの場合は、 サポートされているRailsのバージョン を使用してください。

4. Rubyのコンテキストでログを設定する。

   Ruby on Railsの標準的な構成

   Railsのロギングは2つのコンポーネントによって制御されています。

   • 設定してカスタマイズできるロガー config.logger

   • config.log_formatterを設定してカスタマイズできるログフォーマッタ

     ほとんどの場合、Railsアプリケーションでconfig.log_formatterをDecoratingFormatterに設定して、コンテキストでログを構成する必要があります。 Rails構成の詳細については、 rubyonrails.orgのドキュメントを参照してください。

     アプリケーションの構成で、 newrelic_rpmを要求してから、次の行を追加します。

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

     コピー

     この設定では、ログメッセージにNew Relicのフォーマッターを使用しますが、残りの設定は他のRailsの設定によって行われます。

   互換性のない宝石

   New Relicのデコレーションロガーは、以下のgemとの互換性がないことが知られています。

   • 伐採
   • セマンティックロガー
   • rails_stdout_logger
   • レール_12ファクタ

   Railsの高度な設定

   log_formatterオプションを設定してもニーズが満たされない場合は、Railsロガー全体をNewRelicロガーのインスタンスに置き換えてください。次のように、ロガーのコンストラクターにパラメーターを指定します。

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

   コピー

   Railsを使わないRubyの構成

   Rails以外のアプリケーションの場合は、次のように、Ruby標準::Loggerの代わりにDecoratingLoggerを使用します。

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

   コピー

   DecoratingLoggerは、Ruby標準::Loggerのドロップイン置換です。それらのコンストラクターは同じパラメーターを受け入れます。

   ログラージの設定

   この拡張機能を lograge gem で設定するには、このドキュメントの Ruby on Rails configuration の標準的な手順に従ってください。lograge gemのための追加の設定は必要ありません。

   その他のロギング拡張機能

   別のロギング実装または独自のカスタムロガーでロギング拡張機能を使用するには、 DecoratingFormatterを使用します。例えば：

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

   コピー

5. ログアペンダーが正しく構成されていることを確認するには、アプリケーションを実行してから、クエリ演算子has:span.id has:trace.idを使用してNewRelicUIでログデータを確認します。

すべてが正しく構成され、データが強化されたメタデータとともにNew Relicに転送されている場合、ログはJSONとして出力され、 trace.id }フィールドとspan.idフィールドが含まれているはずです。

/config/application.rbまたは/config/environments/development.rbでロギングを構成した場合は、アプリケーションをローカルで実行し、ロギング出力を確認してください。次のような出力が表示されます。

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