Instrumentación de terceros

La forma más sencilla de iniciar una transacción es llamar add_transaction_tracer en el método. Esto supone que NewRelic::Agent::Instrumentation::ControllerInstrumentation está incluido en su clase.

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

  def transaction
    # execute a transaction
  end

  add_transaction_tracer :transaction
end

A veces necesitas un poco más de control sobre la transacción que genera New Relic. Cuando eso suceda, puedes usar perform_action_with_newrelic_trace. Algunos de los parámetros que puede anular incluyen el nombre y la categoría de la transacción (ya sea una transacción web o una transacción en segundo plano).

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

Consulte la documentación completa de perform_action_with_newrelic_trace para obtener más información sobre el parámetro y su uso.

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

El ejemplo anterior da como resultado que se registre métrica para el nombre 'Custom/generate_image', así como una entrada en la traza de la transacción que incluye la llamada al método.

trace es la forma más sencilla de registrar el almacenamiento de datos de un método.

class FauxDB

 def find
   # FauxDB lookup
 end

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

end

El primer parámetro es la clase del instrumento, el segundo el método de búsqueda y el tercero el nombre del producto de almacenamiento de datos. Se puede incluir un nombre de operación opcional como parámetro final; de lo contrario, se utiliza el nombre del método para representar la operación en métrica.

Tenga en cuenta que el almacenamiento de datos métricos registrado con esta interfaz no permite agregar un nombre de colección/tabla. Para ello, consulte el método wrap a continuación.

wrap permite registrar el almacenamiento de datos métricos con información adicional de colección/tabla en los nombres métricos. También proporciona una devolución de llamada para operaciones como detectar declaraciones lentas.

class FauxDB

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

end

Si desea registrar información adicional sobre su llamada de almacenamiento de datos, puede usar el parámetro de devolución de llamada opcional en 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

Este método auxiliar registra consultas SQL lentas para su presentación en la traza de la transacción y páginas SQL lentas. SQL se filtra y se ofusca según la configuración del usuario.

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

La consulta que no sea SQL nunca debe enviarse a través de notice_sql Utilice notice_statement en su lugar.

Este método auxiliar registra declaraciones para llamadas lentas de almacenamiento de datos a la traza de la transacción. Estos no están ofuscados.

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

La consulta SQL nunca debe enviarse a través de notice_statement. Utilice notice_sql en su lugar.

Se puede acceder a los métodos de prueba documentados en esta sección llamándolos desde su código de prueba (más comúnmente un archivo test_helper.rb ).

NewRelic::Agent.require_test_helper

Este método es la forma principal de garantizar que el agente Ruby registre las métricas esperadas. refute_metrics_recorded también está disponible.

En la forma más simple, assert_metrics_recorded se puede llamar así:

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

La métrica con valores específicos se puede afirmar mediante esta sintaxis:

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

Estos métodos simulan la ejecución en la web o en una transacción en segundo plano.

in_web_transaction do
  # Perform work to test behavior in transaction
end

La configuración del agente se puede cambiar para realizar pruebas a través de with_config. Se necesita un hash que se aplica a los demás valores de configuración en el agente.

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

Si necesita probar su extensión con múltiples versiones de gemas, puede usar Multiverse, una parte del código de prueba del propio agente Ruby. Para ver ejemplos de pruebas de Multiverse, consulte el directorio de suites en los archivos del agente.

Para configurar Multiverse para tu propia gema:

1. Require tasks/multiverse in Rakefile. Para habilitar el comando rake test:multiverse , agregue lo siguiente a su Rakefile:

   require "tasks/multiverse"

   Copia

2. Create the Multiverse test directory. Las pruebas de multiverso requieren un diseño de archivo específico. Cree un directorio llamado test/multiverse/YOUR_PROJECT con las siguientes ubicaciones de archivos:

   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

   Copia

3. Configure your Envfile. Utilice Envfile para declarar conjuntos de dependencia de gemas para sus pruebas de Multiverso. Por ejemplo, su Envfile podría verse así:

   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

   Copia

   Sugerencia

   Incluya las líneas gem para newrelic_rpm y rack para garantizar que sus pruebas de Multiverse funcionen.

4. Detect dependencies. Si es necesario, asegúrese de que la instrumentación de su extensión esté cargada ejecutando una detección de dependencia adicional desde sus pruebas de Multiverse:

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

   Copia

   Para ejecutar tus pruebas de Multiverse contra la dependencia de gemas en tu Envfile:

• Después de configurar Multiverse para su gema, ejecute rake test:multiverse para ejecutar las pruebas en su directorio.