Module: NewRelic::Agent::Agent::InstanceMethods::Connect

Included in:
NewRelic::Agent::Agent::InstanceMethods
Defined in:
lib/new_relic/agent/agent.rb

Overview

This module is an artifact of a refactoring of the connect method - all of its methods are used in that context, so it can be refactored at will. It should be fully tested

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#connect_attempts ⇒ Object

number of attempts we’ve made to contact the server



599
600
601
 
# File 'lib/new_relic/agent/agent.rb', line 599

def connect_attempts
  @connect_attempts
end

#connect_retry_period ⇒ Object

the frequency with which we should try to connect to the server at the moment.



597
598
599
 
# File 'lib/new_relic/agent/agent.rb', line 597

def connect_retry_period
  @connect_retry_period
end

Instance Method Details

#apdex_f ⇒ Object

apdex_f is always 4 times the apdex_t



791
792
793
 
# File 'lib/new_relic/agent/agent.rb', line 791

def apdex_f
  (4 * NewRelic::Control.instance.apdex_t).to_f
end

#apdex_f_threshold? ⇒ Boolean

If the transaction threshold is set to the string ‘apdex_f’, we use 4 times the apdex_t value to record transactions. This gears well with using apdex since you will attempt to send any transactions that register as ‘failing’

Returns:

  • (Boolean) 


799
800
801
 
# File 'lib/new_relic/agent/agent.rb', line 799

def apdex_f_threshold?
  @transaction_sampler.config.fetch('transaction_threshold', '') =~ /apdex_f/i
end

#config_transaction_tracer ⇒ Object

this entire method should be done on the transaction sampler object, rather than here. We should pass in the sampler config.



754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/new_relic/agent/agent.rb', line 754

def config_transaction_tracer
  # Reconfigure the transaction tracer
  @transaction_sampler.configure!
  @sql_sampler.configure!
  @should_send_samples = @config_should_send_samples = @transaction_sampler.config.fetch('enabled', true)
  @should_send_random_samples = @transaction_sampler.config.fetch('random_sample', false)
  set_sql_recording!

  # default to 2.0, string 'apdex_f' will turn into your
  # apdex * 4
  @slowest_transaction_threshold = @transaction_sampler.config.fetch('transaction_threshold', 2.0).to_f
  @slowest_transaction_threshold = apdex_f if apdex_f_threshold?
end

#configure_error_collector!(server_enabled) ⇒ Object

Configures the error collector if the server says that we are allowed to send errors. Pretty simple, and logs at debug whether errors will or will not be sent.



724
725
726
727
728
729
730
731
732
733
734
 
# File 'lib/new_relic/agent/agent.rb', line 724

def configure_error_collector!(server_enabled)
  # Reinitialize the error collector
  @error_collector = NewRelic::Agent::ErrorCollector.new
  # Ask for permission to collect error data
  enabled = if error_collector.config_enabled && server_enabled
              error_collector.enabled = true
            else
              error_collector.enabled = false
            end
  log.debug "Errors will #{enabled ? '' : 'not '}be sent to the New Relic service."
end

#configure_transaction_tracer!(server_enabled, sample_rate) ⇒ Object

Enables or disables the transaction tracer and sets its options based on the options provided to the method.



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
 
# File 'lib/new_relic/agent/agent.rb', line 771

def configure_transaction_tracer!(server_enabled, sample_rate)
  # Ask the server for permission to send transaction samples.
  # determined by subscription license.
  @transaction_sampler.config['enabled'] = server_enabled
  @sql_sampler.configure!
  @should_send_samples = @config_should_send_samples && server_enabled
  
  if @should_send_samples
    # I don't think this is ever true, but...
    enable_random_samples!(sample_rate) if @should_send_random_samples
    
    @transaction_sampler.slow_capture_threshold = @slowest_transaction_threshold
    
    log.debug "Transaction tracing threshold is #{@slowest_transaction_threshold} seconds."
  else
    log.debug "Transaction traces will not be sent to the New Relic service."
  end
end

#connect_settings ⇒ Object

Initializes the hash of settings that we send to the server. Returns a literal hash containing the options



700
701
702
703
704
705
706
707
708
709
710
711
 
