Instrumentação de terceiros

A maneira mais simples de iniciar uma transação é chamar add_transaction_tracer no método. Isso pressupõe que NewRelic::Agent::Instrumentation::ControllerInstrumentation esteja incluído em sua classe.

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

  def transaction
    # execute a transaction
  end

  add_transaction_tracer :transaction
end

Às vezes você precisa de um pouco mais de controle sobre a transação gerada pelo New Relic. Quando isso acontecer, você poderá usar perform_action_with_newrelic_trace. Alguns dos parâmetros que você pode substituir incluem o nome e a categoria da transação (seja uma transação da web ou uma transação em 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 a documentação completa de perform_action_with_newrelic_trace para obter mais informações sobre parâmetros e 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

O exemplo acima resulta no registro da métrica para o nome 'Custom/generate_image', bem como uma entrada no trace da transação que inclui a chamada do método.

trace é a maneira mais simples de registrar o armazenamento de dados para um método.

class FauxDB

 def find
   # FauxDB lookup
 end

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

end

O primeiro parâmetro é a classe do instrumento, o segundo o método a ser encontrado, o terceiro o nome do produto do datastore. Um nome de operação opcional pode ser incluído como parâmetro final, caso contrário o nome do método é utilizado para representar a operação em métrica.

Observe que o armazenamento de dados métricos registrados com esta interface não permite adicionar um nome de coleção/tabela. Para isso, veja o método wrap abaixo.

wrap permite registrar armazenamento de dados métricos com informações adicionais de coleção/tabela nos nomes das métricas. Ele também fornece um retorno de chamada para operações como a observação de instruções lentas.

class FauxDB

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

end

Se quiser registrar informações adicionais sobre sua chamada de armazenamento de dados, você pode usar o parâmetro de retorno de chamada opcional em 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 apresentação no rastreamento da transação e páginas SQL lentas. O SQL é filtrado e ofuscado com base nas configurações do usuário.

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

Consultas não SQL nunca devem ser enviadas por meio de notice_sql. Em vez disso, use notice_statement .

Este método auxiliar registra instruções para chamadas lentas do armazenamento de dados para rastrear a transação. Estes não são ofuscados.

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

A consulta SQL nunca deve ser enviada por meio de notice_statement. Use notice_sql em vez disso.

Os métodos de teste documentados nesta seção podem ser acessados chamando-o do seu código de teste (geralmente um arquivo test_helper.rb )

NewRelic::Agent.require_test_helper

Este método é a principal forma de garantir que suas métricas esperadas sejam registradas pelo agente Ruby. refute_metrics_recorded também está disponível.

Na forma mais simples, assert_metrics_recorded pode ser chamado assim:

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

Métrica com valores específicos pode ser afirmada através desta sintaxe:

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

Esses métodos simulam a execução na web ou transações em segundo plano.

in_web_transaction do
  # Perform work to test behavior in transaction
end

A configuração do agente pode ser alterada para teste via with_config. É necessário aplicar um hash que é aplicado aos outros valores de configuração no agente.

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

Se precisar testar sua extensão em várias versões de gem, você pode usar o Multiverse, uma parte do código de teste do próprio agente Ruby. Para obter exemplos de testes do Multiverse, consulte o diretório suites nos arquivos do agente.

Para configurar o Multiverse para sua própria gem:

1. Require tasks/multiverse in Rakefile. Para ativar o comando rake test:multiverse , adicione o seguinte ao seu Rakefile:

   require "tasks/multiverse"

   Copiar

2. Create the Multiverse test directory. Os testes multiverso requerem um layout de arquivo específico. Crie um diretório chamado test/multiverse/YOUR_PROJECT com os seguintes locais de arquivo:

   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

   Copiar

3. Configure your Envfile. Use Envfile para declarar conjuntos de dependência de gemas para seus testes do Multiverse. Por exemplo, seu Envfile pode ter esta aparência:

   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

   Copiar

   Dica

   Inclua as gem linhas para newrelic_rpm e rack para garantir que seus testes do Multiverse funcionem.

4. Detect dependencies. Se necessário, certifique-se de que a instrumentação da sua extensão esteja carregada executando uma detecção de dependência adicional nos testes do Multiverse:

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

   Copiar

   Para executar seus testes do Multiverse na dependência da gema em seu Envfile:

• Após configurar o Multiverse para sua gem, execute rake test:multiverse para executar os testes em seu diretório.