Module: NewRelic::Agent::Instrumentation::ControllerInstrumentation::ClassMethods

Included in:
NewRelic::Agent::Instrumentation::ControllerInstrumentation
Defined in:
lib/new_relic/agent/instrumentation/controller_instrumentation.rb

Instance Method Summary collapse

Instance Method Details

#add_transaction_tracer(method, options = {}) ⇒ Object

Add transaction tracing to the given method. This will treat the given method as a main entrypoint for instrumentation, just like controller actions are treated by default. Useful especially for background tasks.

Example for background job:

class Job
  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
  def run(task)
     ...
  end
  # Instrument run so tasks show up under task.name.  Note single
  # quoting to defer eval to runtime.
  add_transaction_tracer :run, :name => '#{args[0].name}'
end

Here's an example of a controller that uses a dispatcher action to invoke operations which you want treated as top level actions, so they aren't all lumped into the invoker action.

MyController < ActionController::Base
  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
  # dispatch the given op to the method given by the service parameter.
  def invoke_operation
    op = params['operation']
    send op
  end
  # Ignore the invoker to avoid double counting
  newrelic_ignore :only => 'invoke_operation'
  # Instrument the operations:
  add_transaction_tracer :print
  add_transaction_tracer :show
  add_transaction_tracer :forward
end

Here's an example of how to pass contextual information into the transaction so it will appear in transaction traces:

class Job
  include NewRelic::Agent::Instrumentation::ControllerInstrumentation
  def process(account)
     ...
  end
  # Include the account name in the transaction details.  Note the single
  # quotes to defer eval until call time.
  add_transaction_tracer :process, :params => '{ :account_name => args[0].name }'
end

See NewRelic::Agent::Instrumentation::ControllerInstrumentation#perform_action_with_newrelic_trace for the full list of available options.


161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# File 'lib/new_relic/agent/instrumentation/controller_instrumentation.rb', line 161

def add_transaction_tracer(method, options={})
  NewRelic::Agent.record_api_supportability_metric(:add_transaction_tracer)

  # The metric path:
  options[:name] ||= method.to_s

  argument_list = generate_argument_list(options)
  traced_method, punctuation = parse_punctuation(method)
  with_method_name, without_method_name = build_method_names(traced_method, punctuation)

  if already_added_transaction_tracer?(self, with_method_name)
    ::NewRelic::Agent.logger.warn("Transaction tracer already in place for class = #{self.name}, method = #{method.to_s}, skipping")
    return
  end

  class_eval <<-EOC
    def #{with_method_name}(*args, &block)
      perform_action_with_newrelic_trace(#{argument_list.join(',')}) do
        #{without_method_name}(*args, &block)
       end
    end
  EOC

  visibility = NewRelic::Helper.instance_method_visibility self, method

  alias_method without_method_name, method.to_s
  alias_method method.to_s, with_method_name
  send visibility, method
  send visibility, with_method_name
  ::NewRelic::Agent.logger.debug("Traced transaction: class = #{self.name}, method = #{method.to_s}, options = #{options.inspect}")
end

#newrelic_ignore(specifiers = {}) ⇒ Object

Have NewRelic ignore actions in this controller. Specify the actions as hash options using :except and :only. If no actions are specified, all actions are ignored.


57
58
59
60
# File 'lib/new_relic/agent/instrumentation/controller_instrumentation.rb', line 57

def newrelic_ignore(specifiers={})
  NewRelic::Agent.record_api_supportability_metric(:newrelic_ignore)
  newrelic_ignore_aspect(NR_DO_NOT_TRACE_KEY, specifiers)
end

#newrelic_ignore_apdex(specifiers = {}) ⇒ Object

Have NewRelic omit apdex measurements on the given actions. Typically used for actions that are not user facing or that skew your overall apdex measurement. Accepts :except and :only options, as with #newrelic_ignore.


67
68
69
70
# File 'lib/new_relic/agent/instrumentation/controller_instrumentation.rb', line 67

def newrelic_ignore_apdex(specifiers={})
  NewRelic::Agent.record_api_supportability_metric(:newrelic_ignore_apdex)
  newrelic_ignore_aspect(NR_IGNORE_APDEX_KEY, specifiers)
end

#newrelic_ignore_enduser(specifiers = {}) ⇒ Object


73
74
75
76
# File 'lib/new_relic/agent/instrumentation/controller_instrumentation.rb', line 73

def newrelic_ignore_enduser(specifiers={})
  NewRelic::Agent.record_api_supportability_metric(:newrelic_ignore_enduser)
  newrelic_ignore_aspect(NR_IGNORE_ENDUSER_KEY, specifiers)
end