Module: NewRelic::Agent

Extended by:
Forwardable, Agent, Configuration::Instance
Included in:
Agent
Defined in:
lib/new_relic/agent.rb,
lib/new_relic/agent/agent.rb,
lib/new_relic/agent/stats.rb,
lib/new_relic/agent/thread.rb,
lib/new_relic/agent/sampler.rb,
lib/new_relic/agent/database.rb,
lib/new_relic/agent/shim_agent.rb,
lib/new_relic/agent/sql_sampler.rb,
lib/new_relic/agent/worker_loop.rb,
lib/new_relic/agent/agent_logger.rb,
lib/new_relic/agent/audit_logger.rb,
lib/new_relic/agent/pipe_service.rb,
lib/new_relic/agent/rules_engine.rb,
lib/new_relic/agent/stats_engine.rb,
lib/new_relic/agent/configuration.rb,
lib/new_relic/agent/method_tracer.rb,
lib/new_relic/agent/event_listener.rb,
lib/new_relic/agent/busy_calculator.rb,
lib/new_relic/agent/error_collector.rb,
lib/new_relic/agent/instrumentation.rb,
lib/new_relic/agent/thread_profiler.rb,
lib/new_relic/agent/transaction_info.rb,
lib/new_relic/agent/cross_app_monitor.rb,
lib/new_relic/agent/cross_app_tracing.rb,
lib/new_relic/agent/new_relic_service.rb,
lib/new_relic/agent/browser_monitoring.rb,
lib/new_relic/agent/transaction_sampler.rb,
lib/new_relic/agent/beacon_configuration.rb,
lib/new_relic/agent/instrumentation/rack.rb,
lib/new_relic/agent/pipe_channel_manager.rb,
lib/new_relic/agent/samplers/cpu_sampler.rb,
lib/new_relic/agent/configuration/manager.rb,
lib/new_relic/agent/stats_engine/samplers.rb,
lib/new_relic/agent/configuration/defaults.rb,
lib/new_relic/agent/instrumentation/sinatra.rb,
lib/new_relic/agent/samplers/memory_sampler.rb,
lib/new_relic/agent/samplers/object_sampler.rb,
lib/new_relic/agent/stats_engine/stats_hash.rb,
lib/new_relic/agent/instrumentation/memcache.rb,
lib/new_relic/agent/stats_engine/gc_profiler.rb,
lib/new_relic/agent/configuration/yaml_source.rb,
lib/new_relic/agent/stats_engine/metric_stats.rb,
lib/new_relic/agent/stats_engine/transactions.rb,
lib/new_relic/agent/instrumentation/queue_time.rb,
lib/new_relic/agent/transaction_sample_builder.rb,
lib/new_relic/agent/configuration/mask_defaults.rb,
lib/new_relic/agent/configuration/server_source.rb,
lib/new_relic/agent/instrumentation/data_mapper.rb,
lib/new_relic/agent/instrumentation/metric_frame.rb,
lib/new_relic/agent/samplers/delayed_job_sampler.rb,
lib/new_relic/agent/instrumentation/active_record.rb,
lib/new_relic/agent/instrumentation/rails3/errors.rb,
lib/new_relic/agent/instrumentation/rails4/errors.rb,
lib/new_relic/agent/configuration/environment_source.rb,
lib/new_relic/agent/instrumentation/metric_frame/pop.rb,
lib/new_relic/agent/instrumentation/rails3/action_controller.rb,
lib/new_relic/agent/instrumentation/rails4/action_controller.rb,
lib/new_relic/agent/instrumentation/browser_monitoring_timings.rb,
lib/new_relic/agent/instrumentation/controller_instrumentation.rb

Overview

Ruby Agent APIs

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

For adding custom instrumentation to method invocations, refer to the docs in the class NewRelic::Agent::MethodTracer.

For information on how to customize the controller instrumentation, or to instrument something other than Rails so that high level dispatcher actions or background tasks show up as first class operations in New Relic, refer to NewRelic::Agent::Instrumentation::ControllerInstrumentation and NewRelic::Agent::Instrumentation::ControllerInstrumentation::ClassMethods.

Methods in this module as well as documented methods in NewRelic::Agent::MethodTracer and NewRelic::Agent::Instrumentation::ControllerInstrumentation are available to applications. When the agent is not enabled the method implementations are stubbed into no-ops to reduce overhead.

Methods and classes in other parts of the agent are not guaranteed to be available between releases.

Refer to the online docs at support.newrelic.com to see how to access the data collected by custom instrumentation, or e-mail support at New Relic for help.

Defined Under Namespace

