New Relic の Ruby エージェントには、Rake のタスクをインストルメントするためのオプトインサポートがあります。これには
- Rakeバージョン10.0.0以上
- Rubyエージェントバージョン3.13.0以上
Rakeタスクをインストルメント化するには、 newrelic.ymlファイルでタスクを名前で指定します。
Rakeのサポートを有効にする
アプリのRakeタスクをインストルメント化するには、ターゲットタスクの名前をnewrelic.ymlファイルのrake.tasks要素に追加します。 Rubyエージェントは、文字列正規表現を使用して、これらの名前をアクティブなタスクと照合します。
Example: Instrumenting two Rake tasks
たとえば、Rakeタスクdeployとdeploy:allをインストルメント化するには、 newrelic.ymlファイルに以下を追加します。
rake: tasks: ["deploy", "deploy:all"]タスク名のマッチングは正規表現で行われるため、[".+"]のようなワイルドカード正規表現を使用することで、アプリのすべてのRakeタスクを計装できます。ただし、これには、autostart.denylisted_rake_tasks設定によってデフォルトで拒否リストに含まれているRakeタスク(db:migrateなど)は含まれません。
- デフォルトの拒否リストにあるRakeタスクを計装するには、
autostart.denylisted_rake_tasksを独自のリストに設定し、そのタスクを除外します。独自のリストがデフォルトのリストを置き換えます。 - Railsを使用しているが、RakeタスクがRails環境を必要としない場合に、タスクが実行される前にインストルメント化されるようにするには、Rakeタスクの先頭に
require 'tasks/newrelic'を追加します。
Rakeのジョブ引数の取得
デフォルトでは、Rake のジョブ引数はキャプチャされません。Rakeのジョブ引数をキャプチャするには、次のようにします。
attributes.include: job.rake.*