Ruby:コンテキストでのログの設定

これは最も単純なアプローチであり、ログフォワーダーの設定にアクセスしたり関心を持ったりしていない開発者や、アプリのコンテキストでログやその他のリンクメタデータの機能を確認したいアカウントに最適です。多くのオーバーヘッド。

このオプションを使用すると、ログにspan.id 、 trace.id 、 hostname 、 entity.guid 、およびentity.nameが含まれます。これらの属性は、ログをスパン、トレース、およびその他のテレメトリに自動的にリンクし、トラブルシューティングを容易にします。

ログ転送機能を備えたエージェントバージョン（ Rubyエージェント8.6.0以降）をインストールし、構成を更新して転送を有効にするだけです。

newrelic.yml：

application_logging:
  forwarding:
    enabled: true

環境変数：

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_ENABLED=true

このオプションは、将来のエージェントバージョンでデフォルトでオンになる可能性があります。

オプションの調整：

これを有効にすると、1分ごとにNewRelicに送信されるログの最大数も制御できます。デフォルト値は10,000です。 60秒のウィンドウで10,000を超えるログが受信されると、ログのサンプリングが開始されます。

より多くのログを受信するには、より大きな数値に設定します。受け取るログの数を減らすには、数値を小さく設定します。 100,000までの整数が有効です。

newrelic.yml：

application_logging:
  forwarding:
    max_samples_stored: 10000

環境変数：

NEW_RELIC_APPLICATION_LOGGING_FORWARDING_MAX_SAMPLES_STORED: 10000

既存のログ転送ソリューションがあり、コンテキストで自動ログを使用するようにエージェントを更新している場合は、手動ログ転送を必ず無効にしてください。それ以外の場合、アプリは二重のログ行を送信します。アカウントによっては、これにより二重請求が発生する可能性があります。詳細については、手順に従って特定のログフォワーダーを無効にしてください。

あなたが好きなログフォワーダーをすでに持っていますか？私たちはあなたをカバーしています！言語エージェントは、自動ログインコンテキスト機能へのアクセスを提供するために必要なリンクメタデータでログを装飾できます。

このオプションは、エージェント内転送では使用しないでください。エージェント内転送が有効になっているときに外部ログフォワーダーを使用してログをNewRelicに送信すると、ログがNewRelicに2回送信されます。アカウントによっては、二重請求が発生する場合があります。

このオプションは、手動のログ装飾フォーマッタでも使用しないでください。コードベースに手動フォーマッターへの参照がある場合は、このオプションを有効にする前にそれらを削除してください。

1. このオプションを使用する場合は、エージェント内転送構成オプションが無効になっていることを確認してください。

   newrelic.yml：

   application_logging:
      forwarding:
        enabled: false

   コピー

2. 構成でログの装飾を有効にしてから、エージェントを再起動してログの装飾を開始します。

   newrelic.yml：

   application_logging:
     local_decorating:
       enabled: true

   コピー

   環境変数：

   NEW_RELIC_APPLICATION_LOGGING_LOCAL_DECORATING_ENABLED=true

   コピー

   デコレータは、すべてのログメッセージに5つの属性を追加します： entity.guid 、 entity.name 、 hostname 、 trace.id 、およびspan.id 。例：

   This is my log message. NR-LINKING|{entity.guid}|{hostname}|{trace.id}|{span.id}|{entity.name}|

   コピー

   ログがトランザクションの外部で発生した場合、またはアプリケーションのコンテキストに適用できない場合、一部の属性は空になる可能性があります。

   手動装飾フォーマッターNewRelic::Agent::Logging::DecoratingFormatterよりもこのオプションをお勧めします。

言語エージェントがログを転送および装飾できるようになる前は、アプリケーションを更新してNewRelic::Agent::Logging::DecoratingFormatterを使用してリンクメタデータを送信することにより、コンテキスト内でログを有効にすることができました。

このオプションは引き続きサポートされていますが、推奨されなくなりました。このアプローチを使用する手順については、コンテキストオプションの手動ログを参照してください。

また、この方法では、コンテキストでログを有効にする前に、ログフォワーダーをインストールする必要があります。ログフォワーダーがない場合は、NewRelicUIでインフラストラクチャエージェントを使用するように求められます。

既存のログ転送ソリューションを使用することにし、後でエージェントを更新してコンテキストで自動ログを使用することにした場合は、必ず手動ログ転送を無効にしてください。それ以外の場合、アプリは二重のログ行を送信します。アカウントによっては、これにより二重請求が発生する可能性があります。詳細については、手順に従って特定のログフォワーダーを無効にしてください。

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ファクタ

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

module ________
  class Application < Rails::Application

    ...

    config.logger = ::NewRelic::Agent::Logging::DecoratingLogger.new(
    "log/application.log", #etc...
    )
  end
end

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