Module: NewRelic::Agent::Agent::InstanceMethods
- Includes:
- Connect, Start, StartWorkerThread
- Included in:
- NewRelic::Agent::Agent
- Defined in:
- lib/new_relic/agent/agent.rb
Overview
Holds all the methods defined on NewRelic::Agent::Agent instances
Defined Under Namespace
Modules: Connect, Start, StartWorkerThread
Instance Attribute Summary collapse
-
#beacon_configuration ⇒ Object
readonly
a configuration for the Real User Monitoring system - handles things like static setup of the header for inclusion into pages.
-
#cross_app_encoding_bytes ⇒ Object
readonly
Returns the value of attribute cross_app_encoding_bytes.
-
#cross_app_monitor ⇒ Object
readonly
Returns the value of attribute cross_app_monitor.
-
#cross_process_id ⇒ Object
readonly
cross application tracing ids and encoding.
-
#error_collector ⇒ Object
readonly
error collector is a simple collection of recorded errors.
-
#events ⇒ Object
readonly
Global events dispatcher.
-
#harvest_samplers ⇒ Object
readonly
Returns the value of attribute harvest_samplers.
-
#metric_rules ⇒ Object
readonly
Returns the value of attribute metric_rules.
-
#obfuscator ⇒ Object
readonly
holds a proc that is used to obfuscate sql statements.
-
#record_sql ⇒ Object
readonly
whether we should record raw, obfuscated, or no sql.
-
#service ⇒ Object
service for communicating with collector.
-
#sql_sampler ⇒ Object
readonly
Returns the value of attribute sql_sampler.
-
#stats_engine ⇒ Object
readonly
the statistics engine that holds all the timeslice data.
-
#thread_profiler ⇒ Object
readonly
begins a thread profile session when instructed by agent commands.
-
#transaction_rules ⇒ Object
readonly
Transaction and metric renaming rules as provided by the collector on connect.
-
#transaction_sampler ⇒ Object
readonly
the transaction sampler that handles recording transactions.
Attributes included from Connect
Instance Method Summary collapse
- #add_harvest_sampler(subclass) ⇒ Object
-
#after_fork(options = {}) ⇒ Object
This method should be called in a forked process after a fork.
-
#agent_should_start? ⇒ Boolean
Check to see if the agent should start, returning
true
if it should. -
#end_transaction ⇒ Object
Tells the statistics engine we are ending a transaction.
-
#merge_data_from(data) ⇒ Object
Accepts an array of (metrics, transaction_traces, errors) and merges it into our current collection of data to send.
-
#pop_trace_execution_flag ⇒ Object
Pop the current trace execution status.
-
#push_trace_execution_flag(should_trace = false) ⇒ Object
Push flag indicating whether we should be tracing in this thread.
-
#record_transaction(duration_seconds, options = {}) ⇒ Object
fakes out a transaction that did not happen in this process by creating apdex, summary metrics, and recording statistics for the transaction.
-
#reset_objects_with_locks ⇒ Object
Clear out state for any objects that we know lock from our parents This is necessary for cases where we’re in a forked child and Ruby might be holding locks for background thread that aren’t there anymore.
-
#reset_stats ⇒ Object
Clear out the metric data, errors, and transaction traces, making sure the agent is in a fresh state.
-
#set_record_sql(should_record) ⇒ Object
Sets a thread local variable as to whether we should or should not record sql in the current thread.
-
#set_record_tt(should_record) ⇒ Object
Sets a thread local variable as to whether we should or should not record transaction traces in the current thread.
-
#shutdown(options = {}) ⇒ Object
Attempt a graceful shutdown of the agent, running the worker loop if it exists and is running.
-
#start ⇒ Object
Logs a bunch of data and starts the agent, if needed.
-
#start_transaction ⇒ Object
Tells the statistics engine we are starting a new transaction.
-
#started? ⇒ Boolean
True if we have initialized and completed ‘start’.
-
#unsent_errors_size ⇒ Object
Returns the length of the unsent errors array, if it exists, otherwise nil.
-
#unsent_timeslice_data ⇒ Object
Initializes the unsent timeslice data hash, if needed, and returns the number of keys it contains.
-
#unsent_traces_size ⇒ Object
Returns the length of the traces array, if it exists, otherwise nil.
Methods included from Connect
#add_rules_to_engine, #apdex_f, #connect_retry_period, #connect_settings, #connect_to_server, #connected?, #disconnect, #disconnected?, #environment_for_connect, #finish_setup, #generate_environment_report, #handle_license_error, #handle_unrecoverable_agent_error, #log_collector_messages, #log_connection!, #log_error, #note_connect_failure, #query_server_for_configuration, #should_connect?
Methods included from StartWorkerThread
#catch_errors, #create_and_run_worker_loop, #deferred_work!, #handle_force_disconnect, #handle_force_restart, #handle_other_error, #handle_server_connection_problem, #log_worker_loop_start
Methods included from Start
#already_started?, #app_name_configured?, #check_config_and_start_agent, #connect_in_foreground, #correct_license_length, #defer_for_resque?, #disabled?, #has_correct_license_key?, #has_license_key?, #install_exit_handler, #log_app_name, #log_dispatcher, #log_environment, #log_if, #log_startup, #log_unless, #log_version_and_pid, #monitoring?, #using_forking_dispatcher?, #using_sinatra?, #weird_ruby?
Instance Attribute Details
#beacon_configuration ⇒ Object (readonly)
a configuration for the Real User Monitoring system - handles things like static setup of the header for inclusion into pages
92 93 94 |
# File 'lib/new_relic/agent/agent.rb', line 92 def beacon_configuration @beacon_configuration end |
#cross_app_encoding_bytes ⇒ Object (readonly)
Returns the value of attribute cross_app_encoding_bytes.
95 96 97 |
# File 'lib/new_relic/agent/agent.rb', line 95 def cross_app_encoding_bytes @cross_app_encoding_bytes end |
#cross_app_monitor ⇒ Object (readonly)
Returns the value of attribute cross_app_monitor.
96 97 98 |
# File 'lib/new_relic/agent/agent.rb', line 96 def cross_app_monitor @cross_app_monitor end |
#cross_process_id ⇒ Object (readonly)
cross application tracing ids and encoding
94 95 96 |
# File 'lib/new_relic/agent/agent.rb', line 94 def cross_process_id @cross_process_id end |
#error_collector ⇒ Object (readonly)
error collector is a simple collection of recorded errors
85 86 87 |
# File 'lib/new_relic/agent/agent.rb', line 85 def error_collector @error_collector end |
#events ⇒ Object (readonly)
Global events dispatcher. This will provides our primary mechanism for agent-wide events, such as finishing configuration, error notification and request before/after from Rack.
102 103 104 |
# File 'lib/new_relic/agent/agent.rb', line 102 def events @events end |
#harvest_samplers ⇒ Object (readonly)
Returns the value of attribute harvest_samplers.
86 87 88 |
# File 'lib/new_relic/agent/agent.rb', line 86 def harvest_samplers @harvest_samplers end |
#metric_rules ⇒ Object (readonly)
Returns the value of attribute metric_rules.
107 108 109 |
# File 'lib/new_relic/agent/agent.rb', line 107 def metric_rules @metric_rules end |
#obfuscator ⇒ Object (readonly)
holds a proc that is used to obfuscate sql statements
76 77 78 |
# File 'lib/new_relic/agent/agent.rb', line 76 def obfuscator @obfuscator end |
#record_sql ⇒ Object (readonly)
whether we should record raw, obfuscated, or no sql
88 89 90 |
# File 'lib/new_relic/agent/agent.rb', line 88 def record_sql @record_sql end |
#service ⇒ Object
service for communicating with collector
98 99 100 |
# File 'lib/new_relic/agent/agent.rb', line 98 def service @service end |
#sql_sampler ⇒ Object (readonly)
Returns the value of attribute sql_sampler.
81 82 83 |
# File 'lib/new_relic/agent/agent.rb', line 81 def sql_sampler @sql_sampler end |
#stats_engine ⇒ Object (readonly)
the statistics engine that holds all the timeslice data
78 79 80 |
# File 'lib/new_relic/agent/agent.rb', line 78 def stats_engine @stats_engine end |
#thread_profiler ⇒ Object (readonly)
begins a thread profile session when instructed by agent commands
83 84 85 |
# File 'lib/new_relic/agent/agent.rb', line 83 def thread_profiler @thread_profiler end |
#transaction_rules ⇒ Object (readonly)
Transaction and metric renaming rules as provided by the collector on connect. The former are applied during txns, the latter during harvest.
106 107 108 |
# File 'lib/new_relic/agent/agent.rb', line 106 def transaction_rules @transaction_rules end |
#transaction_sampler ⇒ Object (readonly)
the transaction sampler that handles recording transactions
80 81 82 |
# File 'lib/new_relic/agent/agent.rb', line 80 def transaction_sampler @transaction_sampler end |
Instance Method Details
#add_harvest_sampler(subclass) ⇒ Object
528 529 530 |
# File 'lib/new_relic/agent/agent.rb', line 528 def add_harvest_sampler(subclass) @harvest_samplers.add_sampler(subclass) end |
#after_fork(options = {}) ⇒ Object
This method should be called in a forked process after a fork. It assumes the parent process initialized the agent, but does not assume the agent started.
The call is idempotent, but not re-entrant.
-
It clears any metrics carried over from the parent process
-
Restarts the sampler thread if necessary
-
Initiates a new agent run and worker loop unless that was done in the parent process and
:force_reconnect
is not true
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.
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/new_relic/agent/agent.rb', line 183 def after_fork(={}) Agent.config.apply_config(NewRelic::Agent::Configuration::ManualSource.new(), 1) if channel_id = [:report_to_channel] @service = NewRelic::Agent::PipeService.new(channel_id) if connected? @connected_pid = $$ else ::NewRelic::Agent.logger.debug("Child process #{$$} not reporting to non-connected parent.") @service.shutdown(Time.now) disconnect end end return if !Agent.config[:agent_enabled] || !Agent.config[:monitor_mode] || disconnected? || @worker_thread && @worker_thread.alive? ::NewRelic::Agent.logger.debug "Starting the worker thread in #{$$} after forking." reset_objects_with_locks # Clear out stats that are left over from parent process reset_stats generate_environment_report start_worker_thread() end |
#agent_should_start? ⇒ Boolean
Check to see if the agent should start, returning true
if it should.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'lib/new_relic/agent/agent.rb', line 479 def agent_should_start? return false if already_started? || disabled? if defer_for_resque? ::NewRelic::Agent.logger.debug "Deferring startup for Resque in case it daemonizes" return false end unless app_name_configured? NewRelic::Agent.logger.error "No application name configured.", "The Agent cannot start without at least one. Please check your ", "newrelic.yml and ensure that it is valid and has at least one ", "value set for app_name in the #{NewRelic::Control.instance.env} ", "environment." return false end return true end |
#end_transaction ⇒ Object
Tells the statistics engine we are ending a transaction
261 262 263 |
# File 'lib/new_relic/agent/agent.rb', line 261 def end_transaction @stats_engine.end_transaction end |
#merge_data_from(data) ⇒ Object
Accepts an array of (metrics, transaction_traces, errors) and merges it into our current collection of data to send. Can be dangerous if we re-merge the same data more than once - it will be sent multiple times.
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 |
# File 'lib/new_relic/agent/agent.rb', line 822 def merge_data_from(data) metrics, transaction_traces, errors = data @stats_engine.merge!(metrics) if metrics if transaction_traces && transaction_traces.respond_to?(:any?) && transaction_traces.any? if @traces @traces += transaction_traces else @traces = transaction_traces end end if errors && errors.respond_to?(:each) errors.each do |err| @error_collector.add_to_error_queue(err) end end end |
#pop_trace_execution_flag ⇒ Object
Pop the current trace execution status. Restore trace execution status to what it was before we pushed the current flag.
298 299 300 |
# File 'lib/new_relic/agent/agent.rb', line 298 def pop_trace_execution_flag Thread.current[:newrelic_untraced].pop if Thread.current[:newrelic_untraced] end |
#push_trace_execution_flag(should_trace = false) ⇒ Object
Push flag indicating whether we should be tracing in this thread. This uses a stack which allows us to disable tracing children of a transaction without affecting the tracing of the whole transaction
287 288 289 290 291 292 293 294 |
# File 'lib/new_relic/agent/agent.rb', line 287 def push_trace_execution_flag(should_trace=false) value = Thread.current[:newrelic_untraced] if (value.nil?) Thread.current[:newrelic_untraced] = [] end Thread.current[:newrelic_untraced] << should_trace end |
#record_transaction(duration_seconds, options = {}) ⇒ Object
fakes out a transaction that did not happen in this process by creating apdex, summary metrics, and recording statistics for the transaction
This method is deprecated - it may be removed in future versions of the agent
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/new_relic/agent/agent.rb', line 134 def record_transaction(duration_seconds, ={}) is_error = ['is_error'] || ['error_message'] || ['exception'] metric = ['metric'] metric ||= ['uri'] # normalize this with url rules raise "metric or uri arguments required" unless metric metric_info = NewRelic::MetricParser::MetricParser.for_metric_named(metric) if metric_info.is_web_transaction? NewRelic::Agent::Transaction.record_apdex(metric_info, duration_seconds, duration_seconds, is_error) end metrics = metric_info.summary_metrics metrics << metric metrics.each do |name| NewRelic::Agent.record_metric(name, duration_seconds) end if is_error if ['exception'] e = ['exception'] elsif ['error_message'] e = StandardError.new ['error_message'] else e = StandardError.new 'Unknown Error' end error_collector.notice_error e, :uri => ['uri'], :metric => metric end # busy time ? end |
#reset_objects_with_locks ⇒ Object
Clear out state for any objects that we know lock from our parents This is necessary for cases where we’re in a forked child and Ruby might be holding locks for background thread that aren’t there anymore.
524 525 526 |
# File 'lib/new_relic/agent/agent.rb', line 524 def reset_objects_with_locks @stats_engine = NewRelic::Agent::StatsEngine.new end |
#reset_stats ⇒ Object
Clear out the metric data, errors, and transaction traces, making sure the agent is in a fresh state
512 513 514 515 516 517 518 519 |
# File 'lib/new_relic/agent/agent.rb', line 512 def reset_stats @stats_engine.reset_stats @unsent_errors = [] @traces = nil @unsent_timeslice_data = {} @last_harvest_time = Time.now @launch_time = Time.now end |
#set_record_sql(should_record) ⇒ Object
Sets a thread local variable as to whether we should or should not record sql in the current thread. Returns the previous value, if there is one
268 269 270 271 272 |
# File 'lib/new_relic/agent/agent.rb', line 268 def set_record_sql(should_record) prev = Thread::current[:record_sql] Thread::current[:record_sql] = should_record prev.nil? || prev end |
#set_record_tt(should_record) ⇒ Object
Sets a thread local variable as to whether we should or should not record transaction traces in the current thread. Returns the previous value, if there is one
277 278 279 280 281 |
# File 'lib/new_relic/agent/agent.rb', line 277 def set_record_tt(should_record) prev = Thread::current[:record_tt] Thread::current[:record_tt] = should_record prev.nil? || prev end |
#shutdown(options = {}) ⇒ Object
Attempt a graceful shutdown of the agent, running the worker loop if it exists and is running.
Options: :force_send => (true/false) # force the agent to send data
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/new_relic/agent/agent.rb', line 223 def shutdown(={}) run_loop_before_exit = Agent.config[:force_send] return if not started? if @worker_loop @worker_loop.run_task if run_loop_before_exit @worker_loop.stop end ::NewRelic::Agent.logger.info "Starting Agent shutdown" # if litespeed, then ignore all future SIGUSR1 - it's # litespeed trying to shut us down if Agent.config[:dispatcher] == :litespeed Signal.trap("SIGUSR1", "IGNORE") Signal.trap("SIGTERM", "IGNORE") end begin NewRelic::Agent.disable_all_tracing do graceful_disconnect end rescue => e ::NewRelic::Agent.logger.error e end NewRelic::Agent.config.remove_config do |config| config.class == NewRelic::Agent::Configuration::ManualSource || config.class == NewRelic::Agent::Configuration::ServerSource end @started = nil Control.reset end |
#start ⇒ Object
Logs a bunch of data and starts the agent, if needed
500 501 502 503 504 505 506 507 508 |
# File 'lib/new_relic/agent/agent.rb', line 500 def start return unless agent_should_start? @started = true @local_host = determine_host log_startup check_config_and_start_agent log_version_and_pid end |
#start_transaction ⇒ Object
Tells the statistics engine we are starting a new transaction
256 257 258 |
# File 'lib/new_relic/agent/agent.rb', line 256 def start_transaction @stats_engine.start_transaction end |
#started? ⇒ Boolean
True if we have initialized and completed ‘start’
214 215 216 |
# File 'lib/new_relic/agent/agent.rb', line 214 def started? @started end |
#unsent_errors_size ⇒ Object
Returns the length of the unsent errors array, if it exists, otherwise nil
111 112 113 |
# File 'lib/new_relic/agent/agent.rb', line 111 def unsent_errors_size @unsent_errors.length if @unsent_errors end |
#unsent_timeslice_data ⇒ Object
Initializes the unsent timeslice data hash, if needed, and returns the number of keys it contains
123 124 125 126 |
# File 'lib/new_relic/agent/agent.rb', line 123 def unsent_timeslice_data @unsent_timeslice_data ||= {} @unsent_timeslice_data.keys.length end |
#unsent_traces_size ⇒ Object
Returns the length of the traces array, if it exists, otherwise nil
117 118 119 |
# File 'lib/new_relic/agent/agent.rb', line 117 def unsent_traces_size @traces.length if @traces end |