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
-
#record_metric(metric_name, value) ⇒ Object
Record a value for the given metric name.
Recording custom errors collapse
-
#ignore_error_filter(&block) ⇒ Object
Set a filter to be applied to errors that the Ruby Agent will track.
-
#notice_error(exception, options = {}) ⇒ Object
Send an error to New Relic.
Recording custom Insights events collapse
-
#record_custom_event(event_type, event_attrs) ⇒ Object
Record a custom event to be sent to New Relic Insights.
Manual agent configuration and startup/shutdown collapse
-
#add_instrumentation(file_pattern) ⇒ Object
Add instrumentation files to the agent.
-
#after_fork(options = {}) ⇒ Object
Register this method as a callback for processes that fork jobs.
-
#drop_buffered_data ⇒ Object
Clear out any data the agent has buffered but has not yet transmitted to the collector.
-
#manual_start(options = {}) ⇒ Object
Call this to manually start the Agent in situations where the Agent does not auto-start.
-
#require_test_helper ⇒ Object
Require agent testing helper methods.
-
#set_sql_obfuscator(type = :replace, &block) ⇒ Object
This method sets the block sent to this method as a sql obfuscator.
-
#shutdown(options = {}) ⇒ Object
Shutdown the agent.
Ignoring or excluding data collapse
-
#disable_all_tracing ⇒ Object
Yield to the block without collecting any metrics or traces in any of the subsequent calls.
-
#disable_sql_recording ⇒ Object
This method sets the state of sql recording in the transaction sampler feature.
-
#disable_transaction_tracing ⇒ Object
This method disables the recording of transaction traces in the given block.
-
#ignore_apdex ⇒ Object
This method disables the recording of Apdex metrics in the current transaction.
-
#ignore_enduser ⇒ Object
This method disables browser monitoring javascript injection in the current transaction.
-
#ignore_transaction ⇒ Object
This method disables the recording of the current transaction.
Adding custom attributes to traces collapse
-
#add_custom_attributes(params) ⇒ Object
Add attributes to the transaction trace, Insights Transaction event, and any traced errors recorded for the current transaction.
-
#add_custom_span_attributes(params) ⇒ Object
Add custom attributes to the span event for the current span.
Transaction naming collapse
-
#get_transaction_name ⇒ Object
Get the name of the current running transaction.
-
#set_transaction_name(name, options = {}) ⇒ Object
Set the name of the current running transaction.
Trace and Entity metadata collapse
-
#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.
Manual browser monitoring configuration collapse
-
#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.
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.
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'lib/new_relic/agent.rb', line 580 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 # Make sure not to override existing segment-level custom attributes segment_custom_keys = segment.attributes.custom_attributes.keys.map(&:to_sym) segment.add_custom_attributes(params.reject { |k, _v| segment_custom_keys.include?(k.to_sym) }) 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.
611 612 613 614 615 616 617 618 619 620 621 |
# File 'lib/new_relic/agent.rb', line 611 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.
421 422 423 424 |
# File 'lib/new_relic/agent.rb', line 421 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 Rainbows 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.
386 387 388 389 |
# File 'lib/new_relic/agent.rb', line 386 def after_fork( = {}) record_api_supportability_metric(:after_fork) agent.after_fork() 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.
759 760 761 762 763 764 |
# File 'lib/new_relic/agent.rb', line 759 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.
500 501 502 503 504 505 506 507 508 509 510 511 |
# File 'lib/new_relic/agent.rb', line 500 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
536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/new_relic/agent.rb', line 536 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 |
#disable_transaction_tracing ⇒ Object
This method disables the recording of transaction traces in the given block. See also #disable_all_tracing
518 519 520 521 522 523 |
# File 'lib/new_relic/agent.rb', line 518 def disable_transaction_tracing Deprecator.deprecate :disable_transaction_tracing, 'disable_all_tracing or ignore_transaction' record_api_supportability_metric(:disable_transaction_tracing) yield end |
#drop_buffered_data ⇒ Object
Clear out any data the agent has buffered but has not yet transmitted to the collector.
407 408 409 410 |
# File 'lib/new_relic/agent.rb', line 407 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.
662 663 664 665 666 667 668 669 670 |
# File 'lib/new_relic/agent.rb', line 662 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.
476 477 478 479 480 |
# File 'lib/new_relic/agent.rb', line 476 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.
487 488 489 490 491 |
# File 'lib/new_relic/agent.rb', line 487 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 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.
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.
465 466 467 468 469 |
# File 'lib/new_relic/agent.rb', line 465 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.
732 733 734 735 736 737 |
# File 'lib/new_relic/agent.rb', line 732 def = Hash.new LinkingMetadata.() LinkingMetadata.() 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 |
# File 'lib/new_relic/agent.rb', line 355 def manual_start( = {}) raise "Options must be a hash" unless Hash === NewRelic::Control.instance.init_plugin({:agent_enabled => true, :sync_startup => true}.merge()) 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.
289 290 291 292 293 294 |
# File 'lib/new_relic/agent.rb', line 289 def notice_error(exception, = {}) record_api_supportability_metric(:notice_error) Transaction.notice_error(exception, ) nil # don't return a noticed error datastructure. 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.
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.
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/new_relic/agent.rb', line 195 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 stats.call_count = value[:count] if value[:count] stats.total_call_time = value[:total] if value[:total] stats.total_exclusive_time = value[:total] if value[:total] stats.min_call_time = value[:min] if value[:min] stats.max_call_time = value[:max] if value[:max] stats.sum_of_squares = value[:sum_of_squares] if value[:sum_of_squares] value = stats end agent.stats_engine.tl_record_unscoped_metrics(metric_name, value) end |
#require_test_helper ⇒ Object
Require agent testing helper methods
429 430 431 432 |
# File 'lib/new_relic/agent.rb', line 429 def require_test_helper record_api_supportability_metric(:require_test_helper) require File.('../../../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
450 451 452 453 |
# File 'lib/new_relic/agent.rb', line 450 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.
652 653 654 655 |
# File 'lib/new_relic/agent.rb', line 652 def set_transaction_name(name, = {}) record_api_supportability_metric(:set_transaction_name) Transaction.set_overriding_transaction_name(name, [:category]) end |
#shutdown(options = {}) ⇒ Object
Shutdown the agent. Call this before exiting. Sends any queued data and kills the background thread.
398 399 400 401 |
# File 'lib/new_relic/agent.rb', line 398 def shutdown( = {}) record_api_supportability_metric(:shutdown) agent.shutdown if agent end |