Modules: BrowserMonitoring, BusyCalculator, Configuration, CrossAppTracing, Database, Instrumentation, MethodTracer, PipeChannelManager, Samplers Classes: Agent, AgentLogger, AgentThread, AuditLogger, BackgroundLoadingError, BeaconConfiguration, ChainedStats, CrossAppMonitor, ErrorCollector, EventListener, ForceDisconnectException, ForceRestartException, LicenseException, MemoryLogger, NewRelicService, PipeService, RulesEngine, Sampler, ServerConnectionException, ServerError, ShimAgent, SlowSql, SqlSampler, SqlTrace, StartupLogger, Stats, StatsEngine, StatsHash, ThreadProfile, ThreadProfiler, TransactionInfo, TransactionSampleBuilder, TransactionSampler, TransactionSqlData, UnrecoverableAgentException, UnrecoverableServerException, WorkerLoop

Instance Method Summary collapse

Methods included from Configuration::Instance

config, reset_config

Instance Method Details

#abort_transaction! ⇒ Object

Cancel the collection of the current transaction in progress, if any. Only affects the transaction started on this thread once it has started and before it has completed.



339
340
341
 
# File 'lib/new_relic/agent.rb', line 339

def abort_transaction!
  NewRelic::Agent::Instrumentation::MetricFrame.abort_transaction!
end

#add_custom_parameters(params) ⇒ Object Also known as: add_request_parameters

Add parameters to the current transaction trace (and traced error if any) on the call stack.



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

def add_custom_parameters(params)
  NewRelic::Agent::Instrumentation::MetricFrame.add_custom_parameters(params)
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.



284
285
286
 
# File 'lib/new_relic/agent.rb', line 284

def add_instrumentation(file_pattern)
  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.



263
264
265
 
# File 'lib/new_relic/agent.rb', line 263

def after_fork(options={})
  agent.after_fork(options)
end

#agent ⇒ Object Also known as: instance

The singleton Agent instance. Used internally.



138
139
140
 
# File 'lib/new_relic/agent.rb', line 138

def agent #:nodoc:
  @agent || raise("Plugin not initialized!")
end

#agent=(new_instance) ⇒ Object

:nodoc:



142
143
144
 
# File 'lib/new_relic/agent.rb', line 142

def agent=(new_instance)#:nodoc:
  @agent = new_instance
end

#browser_timing_footer ⇒ Object

Returns a Javascript string which should be injected into the very bottom of the response body



482
483
484
 
# File 'lib/new_relic/agent.rb', line 482

def browser_timing_footer
  agent.browser_timing_footer
end

#browser_timing_header ⇒ Object

Returns a Javascript string which should be injected into the very top of the response body



476
477
478
 
# File 'lib/new_relic/agent.rb', line 476

def browser_timing_header
  agent.browser_timing_header
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 newrelic_untrace



348
349
350
351
352
353
 
# File 'lib/new_relic/agent.rb', line 348

def disable_all_tracing
  agent.push_trace_execution_flag(false)
  yield
ensure
  agent.pop_trace_execution_flag
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



316
317
318
319
320
321
322
323
 
# File 'lib/new_relic/agent.rb', line 316

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

#disable_transaction_tracing ⇒ Object

This method disables the recording of transaction traces in the given block. See also #disable_all_tracing



327
328
329
330
331
332
333
334
 
# File 'lib/new_relic/agent.rb', line 327

def disable_transaction_tracing
  state = agent.set_record_tt(false)
  begin
    yield
  ensure
    agent.set_record_tt(state)
  end
end

#get_stats(metric_name, use_scope = false) ⇒ Object Also known as: get_stats_no_scope

Deprecated.

Get or create a statistics gatherer that will aggregate numerical data under a metric name.

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

Return a NewRelic::Agent::Stats that accepts data via calls to add_data_point(value).



212
213
214
 
# File 'lib/new_relic/agent.rb', line 212

def get_stats(metric_name, use_scope=false)
  agent.stats_engine.get_stats(metric_name, use_scope)
end

#ignore_error_filter(&block) ⇒ Object

Set a filter to be applied to errors that the Ruby Agent will track. The block should evalute 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.



382
383
384
 
# File 'lib/new_relic/agent.rb', line 382

def ignore_error_filter(&block)
  agent.error_collector.ignore_error_filter(&block)
end

#increment_metric(metric_name, amount = 1) ⇒ Object

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.



196
197
198
199
200
 
# File 'lib/new_relic/agent.rb', line 196

def increment_metric(metric_name, amount=1)
  agent.stats_engine.record_metric(metric_name) do |stats|
    stats.increment_count(amount)
  end
end

#is_execution_traced? ⇒ Boolean

Check to see if we are capturing metrics currently on this thread.

Returns:

  • (Boolean) 


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

def is_execution_traced?
  untraced = Thread.current[:newrelic_untraced]
  untraced.nil? || untraced.last != false
end

#is_sql_recorded? ⇒ Boolean

helper method to check the thread local to determine whether sql is being recorded or not

Returns:

  • (Boolean) 


369
370
371
 
# File 'lib/new_relic/agent.rb', line 369

