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

Attributes included from Connect

#connect_attempts, #connect_retry_period

Instance Method Summary collapse

Methods included from Connect

#apdex_f, #connect_settings, #connect_to_server, #disconnect, #environment_for_connect, #finish_setup, #get_retry_period, #handle_license_error, #increment_retry_period!, #log_collector_messages, #log_connection!, #log_error, #log_seed_token, #query_server_for_configuration, #should_keep_retrying?, #should_retry?, #tried_to_connect?, #validate_settings

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?, #check_config_and_start_agent, #connect_in_foreground, #correct_license_length, #disabled?, #has_correct_license_key?, #has_license_key?, #install_exit_handler, #log_app_names, #log_dispatcher, #log_if, #log_unless, #log_version_and_pid, #monitoring?, #notify_log_file_location, #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



91
92
93
 
# File 'lib/new_relic/agent/agent.rb', line 91

def beacon_configuration
  @beacon_configuration
end

#error_collector ⇒ Object (readonly)

error collector is a simple collection of recorded errors



78
79
80
 
# File 'lib/new_relic/agent/agent.rb', line 78

def error_collector
  @error_collector
end

#metric_ids ⇒ Object (readonly)

a cached set of metric_ids to save the collector some time - it returns a metric id for every metric name we send it, and in the future we transmit using the metric id only



84
85
86
 
# File 'lib/new_relic/agent/agent.rb', line 84

def metric_ids
  @metric_ids
end

#obfuscator ⇒ Object (readonly)

holds a proc that is used to obfuscate sql statements



69
70
71
 
# File 'lib/new_relic/agent/agent.rb', line 69

def obfuscator
  @obfuscator
end

#record_sql ⇒ Object (readonly)

whether we should record raw, obfuscated, or no sql



80
81
82
 
# File 'lib/new_relic/agent/agent.rb', line 80

def record_sql
  @record_sql
end

#service ⇒ Object

Returns the value of attribute service.



92
93
94
 
# File 'lib/new_relic/agent/agent.rb', line 92

def service
  @service
end

#sql_sampler ⇒ Object (readonly)

Returns the value of attribute sql_sampler.



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

def sql_sampler
  @sql_sampler
end

#stats_engine ⇒ Object (readonly)

the statistics engine that holds all the timeslice data



71
72
73
 
# File 'lib/new_relic/agent/agent.rb', line 71

def stats_engine
  @stats_engine
end

#thread_profiler ⇒ Object (readonly)

begins a thread profile session when instructed by agent commands



76
77
78
 
# File 'lib/new_relic/agent/agent.rb', line 76

def thread_profiler
  @thread_profiler
end

#transaction_sampler ⇒ Object (readonly)

the transaction sampler that handles recording transactions



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

def transaction_sampler
  @transaction_sampler
end

#url_rules ⇒ Object (readonly)

in theory a set of rules applied by the agent to the output of its metrics. Currently unimplemented



87
88
89
 
# File 'lib/new_relic/agent/agent.rb', line 87

def url_rules
  @url_rules
end

Instance Method Details

#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.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/new_relic/agent/agent.rb', line 169

def after_fork(options={})
  @forked = true
  Agent.config.apply_config(NewRelic::Agent::Configuration::ManualSource.new(options), 1)

  # @connected gets false after we fail to connect or have an error
  # connecting.  @connected has nil if we haven't finished trying to connect.
  # or we didn't attempt a connection because this is the master process

  if channel_id = options[:report_to_channel]
    @service = NewRelic::Agent::PipeService.new(channel_id)
    @connected_pid = $$
    @metric_ids = {}
  end

  # log.debug "Agent received after_fork notice in #$$: [#{control.agent_enabled?}; monitor=#{control.monitor_mode?}; connected: #{@connected.inspect}; thread=#{@worker_thread.inspect}]"
  return if !Agent.config[:agent_enabled] ||
    !Agent.config[:monitor_mode] ||
    @connected == false ||
    @worker_thread && @worker_thread.alive?

  log.info "Starting the worker thread in #{$$} after forking."

  # Clear out stats that are left over from parent process
  reset_stats

  # Don't ever check to see if this is a spawner.  If we're in a forked process
  # I'm pretty sure we're not also forking new instances.
  start_worker_thread(options)
  @stats_engine.start_sampler_thread
end

#connected? ⇒ Boolean

Return nil if not yet connected, true if successfully started and false if we failed to start.

Returns:

  • (Boolean) 


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

def connected?
  @connected
end

#end_transaction ⇒ Object

Tells the statistics engine we are ending a transaction



260
261
262
 
