instrumentationtierce

Le moyen le plus simple de démarrer une transaction est d'appeler add_transaction_tracer sur la méthode. Ceci suppose que NewRelic::Agent::Instrumentation::ControllerInstrumentation est inclus dans votre classe.

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

  def transaction
    # execute a transaction
  end

  add_transaction_tracer :transaction
end

Parfois, vous avez besoin d'un peu plus de contrôle sur la transaction générée par New Relic. Lorsque cela se produit, vous pouvez utiliser perform_action_with_newrelic_trace. Certains des paramètres que vous pouvez remplacer incluent le nom et la catégorie de la transaction (qu'il s'agisse d'une transaction Web ou d'une transaction d'arrière-plan).

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

Consultez la documentation complète de perform_action_with_newrelic_trace pour plus d'informations sur les paramètres et l'utilisation.

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

L'exemple ci-dessus entraîne l'enregistrement de métriques pour le nom 'Custom/generate_image', ainsi qu'une entrée dans la trace de transaction qui inclut l'appel de méthode.

trace est le moyen le plus simple d'enregistrer le datastore pour une méthode.

class FauxDB

 def find
   # FauxDB lookup
 end

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

end

Le premier paramètre est la classe à instrument, le deuxième la méthode à trouver, le troisième le nom du produit datastore . Un nom d’opération facultatif peut être inclus comme paramètre final, sinon le nom de la méthode est utilisé pour représenter l’opération dans les métriques.

Notez que les métriques de la banque de données enregistrées avec cette interface ne permettent pas d'ajouter un nom de collection/table. Pour cela, voir la méthode wrap ci-dessous.

wrap permet d'enregistrer des métriques de banque de données avec des informations supplémentaires sur la collection/la table dans les noms des métriques. Il fournit également un rappel pour des opérations telles que la détection d'instructions lentes.

class FauxDB

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

end

Si vous souhaitez enregistrer des informations supplémentaires sur votre appel datastore , vous pouvez utiliser le paramètre facultatif rappel sur 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

Cette méthode d'assistance enregistre les requêtes SQL lentes pour la présentation dans la trace de transaction et les pages SQL lentes. SQL est filtré et obscurci en fonction des paramètres de l'utilisateur.

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

Les requêtes non SQL ne doivent jamais être envoyées via notice_sql. Utilisez plutôt notice_statement .

Cette méthode d'assistance enregistre les instructions pour les appels de datastore lents afin de tracer la transaction. Ceux-ci ne sont pas obscurcis.

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

La requête SQL ne doit jamais être envoyée via notice_statement. Utilisez plutôt notice_sql .

Les méthodes de test documentées dans cette section sont accessibles en appelant ceci à partir de votre code de test (le plus souvent un fichier test_helper.rb )

NewRelic::Agent.require_test_helper

Cette méthode est le principal moyen de garantir que vos métriques attendues sont enregistrées par l'agent Ruby. refute_metrics_recorded est également disponible.

Dans la forme la plus simple, assert_metrics_recorded peut être appelé ainsi :

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

Les métriques avec des valeurs spécifiques peuvent être affirmées via cette syntaxe :

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

Ces méthodes simulent l'exécution d'une transaction Web ou en arrière-plan.

in_web_transaction do
  # Perform work to test behavior in transaction
end

La configuration de l'agent peut être modifiée pour les tests via with_config. Il faut un hacher qui est appliqué aux autres valeurs configuration dans l'agent.

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

Si vous devez tester votre extension sur plusieurs versions de gems, vous pouvez utiliser Multiverse, une partie du code de test de l'agent Ruby. Pour des exemples de tests Multiverse, consultez le répertoire suites dans les fichiers de l'agent.

Pour configurer Multiverse pour votre propre gem :

1. Require tasks/multiverse in RakefilePour activer la commande rake test:multiverse , ajoutez ce qui suit à votre Rakefile :

   require "tasks/multiverse"

   Copier

2. Create the Multiverse test directoryLes tests multivers nécessitent une disposition de fichier spécifique. Créez un répertoire nommé test/multiverse/YOUR_PROJECT avec les emplacements de fichiers suivants :

   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

   Copier

3. Configure your Envfile. Utilisez Envfile pour déclarer des ensembles de dépendances de gems pour vos tests Multiverse. Par exemple, votre Envfile pourrait ressembler à ceci :

   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

   Copier

   Conseil

   Incluez les lignes gem pour newrelic_rpm et rack pour garantir que vos tests Multiverse fonctionnent.

4. Detect dependencies. Si nécessaire, assurez-vous que l'instrumentation de votre extension est chargée en exécutant une détection de dépendance supplémentaire à partir de vos tests Multiverse :

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

   Copier

   Pour exécuter vos tests Multiverse sur la dépendance de gem dans votre Envfile:

• Après avoir configuré Multiverse pour votre gem, exécutez rake test:multiverse pour exécuter les tests dans votre répertoire.