Module: NewRelic::Agent

Extended by:
Forwardable, Agent, SupportabilityHelper
Included in:
Agent
Defined in:
lib/new_relic/agent.rb,
lib/new_relic/agent/method_tracer.rb,
lib/new_relic/agent/distributed_tracing.rb,
lib/new_relic/agent/external.rb,
lib/new_relic/agent/instrumentation/controller_instrumentation.rb,
lib/new_relic/agent/datastores.rb,
lib/new_relic/agent/messaging.rb,
lib/new_relic/agent/sql_sampler.rb,
lib/new_relic/agent/tracer.rb,
lib/new_relic/agent/transaction.rb,
lib/new_relic/agent/transaction_sampler.rb,
lib/new_relic/agent/transaction/external_request_segment.rb

Overview

This module contains most of the public API methods for the Ruby Agent.

For adding custom instrumentation to method invocations, see the docs for MethodTracer and MethodTracer::ClassMethods.

For information on how to trace transactions in non-Rack contexts, see Instrumentation::ControllerInstrumentation.

For general documentation about the Ruby agent, see: docs.newrelic.com/docs/agents/ruby-agent

Defined Under Namespace

Modules: Datastores, DistributedTracing, External, Instrumentation, Messaging, MethodTracer Classes: SqlSampler, Tracer, Transaction, TransactionSampler

Recording custom metrics collapse

SUPPORTABILITY_INCREMENT_METRIC =

Increment a simple counter metric.

metric_name should follow a slash separated path convention. Application specific metrics should begin with “Custom/”.

This method is safe to use from any thread.

'Supportability/API/increment_metric'.freeze

Recording custom metrics collapse

Recording custom errors collapse

Recording custom Insights events collapse

Manual agent configuration and startup/shutdown collapse

Ignoring or excluding data collapse

Adding custom attributes to traces collapse

Transaction naming collapse

Trace and Entity metadata collapse

Manual browser monitoring configuration collapse

Instance Method Details

#add_custom_attributes(params) ⇒ Object

Add attributes to the transaction trace, Insights Transaction event, and any traced errors recorded for the current transaction.

If Browser Monitoring is enabled, and the browser_monitoring.attributes.enabled configuration setting is true, these custom attributes will also be present in the script injected into the response body, making them available on Insights PageView events.

Parameters:

  • params (Hash) —

    A Hash of attributes to be attached to the transaction event. Keys should be strings or symbols, and values may be strings, symbols, numeric values or booleans.


563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/new_relic/agent.rb', line 563

def add_custom_attributes(params) # THREAD_LOCAL_ACCESS
  record_api_supportability_metric(:add_custom_attributes)

  if params.is_a?(Hash)
    txn = Transaction.tl_current
    txn.add_custom_attributes(params) if txn

    segment = ::NewRelic::Agent::Tracer.current_segment
    if segment
      add_new_segment_attributes(params, segment)
    end
  else
    ::NewRelic::Agent.logger.warn("Bad argument passed to #add_custom_attributes. Expected Hash but got #{params.class}")
  end
end

#add_custom_span_attributes(params) ⇒ Object

Add custom attributes to the span event for the current span. Attributes will be visible on spans in the New Relic Distributed Tracing UI and on span events in New Relic Insights.

Custom attributes will not be transmitted when high_security setting is enabled or custom_attributes setting is disabled.

Parameters:

  • params (Hash) —

    A Hash of attributes to be attached to the span event. Keys should be strings or symbols, and values may be strings, symbols, numeric values or booleans.

See Also:


598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/new_relic/agent.rb', line 598

def add_custom_span_attributes(params)
  record_api_supportability_metric(:add_custom_span_attributes)

  if params.is_a?(Hash)
    if segment = NewRelic::Agent::Tracer.current_segment
      segment.add_custom_attributes(params)
    end
  else
    ::NewRelic::Agent.logger.warn("Bad argument passed to #add_custom_span_attributes. Expected Hash but got #{params.class}")
  end
end

#add_instrumentation(file_pattern) ⇒ Object

Add instrumentation files to the agent. The argument should be a glob matching ruby scripts which will be executed at the time instrumentation is loaded. Since instrumentation is not loaded when the agent is not running it's better to use this method to register instrumentation than just loading the files directly, although that probably also works.


422
423
424
425
 
# File 'lib/new_relic/agent.rb', line 422

