Rubyのバックグラウンドプロセスの監視

当社のRubyエージェントは、いくつかの一般的なバックグラウンド・ジョブ・フレームワークを自動的に計測します。また、任意のバックグラウンドタスクをトレースするようにカスタマイズすることもできます。バックグラウンドジョブからのデータは、 トランザクション ページ APMでは、 非ウェブトランザクション として表示されます。

対応フレームワーク

最近のRubyエージェントでは、以下のバックグラウンド・ジョブ・フレームワークがデフォルトでサポートされています。

Resque instrumentation (Ruby agent 3.4.0)
Sidekiq instrumentation (Ruby agent 3.6.0)
Delayed::Job instrumentation (Ruby agent 2.10)

重要

JRuby ユーザーは、CPU メトリクスに問題があるかもしれません。

これらのフレームワークを使用している場合、バックグラウンドジョブの監視には通常、追加の設定は必要ありません。

カスタムバックグラウンドジョブの監視

カスタムバックグラウンドジョブをインスツルメンテーションして、APM Transactions page as Non-web transactions に表示することができます。 Non-web transactions を、サポートされていないフレームワークを使用しながら監視するには、カスタムインスツルメンテーションを追加する必要があります。

例として、バックグラウンドジョブはSalesOrganization#find_new_leadsというタスクを定期的に実行します。

ControllerInstrumentationモジュールを追加します。
メソッド定義の下にあるadd_transaction_tracerディレクティブを使用します
:category => :taskを追加して、このトレースが非Webトランザクションであることをエージェントに通知します。
```
require 'newrelic_rpm'

class SalesOrganization
  include
    ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
  def find_new_leads
    ...
    end
  add_transaction_tracer: find_new_leads,: category =>: task
end
```
文字列を:categoryに渡すことができますが、文字列がOtherTransaction/で始まる場合にのみ、値はAPMトランザクションページに表示されます。

カスタムバックグラウンドメソッドの監視

Ruby エージェント API を使用すると、特定のメソッドを指定して、 非ウェブ・トランザクション をトレースすることができます。これにより、実行速度の遅いジョブのトレースを収集し、キャプチャしたエラーをトランザクションに関連付けることができます。

クラスメソッドをインストルメント化するには、クラスsingletonを使用します。

例として、バックグラウンドジョブはSalesOrganization#find_new_leadsというタスクを定期的に実行します。

メソッド定義の下にControllerInstrumentationモジュールを追加します。
add_transaction_tracerディレクティブを使用する

:category => :taskを追加して、このトレースが非Webトランザクションであることをエージェントに通知します。

require 'newrelic_rpm'

class SalesOrganization
  def self.find_new_leads
    ...
  end
  class << self
      include
        ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
    add_transaction_tracer :find_new_leads, :category => :task
  end
end

詳しくは、 Ruby custom metrics をご覧ください。

短期間のプロセスを監視する

エージェントがバックエンドサーバーに接続する前に、プロセスが実行されていないことを確認してください。これを行うには、Ruby エージェントがデフォルトの非同期動作ではなく、同期的に New Relic に接続するようにします。

まず、Gemfileで、 newrelic_rpm gemインストールの最後にrequire: falseを追加します。

gem 'newrelic_rpm', require: false

次に、 manual_startを呼び出し、 :sync_startup => trueオプションを渡します。

require 'new_relic/agent'
NewRelic::Agent.manual_start(:sync_startup => true)

注：ほとんどの構成オプションは、手動開始に渡すことができます。

require 'new_relic/agent'を使用するにはエージェントのコードが必要であり、手動で起動するまでエージェントが実行されないようにします。

プロセスがエージェントのハーベストサイクルよりも短い場合は、キューに入れられたすべてのデータが確実に送信されるように、 ::NewRelic::Agent.shutdownを使用してエージェントを手動でシャットダウンする必要があります。

バックグラウンドプロセスのためのnewrelic.ymlの設定

newrelic.yml の設定は、バックグラウンドアプリケーションのコンテキストに依存します。

バックグラウンドアプリが既に Ruby エージェントを実行している Rails 以外のアプリケーションである場合は、 newrelic.yml ファイルを、バックグラウンドジョブを起動するディレクトリまたは config サブディレクトリにコピーします。含まれていることを確認してください .

Railsコンテキストで実行されないバックグラウンドジョブは、 NEW_RELIC_ENV環境変数を調べて、構成ファイルのどのセクションを読み取るかを決定し、 RUBY_ENV 、 RAILS_ENV 、およびRACK_ENV環境変数に順番にフォールバックします。これらの環境変数が設定されていない場合、最後にデフォルトでdevelopmentになります。

New Relicですでに監視されている既存のWebアプリケーションのコンテキストでバックグラウンドジョブが実行される場合、Rubyエージェントは既存のnewrelic.ymlファイルを自動的に取得します。アプリケーションのRails環境を起動するバックグラウンドジョブは、読み取りするnewrelic.ymlファイルのセクションを決定するためにRAILS_ENV環境変数を使用します。

別のアプリケーション名で報告する

既存の New Relic Web アプリケーションのコンテキストで実行されるジョブを、APM UI において異なるアプリケーション名で表示させることができます。

newrelic_rpmがワーカーコードで要求される前に開始します。
バックグラウンドワーカープロセスの開始時に、バックグラウンドジョブに使用するアプリケーション名を NEW_RELIC_APP_NAME 環境変数に設定します。これにより、 newrelic.ymlの app_name 設定がオーバーライドされます。
bash
```
$NEW_RELIC_APP_NAME="My Background Jobs"
$./bin/my_background_worker.rb
```

エージェントの起動を確認する

Rubyエージェントは、ブラックリストに登録された実行可能ファイル名、rakeタスク名、または定数を検出しない限り、ほとんどの場合、 require 'newrelic_rpm'になるとすぐに自動的に起動します。これにより、一般的なレーキタスクやインタラクティブなコンソールセッション中に起動するのを防ぎます。

デーモンgemを使用してバックグラウンドタスクを開始すると、Rubyエージェントの開始に失敗し、ログを出力しない場合があります。これは、デーモンgemがバックグラウンドコードを実行する前に作業ディレクトリを/に変更するために発生します。次に、エージェントは、ホストプロセスの現在の作業ディレクトリに関連する構成ファイルとログファイルへのパスを解決しようとします。

このような状況でもエージェントを起動できるようにするには、環境変数にエージェントの設定ファイルとログファイルの場所を設定します。

ENV['NRCONFIG'] ||= File.dirname(__FILE__) +
  '/../../config/newrelic.yml'
ENV['NEW_RELIC_LOG'] ||= File.dirname(__FILE__) +
  '/../../log/newrelic_agent.log'

詳しくは、 controlling agent startupに関するドキュメントをご覧ください。

モニタースクリプト

エージェントの起動手順は、デーモンでバックグラウンドジョブを実行するときに適用されます。スクリプトが単一のバックグラウンドタスクを実行して終了する場合は、スクリプトの終了時に::NewRelic::Agent.shutdownを使用してエージェントを手動でシャットダウンします。これにより、NewRelicコレクターがデータを確実に受信します。例えば：

require 'newrelic_rpm'

class SalesOrganization
  include
    ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
  def find_new_leads
    ...
  end
  add_transaction_tracer :find_new_leads, :category => :task
end

SalesOrganization.new.find_new_leads
::NewRelic::Agent.shutdown

この機械翻訳は参考用に提供されます。