# File 'lib/new_relic/agent/agent.rb', line 700

def connect_settings
  {
    :pid => $$,
    :host => @local_host,
    :app_name => control.app_names,
    :language => 'ruby',
    :agent_version => NewRelic::VERSION::STRING,
    :environment => environment_for_connect,
    :settings => control.settings,
    :validate => validate_settings
  }
end

#connect_to_server ⇒ Object

Does some simple logging to make sure that our seed and token for verification are correct, then returns the connect data passed back from the server



716
717
718
719
 
# File 'lib/new_relic/agent/agent.rb', line 716

def connect_to_server
  log_seed_token
  @service.connect(connect_settings)
end

#disconnect ⇒ Object

Disconnect just sets connected to false, which prevents the agent from trying to connect again



603
604
605
606
 
# File 'lib/new_relic/agent/agent.rb', line 603

def disconnect
  @connected = false
  true
end

#enable_random_samples!(sample_rate) ⇒ Object

Random sampling is enabled based on a sample rate, which is the n in “every 1/n transactions is added regardless of its length”.

uses a sane default for sampling rate if the sampling rate is zero, since the collector currently sends ‘0’ as a sampling rate for all accounts, which is probably for legacy reasons



744
745
746
747
748
749
 
# File 'lib/new_relic/agent/agent.rb', line 744

def enable_random_samples!(sample_rate)
  sample_rate = 10 unless sample_rate.to_i > 0
  @transaction_sampler.random_sampling = true
  @transaction_sampler.sampling_rate = sample_rate
  log.info "Transaction sampling enabled, rate = #{@transaction_sampler.sampling_rate}"
end

#environment_for_connect ⇒ Object

Checks whether we should send environment info, and if so, returns the snapshot from the local environment



683
684
685
 
# File 'lib/new_relic/agent/agent.rb', line 683

def environment_for_connect
  control['send_environment_info'] != false ? control.local_env.snapshot : []
end

#finish_setup(config_data) ⇒ Object

Takes a hash of configuration data returned from the server and uses it to set local variables and to initialize various parts of the agent that are configured separately.

Can accommodate most arbitrary data - anything extra is ignored unless we say to do something with it here.



855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/new_relic/agent/agent.rb', line 855

def finish_setup(config_data)
  return if config_data == nil
  @service.agent_id = config_data['agent_run_id']
  @report_period = config_data['data_report_period']
  @url_rules = config_data['url_rules']
  @beacon_configuration = BeaconConfiguration.new(config_data)
  @server_side_config_enabled = config_data['listen_to_server_config']

  if @server_side_config_enabled
    log.info "Using config from server"
    log.debug "Server provided config: #{config_data.inspect}"
  end

  control.merge_server_side_config(config_data) if @server_side_config_enabled
  config_transaction_tracer
  log_connection!(config_data)
  configure_transaction_tracer!(config_data['collect_traces'], config_data['sample_rate'])
  configure_error_collector!(config_data['collect_errors'])
end

#get_retry_period ⇒ Object

Retry period is a minute for each failed attempt that we’ve made. This should probably do some sort of sane TCP backoff to prevent hammering the server, but a minute for each attempt seems to work reasonably well.



625
626
627
628
 
# File 'lib/new_relic/agent/agent.rb', line 625

def get_retry_period
  return 600 if self.connect_attempts > 6
  connect_attempts * 60
end

#handle_license_error(error) ⇒ Object

When the server sends us an error with the license key, we want to tell the user that something went wrong, and let them know where to go to get a valid license key

After this runs, it disconnects the agent so that it will no longer try to connect to the server, saving the application and the server load



666
667
668
669
670
 
# File 'lib/new_relic/agent/agent.rb', line 666

def handle_license_error(error)
  log.error error.message
  log.info "Visit NewRelic.com to obtain a valid license key, or to upgrade your account."
  disconnect
end

#increment_retry_period! ⇒ Object

:nodoc:



630
631
632
 
# File 'lib/new_relic/agent/agent.rb', line 630

def increment_retry_period! #:nodoc:
  self.connect_retry_period=(get_retry_period)
end

#log_connection!(config_data) ⇒ Object

Logs when we connect to the server, for debugging purposes

  • makes sure we know if an agent has not connected



