Module NewRelic::Agent::MethodTracer
In: lib/new_relic/agent/method_tracer.rb

This module contains class methods added to support installing custom metric tracers and executing for individual metrics.

Examples

When the agent initializes, it extends Module with these methods. However if you want to use the API in code that might get loaded before the agent is initialized you will need to require this file: 

    require 'new_relic/agent/method_tracer'
    class A
      include NewRelic::Agent::MethodTracer
      def process
        ...
      end
      add_method_tracer :process
    end

To instrument a class method: 

    require 'new_relic/agent/method_tracer'
    class An
      def self.process
        ...
      end
      class << self
        include NewRelic::Agent::MethodTracer
        add_method_tracer :process
      end
    end

@api public

Methods

extended   get_stats_scoped   get_stats_unscoped   included   trace_execution_scoped   trace_execution_unscoped   trace_method_execution_no_scope  

Classes and Modules

Module NewRelic::Agent::MethodTracer::ClassMethods

Public Class methods

Public Instance methods

get_stats_scoped(first_name, scoped_metric_only)

This method is deprecated and exists only for backwards-compatibility reasons. Usages should be replaced with calls to NewRelic::Agent.record_metric.

@api public @deprecated

get_stats_unscoped(name)

This method is deprecated and exists only for backwards-compatibility reasons. Usages should be replaced with calls to NewRelic::Agent.record_metric.

@api public @deprecated

trace_execution_scoped(metric_names, options={}) {|| ...}

Trace a given block with stats and keep track of the caller. See NewRelic::Agent::MethodTracer::ClassMethods#add_method_tracer for a description of the arguments. metric_names is either a single name or an array of metric names. If more than one metric is passed, the produce_metric option only applies to the first. The others are always recorded. Only the first metric is pushed onto the scope stack.

Generally you pass an array of metric names if you want to record the metric under additional categories, but generally this *should never ever be done*. Most of the time you can aggregate on the server.

@api public

trace_execution_unscoped(metric_names, options={}) {|unless NewRelic::Agent.tl_is_execution_traced?| ...}

Trace a given block with stats assigned to the given metric_name. It does not provide scoped measurements, meaning whatever is being traced will not ‘blame the Controller’—that is to say appear in the breakdown chart. This is code is inlined in add_method_tracer.

  • metric_names is a single name or an array of names of metrics

@api public

trace_method_execution_no_scope(metric_names, options={})

Alias for trace_execution_unscoped

[Validate]