def add_instrumentation(file_pattern)
  record_api_supportability_metric(:add_instrumentation)
  NewRelic::Control.instance.add_instrumentation(file_pattern)
end

#after_fork(options = {}) ⇒ Object

Register this method as a callback for processes that fork jobs.

If the master/parent connects to the agent prior to forking the agent in the forked process will use that agent_run. Otherwise the forked process will establish a new connection with the server.

Use this especially when you fork the process to run background jobs or other work. If you are doing this with a web dispatcher that forks worker processes then you will need to force the agent to reconnect, which it won't do by default. Passenger and Unicorn are already handled, nothing special needed for them.

Options:

  • :force_reconnect => true to force the spawned process to establish a new connection, such as when forking a long running process. The default is false–it will only connect to the server if the parent had not connected.

  • :keep_retrying => false if we try to initiate a new connection, this tells me to only try it once so this method returns quickly if there is some kind of latency with the server.


387
388
389
390
 
# File 'lib/new_relic/agent.rb', line 387

def after_fork(options = {})
  record_api_supportability_metric(:after_fork)
  agent.after_fork(options) if agent
end

#browser_timing_header(nonce = nil) ⇒ Object

This method returns a string suitable for inclusion in a page - known as 'manual instrumentation' for Real User Monitoring. Can return either a script tag with associated javascript, or in the case of disabled Real User Monitoring, an empty string

This is the header string - it should be placed as high in the page as is reasonably possible - that is, before any style or javascript inclusions, but after any header-related meta tags

In previous agents there was a corresponding footer required, but all the work is now done by this single method.

Parameters:

  • nonce (String) (defaults to: nil) —

    The nonce to use in the javascript tag for browser instrumentation


746
747
748
749
750
751
752
 
# File 'lib/new_relic/agent.rb', line 746

def browser_timing_header(nonce = nil)
  record_api_supportability_metric(:browser_timing_header)

  return EMPTY_STR unless agent

  agent.javascript_instrumentor.browser_timing_header(nonce)
end

#disable_all_tracing ⇒ Object

Yield to the block without collecting any metrics or traces in any of the subsequent calls. If executed recursively, will keep track of the first entry point and turn on tracing again after leaving that block. This uses the thread local Tracer::State.


501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/new_relic/agent.rb', line 501

def disable_all_tracing
  record_api_supportability_metric(:disable_all_tracing)

  return yield unless agent

  begin
    agent.push_trace_execution_flag(false)
    yield
  ensure
    agent.pop_trace_execution_flag
  end
end

#disable_sql_recording ⇒ Object

This method sets the state of sql recording in the transaction sampler feature. Within the given block, no sql will be recorded

usage:

NewRelic::Agent.disable_sql_recording do
  ...
end


525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/new_relic/agent.rb', line 525

def disable_sql_recording
  record_api_supportability_metric(:disable_sql_recording)

  return yield unless agent

  state = agent.set_record_sql(false)
  begin
    yield
  ensure
    agent.set_record_sql(state)
  end
end

#drop_buffered_data ⇒ Object

Clear out any data the agent has buffered but has not yet transmitted to the collector.


408
409
410
411
 
# File 'lib/new_relic/agent.rb', line 408

def drop_buffered_data
  agent.drop_buffered_data if agent
  record_api_supportability_metric(:drop_buffered_data)
end

#get_transaction_name ⇒ Object

Get the name of the current running transaction. This is useful if you want to modify the default name.


649
650
651
652
653
654
655
656
657
 
# File 'lib/new_relic/agent.rb', line 649

def get_transaction_name # THREAD_LOCAL_ACCESS
  record_api_supportability_metric(:get_transaction_name)

  txn = Transaction.tl_current
  if txn
    namer = Instrumentation::ControllerInstrumentation::TransactionNamer
    txn.best_name.sub(Regexp.new("\\A#{Regexp.escape(namer.prefix_for_category(txn))}"), '')
  end
end

#ignore_apdex ⇒ Object

This method disables the recording of Apdex metrics in the current transaction.


477
478
479
480
481
 
# File 'lib/new_relic/agent.rb', line 477

def ignore_apdex
  record_api_supportability_metric(:ignore_apdex)
  txn = NewRelic::Agent::Transaction.tl_current
  txn.ignore_apdex! if txn
end

#ignore_enduser ⇒ Object

This method disables browser monitoring javascript injection in the current transaction.


488
489
490
491
492
 
