サードパーティ製計測器

トランザクションを開始する最も簡単な方法は、メソッドでadd_transaction_tracerを呼び出すことです。これは、 NewRelic::Agent::Instrumentation::ControllerInstrumentationがクラスに含まれていることを前提としています。

class CustomBackgroundJob
  include NewRelic::Agent::Instrumentation::ControllerInstrumentation

  def transaction
    # execute a transaction
  end

  add_transaction_tracer :transaction
end

場合によっては、New Relic が生成するトランザクションをもう少し制御する必要があります。その場合は、 perform_action_with_newrelic_traceを使用できます。オーバーライドできるパラメーターには、トランザクション名とカテゴリ (Web トランザクションかバックグラウンド トランザクションか) が含まれます。

class CustomBackgroundJob
  include NewRelic::Agent::Instrumentation::ControllerInstrumentation

  def transaction
   perform_action_with_newrelic_trace(:name    => "custom_name",
                                     :category => :task) do
     # your work here...
   end
  end

end

パラメータと使用法の詳細については 、perform_action_with_newrelic_trace の完全なドキュメントを 参照してください。

require 'new_relic/agent/method_tracer'
class Foo
  include ::NewRelic::Agent::MethodTracer

  def generate_image
    # ...
  end

  add_method_tracer :generate_image, 'Custom/generate_image'
end

上記の例では、名前'Custom/generate_image'のメトリクスが記録され、メソッド呼び出しを含むトランザクション トレースのエントリが記録されます。

trace メソッドのデータストアを記録する最も簡単な方法です。

class FauxDB

 def find
   # FauxDB lookup
 end

 NewRelic::Agent::Datastores.trace self, :find, "FauxDB"

end

最初のパラメータはインストゥルメントするクラス、2番目は検索するメソッド、3番目はデータストアの製品名です。最後のパラメータには、オプションで操作名を指定することができますが、そうでない場合は、メトリクスで操作を表現するためにメソッド名が使用されます。

このインターフェースで記録されたデータストア メトリックでは、コレクション/テーブル名を追加できないことに注意してください。そのためには、以下のwrapメソッドを参照してください。

wrap メトリック名に追加のコレクション/テーブル情報を使用してデータストア メトリックを記録できます。また、遅いステートメントに気付くなどの操作のためのコールバックも提供します。

class FauxDB

  def find(table)
    NewRelic::Agent::Datastores.wrap("FauxDB", "find", table) do
    # FauxDB lookup
    end
  end

end

データストア呼び出しに関する追加情報を記録する場合は、 wrapでオプションのコールバック パラメータを使用できます。

class FauxDB

 def find(query)
   callback = Proc.new do |result, scoped_metric, elapsed|
     NewRelic::Agent::Datastores.notice_sql(query, scoped_metric, elapsed)
   end

   NewRelic::Agent::Datastores.wrap("FauxDB", "find", "items", callback) do
     # execute query
   end
 end

end

このヘルパー・メソッドは、トランザクション・トレースやスローSQLページで表示するために、遅いSQLクエリを記録します。SQLはユーザーの設定に基づいてフィルタリングされ、難読化されます。

NewRelic::Agent::Datastores.notice_sql(query, scoped_metric, elapsed)

非 SQL クエリはnotice_sqlを介して送信しないでください。代わりにnotice_statementを使用してください。

このヘルパーメソッドは、トランザクショントレースへの遅いデータストア呼び出しのステートメントを記録します。これらは難読化されていません。

NewRelic::Agent::Datastores.notice_statement(statement, elapsed)

notice_statementを介して SQL クエリを送信しないでください。代わりにnotice_sqlを使用してください。

このセクションに記載されているテスト メソッドには、テスト コード (通常はtest_helper.rbファイル) からこれを呼び出すことでアクセスできます。

NewRelic::Agent.require_test_helper

この方法は、予想されるメトリクスが Ruby エージェントによって確実に記録されるようにするための主要な方法です。refute_metrics_recordedも利用できます。

最も単純な形式では、 assert_metrics_recordedは次のように呼び出すことができます。

assert_metrics_recorded(["MetricA", "MetricB"])

特定の値を持つメトリクスは、この構文でアサートできます。

assert_metrics_recorded('MetricA' => {
                         :call_count => 1,
                         :total_call_time => 1.0 })

これらの方法は、ウェブやバックグラウンドでのトランザクションの実行をシミュレートするものです。

in_web_transaction do
  # Perform work to test behavior in transaction
end

エージェントの構成は、 with_configを介してテスト用に変更できます。エージェントの他の構成値に適用されるハッシュを取得します。

with_config(:enabled => false) do
  # Check what happens when agent's disabled
end

複数のgemバージョンに対して拡張機能をテストする必要がある場合は、Rubyエージェント自身のテストコードの一部であるMultiverseを使うことができます。Multiverse のテスト例は、エージェントファイルの suites ディレクトリを参照してください 。

自分のgemにMultiverseを設定するには

1. Rakefile でtasks/multiverseが必要です。rake test:multiverseコマンドを有効にするには、Rakefile に次を追加します。

   require "tasks/multiverse"

   コピー

2. Multiverse テスト ディレクトリを作成します。マルチバース テストには、特定のファイル レイアウトが必要です。次のファイルの場所にtest/multiverse/YOUR_PROJECTという名前のディレクトリを作成します:

   test/multiverse/YOUR_PROJECT
   test/multiverse/YOUR_PROJECT/Envfile
   test/multiverse/YOUR_PROJECT/config/newrelic.yml
   test/multiverse/YOUR_PROJECT/FILE_WITH_A_TEST.rb

   コピー

3. Envfileの設定. Envfile を使って、Multiverseのテストで使用するgemの依存関係のセットを宣言します。例えば、 Envfile は以下のようになります。

   gemfile <-RB
     gem 'your-project', '~> 1.0.0'
     gem 'rack'
     gem 'newrelic_rpm'
     gem 'newrelic_your-project', path: '../../..'
   RB
   
   gemfile <-RB
     gem 'your-project', '~> 2.1.0'
     gem 'rack'
     gem 'newrelic_rpm'
     gem 'newrelic_your-project', path: '../../..'
   RB

   コピー

   ヒント

   マルチバース テストが確実に機能するように、 newrelic_rpmとrackのgem行を含めます。

4. 依存関係の検出.必要に応じて、Multiverseテストから追加の依存性検出を実行して、拡張機能のインスツルメンテーションがロードされていることを確認してください。

   require 'newrelic/your-project'
   
   DependencyDetection.detect!
   
   class YourProjectTest > Minitest::Test
   end

   コピー

   Envfile にあるgemの依存関係に対してMultiverseのテストを実行するためです。

• Gem の Multiverse を設定したら、 rake test:multiverseを実行してディレクトリでテストを実行します。