# File 'lib/new_relic/agent/agent.rb', line 260

def end_transaction
  @stats_engine.end_transaction
end

#forked? ⇒ Boolean

Returns:

  • (Boolean) 


200
201
202
 
# File 'lib/new_relic/agent/agent.rb', line 200

def forked?
  @forked
end

#log ⇒ Object

Shorthand to the NewRelic::Agent.logger method



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

def log
  NewRelic::Agent.logger
end

#merge_data_from(data) ⇒ Object

Accepts data as provided by the serialize method 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.



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
 
# File 'lib/new_relic/agent/agent.rb', line 814

def merge_data_from(data)
  metrics, transaction_traces, errors = data
  @stats_engine.merge_data(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?(:any?) && errors.any?
    if @unsent_errors
      @unsent_errors = @unsent_errors + errors
    else
      @unsent_errors = errors
    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.



297
298
299
 
# File 'lib/new_relic/agent/agent.rb', line 297

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



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

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/new_relic/agent/agent.rb', line 119

def record_transaction(duration_seconds, options={})
  is_error = options['is_error'] || options['error_message'] || options['exception']
  metric = options['metric']
  metric ||= options['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::Instrumentation::MetricFrame.record_apdex(metric_info, duration_seconds, duration_seconds, is_error)
  end
  metrics = metric_info.summary_metrics

  metrics << metric
  metrics.each do |name|
    stats = stats_engine.get_stats_no_scope(name)
    stats.record_data_point(duration_seconds)
  end

  if is_error
    if options['exception']
      e = options['exception']
    elsif options['error_message']
      e = StandardError.new options['error_message']
    else
      e = StandardError.new 'Unknown Error'
    end
    error_collector.notice_error e, :uri => options['uri'], :metric => metric
  end
  # busy time ?
end

#reset_stats ⇒ Object

Clear out the metric data, errors, and transaction traces, making sure the agent is in a fresh state



482
483
484
485
486
487
488
489
 
# File 'lib/new_relic/agent/agent.rb', line 482

def reset_stats
  @stats_engine.reset_stats
  @unsent_errors = []
  @traces = nil
  @unsent_timeslice_data = {}
  @last_harvest_time = Time.now
  @launch_time = Time.now
end

#serialize ⇒ Object

Serialize all the important data that the agent might want to send to the server. We could be sending this to file ( common in short-running background transactions ) or alternately we could serialize via a pipe or socket to a local aggregation device



799
800
801
802
803
804
805
806
807
 
# File 'lib/new_relic/agent/agent.rb', line 799

def serialize
  accumulator = []
  accumulator[1] = harvest_transaction_traces if @transaction_sampler
  accumulator[2] = harvest_errors if @error_collector
  accumulator[0] = harvest_timeslice_data
  reset_stats
  @metric_ids = {}
  accumulator
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



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

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



276
277
278
279
280
 
# File 'lib/new_relic/agent/agent.rb', line 276

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 before shutting down



221
222
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
 
# File 'lib/new_relic/agent/agent.rb', line 221

def shutdown(options={})
  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

  log.debug "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
    log.error e
    log.error e.backtrace.join("\n")
  end
  NewRelic::Agent.config.remove_config do |config|
    config.class == NewRelic::Agent::Configuration::ManualSource ||
      config.class == NewRelic::Agent::Configuration::ServerSource
  end
  @started = nil
end

#start ⇒ Object

Logs a bunch of data and starts the agent, if needed



469
470
471
472
473
474
475
476
477
478
 
# File 'lib/new_relic/agent/agent.rb', line 469

def start
  return if already_started? || disabled?
  @started = true
  @local_host = determine_host
  log_dispatcher
  log_app_names
  check_config_and_start_agent
  log_version_and_pid
  notify_log_file_location
end

#start_transaction ⇒ Object

Tells the statistics engine we are starting a new transaction



255
256
257
 
# File 'lib/new_relic/agent/agent.rb', line 255

def start_transaction
  @stats_engine.start_transaction
end

#started? ⇒ Boolean

True if we have initialized and completed ‘start’

Returns:

  • (Boolean) 


205
206
207
 
# File 'lib/new_relic/agent/agent.rb', line 205

def started?
  @started
end

#unsent_errors_size ⇒ Object

Returns the length of the unsent errors array, if it exists, otherwise nil



96
97
98
 
# File 'lib/new_relic/agent/agent.rb', line 96

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



108
109
110
111
 
# File 'lib/new_relic/agent/agent.rb', line 108

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



102
103
104
 
# File 'lib/new_relic/agent/agent.rb', line 102

def unsent_traces_size
  @traces.length if @traces
end