# File 'lib/new_relic/agent.rb', line 488

def ignore_enduser
  record_api_supportability_metric(:ignore_enduser)
  txn = NewRelic::Agent::Transaction.tl_current
  txn.ignore_enduser! if txn
end

#ignore_error_filter(&block) ⇒ Object

Set a filter to be applied to errors that the Ruby Agent will track. The block should evaluate to the exception to track (which could be different from the original exception) or nil to ignore this exception.

The block is yielded to with the exception to filter.

Return the new block or the existing filter Proc if no block is passed.


251
252
253
254
255
256
257
258
259
 
# File 'lib/new_relic/agent.rb', line 251

def ignore_error_filter(&block)
  record_api_supportability_metric(:ignore_error_filter)

  if block
    NewRelic::Agent::ErrorCollector.ignore_error_filter = block
  else
    NewRelic::Agent::ErrorCollector.ignore_error_filter
  end
end

#ignore_transaction ⇒ Object

This method disables the recording of the current transaction. No metrics, traced errors, transaction traces, Insights events, slow SQL traces, or RUM injection will happen for this transaction.


466
467
468
469
470
 
# File 'lib/new_relic/agent.rb', line 466

def ignore_transaction
  record_api_supportability_metric(:ignore_transaction)
  txn = NewRelic::Agent::Transaction.tl_current
  txn.ignore! if txn
end

#linking_metadata ⇒ Object

Returns a new hash containing trace and entity metadata that can be used to relate data to a trace or to an entity in APM.

This hash includes:

  • trace.id - The current trace id, if there is a current trace id. This value may be omitted.

  • span.id - The current span id, if there is a current span. This value may be omitted.

  • entity.name - The name of the current application. This is read from the app_name key in your config. If there are multiple application names, the first one is used.

  • entity.type - The entity type is hardcoded to the string 'SERVICE'.

  • entity.guid - The guid of the current entity.

  • hostname - The fully qualified hostname.


719
720
721
722
723
724
 
# File 'lib/new_relic/agent.rb', line 719

def linking_metadata
  metadata = Hash.new
  LinkingMetadata.append_service_linking_metadata(metadata)
  LinkingMetadata.append_trace_linking_metadata(metadata)
  metadata
end

#manual_start(options = {}) ⇒ Object

Call this to manually start the Agent in situations where the Agent does not auto-start.

When the app environment loads, so does the Agent. However, the Agent will only connect to the service if a web front-end is found. If you want to selectively monitor ruby processes that don't use web plugins, then call this method in your code and the Agent will fire up and start reporting to the service.

Options are passed in as overrides for values in the newrelic.yml, such as app_name. In addition, the option log will take a logger that will be used instead of the standard file logger. The setting for the newrelic.yml section to use (ie, RAILS_ENV) can be overridden with an :env argument.


355
356
357
358
359
360
 
# File 'lib/new_relic/agent.rb', line 355

def manual_start(options = {})
  raise "Options must be a hash" unless Hash === options

  NewRelic::Control.instance.init_plugin({:agent_enabled => true, :sync_startup => true}.merge(options))
  record_api_supportability_metric(:manual_start)
end

#notice_error(exception, options = {}) ⇒ Object

Send an error to New Relic.

Any option keys other than the ones listed here are treated as :custom_params.

Note: Previous versions of the agent allowed passing :request_params, but those are now ignored. If you need to record the request parameters, call this method inside a transaction or pass the information in :custom_params.

Most of the time, you do not need to specify the :uri or :metric options; only pass them if you are calling notice_error outside a transaction.

Parameters:

  • exception (Exception) —

    Error you wish to send

  • options (Hash) (defaults to: {}) —

    Modify how New Relic processes the error

Options Hash (options):

  • :custom_params (Hash) —

    Custom parameters to attach to the trace

  • :expected (Boolean) —

    Only record the error trace (do not affect error rate or Apdex status)

  • :uri (String) —

    Request path, minus request params or query string (usually not needed)

  • :metric (String) —

    Metric name associated with the transaction (usually not needed)


289
290
291
292
293
294
 
# File 'lib/new_relic/agent.rb', line 289

def notice_error(exception, options = {})
  record_api_supportability_metric(:notice_error)

  Transaction.notice_error(exception, options)
  nil # don't return a noticed error data structure. it can only hurt.
end

#record_custom_event(event_type, event_attrs) ⇒ Object