def is_sql_recorded?
  Thread::current[:record_sql] != false
end

#is_transaction_traced? ⇒ Boolean

helper method to check the thread local to determine whether the transaction in progress is traced or not

Returns:

  • (Boolean) 


363
364
365
 
# File 'lib/new_relic/agent.rb', line 363

def is_transaction_traced?
  Thread::current[:record_tt] != false
end

#logger ⇒ Object

Primary interface to logging is fronted by this accessor Access via ::NewRelic::Agent.logger



150
151
152
 
# File 'lib/new_relic/agent.rb', line 150

def logger
  @logger || StartupLogger.instance
end

#logger=(log) ⇒ Object 



154
155
156
 
# File 'lib/new_relic/agent.rb', line 154

def logger=(log)
  @logger = log
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.



233
234
235
236
237
238
239
 
# File 'lib/new_relic/agent.rb', line 233

def manual_start(options={})
  raise "Options must be a hash" unless Hash === options
  if options[:start_channel_listener]
    NewRelic::Agent::PipeChannelManager.listener.start
  end
  NewRelic::Control.instance.init_plugin({ :agent_enabled => true, :sync_startup => true }.merge(options))
end

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

Record the given error. It will be passed through the #ignore_error_filter if there is one.

  • exception is the exception which will be recorded. May also be an error message.

Options:

  • :uri => The request path, minus any request params or query string.

  • :referer => The URI of the referer

  • :metric => The metric name associated with the transaction

  • :request_params => Request parameters, already filtered if necessary

  • :custom_params => Custom parameters

Anything left over is treated as custom params.



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

def notice_error(exception, options={})
  NewRelic::Agent::Instrumentation::MetricFrame.notice_error(exception, options)
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.



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/new_relic/agent.rb', line 174

def record_metric(metric_name, value)
  if value.is_a?(Hash)
    stats = NewRelic::Agent::Stats.new
    stats.call_count = value[:count]
    stats.total_call_time = value[:total]
    stats.total_exclusive_time = value[:total]
    stats.min_call_time = value[:min]
    stats.max_call_time = value[:max]
    stats.sum_of_squares = value[:sum_of_squares]
    value = stats
  end
  agent.stats_engine.record_metric(metric_name, value)
end

#record_transaction(response_sec, options = {}) ⇒ Object

Record a web transaction from an external source. This will process the response time, error, and score an apdex value.

First argument is a float value, time in seconds. Option keys are strings.

Identifying the transaction

  • 'uri' => uri to record the value for a given web request. If not provided, just record the aggregate dispatcher and apdex scores.

  • 'metric' => metric_name to record with a general metric name like OtherTransaction/Background/Class/method. Ignored if uri is provided.

Error options

Provide one of the following:

  • 'is_error' => true if an unknown error occurred

  • 'error_message' => msg if an error message is available

  • 'exception' => exception if a ruby exception is recorded

Misc options

Additional information captured in errors

  • 'referer' => referer_url

  • 'request_params' => hash to record a set of name/value pairs as the request parameters.

  • 'custom_params' => hash to record extra information in traced errors



470
471
472
 
# File 'lib/new_relic/agent.rb', line 470

def record_transaction(response_sec, options = {})
  agent.record_transaction(response_sec, options)
end

#reset_stats ⇒ Object

Clear out any unsent metric data. See NewRelic::Agent::Agent#reset_stats



268
269
270
 
# File 'lib/new_relic/agent.rb', line 268

def reset_stats
  agent.reset_stats
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



302
303
304
 
# File 'lib/new_relic/agent.rb', line 302

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

#set_user_attributes(attributes) ⇒ Object

Set attributes about the user making this request. These attributes will be automatically appended to any Transaction Trace or Error that is collected. These attributes will also be collected for RUM requests.

Attributes (hash)

  • :user => user name or ID

  • :account => account name or ID

  • :product => product name or level



420
421
422
 
# File 'lib/new_relic/agent.rb', line 420

def set_user_attributes(attributes)
  NewRelic::Agent::Instrumentation::MetricFrame.set_user_attributes(attributes)
end

#shutdown(options = {}) ⇒ Object

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



274
275
276
 
# File 'lib/new_relic/agent.rb', line 274

def shutdown(options={})
  agent.shutdown(options)
end

#with_database_metric_name(model, method, &block) ⇒ Object

Yield to a block that is run with a database metric name context. This means the Database instrumentation will use this for the metric name if it does not otherwise know about a model. This is re-entrant.

  • model is the DB model class

  • method is the name of the finder method or other method to identify the operation with.



436
437
438
439
440
441
442
 
# File 'lib/new_relic/agent.rb', line 436

def with_database_metric_name(model, method, &block)
  if frame = NewRelic::Agent::Instrumentation::MetricFrame.current
    frame.with_database_metric_name(model, method, &block)
  else
    yield
  end
end