877
878
879
880
881
 
# File 'lib/new_relic/agent/agent.rb', line 877

def log_connection!(config_data)
  control.log! "Connected to NewRelic Service at #{@service.collector.name}"
  log.debug "Agent Run       = #{@service.agent_id}."
  log.debug "Connection data = #{config_data.inspect}"
end

#log_error(error) ⇒ Object

When we have a problem connecting to the server, we need to tell the user what happened, since this is not an error we can handle gracefully.



654
655
656
657
 
# File 'lib/new_relic/agent/agent.rb', line 654

def log_error(error)
  log.error "Error establishing connection with New Relic Service at #{control.server}: #{error.message}"
  log.debug error.backtrace.join("\n")
end

#log_seed_token ⇒ Object

If we are using a seed and token to validate the agent, we should debug log that fact so that debug logs include a clue that token authentication is what will be used



675
676
677
678
679
 
# File 'lib/new_relic/agent/agent.rb', line 675

def log_seed_token
  if control.validate_seed
    log.debug "Connecting with validation seed/token: #{control.validate_seed}/#{control.validate_token}"
  end
end

#log_sql_transmission_warning? ⇒ Boolean

Warn the user when we are sending raw sql across the wire

  • they should probably be using ssl when this is true

Returns:

  • (Boolean) 


827
828
829
 
# File 'lib/new_relic/agent/agent.rb', line 827

def log_sql_transmission_warning?
  log.warn("Agent is configured to send raw SQL to the service") if @record_sql == :raw
end

#query_server_for_configuration ⇒ Object

Sets the collector host and connects to the server, then invokes the final configuration with the returned data



844
845
846
 
# File 'lib/new_relic/agent/agent.rb', line 844

def query_server_for_configuration
  finish_setup(connect_to_server)
end

#set_sql_recording! ⇒ Object

Sets the sql recording configuration by trying to detect any attempt to disable the sql collection - ‘off’, ‘false’, ‘none’, and friends. Otherwise, we accept ‘raw’, and unrecognized values default to ‘obfuscated’



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/new_relic/agent/agent.rb', line 807

def set_sql_recording!
  record_sql_config = @transaction_sampler.config.fetch('record_sql', :obfuscated)
  case record_sql_config.to_s
  when 'off'
    @record_sql = :off
  when 'none'
    @record_sql = :off
  when 'false'
    @record_sql = :off
  when 'raw'
    @record_sql = :raw
  else
    @record_sql = :obfuscated
  end

  log_sql_transmission_warning?
end

#should_keep_retrying?(options) ⇒ Boolean

We keep trying by default, but you can disable it with the :keep_retrying option set to false

Returns:

  • (Boolean) 


617
618
619
 
# File 'lib/new_relic/agent/agent.rb', line 617

def should_keep_retrying?(options)
  @keep_retrying = (options[:keep_retrying].nil? || options[:keep_retrying])
end

#should_retry? ⇒ Boolean

We should only retry when there has not been a more serious condition that would prevent it. We increment the connect attempts and the retry period, to prevent constant connection attempts, and tell the user what we’re doing by logging.

Returns:

  • (Boolean) 


639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/new_relic/agent/agent.rb', line 639

def should_retry?
  if @keep_retrying
    self.connect_attempts=(connect_attempts + 1)
    increment_retry_period!
    log.info "Will re-attempt in #{connect_retry_period} seconds"
    true
  else
    disconnect
    false
  end
end

#tried_to_connect?(options) ⇒ Boolean

We’ve tried to connect if @connected is not nil, or if we are forcing reconnection (i.e. in the case of an after_fork with long running processes)

Returns:

  • (Boolean) 


611
612
613
 
# File 'lib/new_relic/agent/agent.rb', line 611

def tried_to_connect?(options)
  !(@connected.nil? || options[:force_reconnect])
end

#validate_settings ⇒ Object

These validation settings are used for cases where a dynamic server is spun up for clients - partners can include a seed and token to indicate that the host is allowed to connect, rather than setting a unique hostname



691
692
693
694
695
696
 
# File 'lib/new_relic/agent/agent.rb', line 691

def validate_settings
  {
    :seed => control.validate_seed,
    :token => control.validate_token
  }
end