Record a custom event to be sent to New Relic Insights. The recorded event will be buffered in memory until the next time the agent sends data to New Relic's servers.

If you want to be able to tie the information recorded via this call back to the web request or background job that it happened in, you may want to instead use the add_custom_attributes API call to attach attributes to the Transaction event that will automatically be generated for the request.

A timestamp will be automatically added to the recorded event when this method is called.

Parameters:

  • event_type (Symbol or String) —

    The name of the event type to record. Event types must consist of only alphanumeric characters, '_', ':', or ' '.

  • event_attrs (Hash) —

    A Hash of attributes to be attached to the event. Keys should be strings or symbols, and values may be strings, symbols, numeric values or booleans.


324
325
326
327
328
329
330
331
332
 
# File 'lib/new_relic/agent.rb', line 324

def record_custom_event(event_type, event_attrs)
  record_api_supportability_metric(:record_custom_event)

  if agent && NewRelic::Agent.config[:'custom_insights_events.enabled']
    agent.custom_event_aggregator.record(event_type, event_attrs)
  end

  nil
end

#record_metric(metric_name, value) ⇒ Object

Record a value for the given metric name.

This method should be used to record event-based metrics such as method calls that are associated with a specific duration or magnitude.

metric_name should follow a slash separated path convention. Application specific metrics should begin with “Custom/”.

value should be either a single Numeric value representing the duration/ magnitude of the event being recorded, or a Hash containing :count, :total, :min, :max, and :sum_of_squares keys. The latter form is useful for recording pre-aggregated metrics collected externally.

This method is safe to use from any thread.


194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/new_relic/agent.rb', line 194

def record_metric(metric_name, value) # THREAD_LOCAL_ACCESS
  record_api_supportability_metric(:record_metric)

  return unless agent

  if value.is_a?(Hash)
    stats = NewRelic::Agent::Stats.new
    value = stats.hash_merge(value)
  end

  agent.stats_engine.tl_record_unscoped_metrics(metric_name, value)
end

#require_test_helper ⇒ Object

Require agent testing helper methods


430
431
432
433
 
# File 'lib/new_relic/agent.rb', line 430

def require_test_helper
  record_api_supportability_metric(:require_test_helper)
  require File.expand_path('../../../test/agent_helper', __FILE__)
end

#set_sql_obfuscator(type = :replace, &block) ⇒ Object

This method sets the block sent to this method as a sql obfuscator. The block will be called with a single String SQL statement to obfuscate. The method must return the obfuscated String SQL. If chaining of obfuscators is required, use type = :before or :after

type = :before, :replace, :after

Example:

NewRelic::Agent.set_sql_obfuscator(:replace) do |sql|
   my_obfuscator(sql)
end


451
452
453
454
 
# File 'lib/new_relic/agent.rb', line 451

def set_sql_obfuscator(type = :replace, &block)
  record_api_supportability_metric(:set_sql_obfuscator)
  NewRelic::Agent::Database.set_sql_obfuscator(type, &block)
end

#set_transaction_name(name, options = {}) ⇒ Object

Set the name of the current running transaction. The agent will apply a reasonable default based on framework routing, but in cases where this is insufficient, this can be used to manually control the name of the transaction.

The category of transaction can be specified via the :category option. The following are the only valid categories:

  • :category => :controller indicates that this is a controller action and will appear with all the other actions.

  • :category => :task indicates that this is a background task and will show up in New Relic with other background tasks instead of in the controllers list

  • :category => :middleware if you are instrumenting a rack middleware call. The :name is optional, useful if you have more than one potential transaction in the #call.

  • :category => :uri indicates that this is a web transaction whose name is a normalized URI, where 'normalized' means the URI does not have any elements with data in them such as in many REST URIs.

The default category is the same as the running transaction.


639
640
641
642
 
# File 'lib/new_relic/agent.rb', line 639

def set_transaction_name(name, options = {})
  record_api_supportability_metric(:set_transaction_name)
  Transaction.set_overriding_transaction_name(name, options[:category])
end

#shutdown(options = {}) ⇒ Object

Shutdown the agent. Call this before exiting. Sends any queued data and kills the background thread.

Parameters:

  • options (Hash) (defaults to: {}) —

    Unused options Hash, for back compatibility only


399
400
401
402
 
# File 'lib/new_relic/agent.rb', line 399

def shutdown(options = {})
  record_api_supportability_metric(:shutdown)
  agent.shutdown if agent
end