wd_newrelic_rpm 3.3.4.1 → 3.5.5

data/test/multiverse/suites/datamapper/encoding_test.rb

@@ -0,0 +1,36 @@
+# https://support.newrelic.com/tickets/2101
+# https://github.com/newrelic/rpm/pull/42
+# https://github.com/newrelic/rpm/pull/45
+require 'test/unit'
+require 'new_relic/agent/instrumentation/data_mapper'
+
+class DatabaseAdapter
+  # we patch in here
+  def log(*args)
+  end
+  include ::NewRelic::Agent::Instrumentation::DataMapperInstrumentation
+end
+
+class EncodingTest < Test::Unit::TestCase
+  # datamapper wants a msg object
+  MSG = Object.new
+  def MSG.query
+    # Contains invalid UTF8 Byte
+    q = "select ICS95095010000000000083320000BS01030000004100+\xFF00000000000000000"
+    if RUBY_VERSION >= '1.9'
+      # Force the query to an invalid encoding
+      q.force_encoding 'UTF-8'
+    end
+    q
+  end
+  def MSG.duration; 1.0; end
+
+  def test_should_not_bomb_out_if_a_query_is_in_an_invalid_encoding
+    if RUBY_VERSION >= '1.9'
+      assert_equal false, MSG.query.valid_encoding?
+    end
+    db = DatabaseAdapter.new
+    db.send(:log, MSG)
+  end
+end
+

data/test/multiverse/suites/logging/Envfile

@@ -0,0 +1,4 @@
+gemfile <<-RB
+  gem 'rack'
+  gem 'mocha', '< 0.13', :require => false
+RB

data/test/multiverse/suites/logging/config/newrelic.yml

@@ -0,0 +1,22 @@
+---
+development:
+  error_collector:
+    capture_source: true
+    enabled: false
+  apdex_t: 0.5
+  ssl: false
+  monitor_mode: true
+  license_key: bootstrap_newrelic_admin_license_key_000
+  developer_mode: false
+  app_name: test
+  host: 127.0.0.1
+  api_host: 127.0.0.1
+  port: 30303
+  transaction_tracer:
+    record_sql: obfuscated
+    enabled: true
+    stack_trace_threshold: 0.5
+    transaction_threshold: 1.0
+  capture_params: false
+  log_level: debug
+  disable_serialization: false

data/test/multiverse/suites/logging/logging_test.rb

@@ -0,0 +1,143 @@
+# RUBY-980 Improve logging
+# This test suite is for checking IMPORTANT conditions that we log rather than
+# trying to do this via brittle unit tests
+
+require 'logger'
+require 'newrelic_rpm'
+require 'fake_collector'
+require 'mocha'
+
+class LoggingTest < Test::Unit::TestCase
+
+  def test_logs_app_name
+    running_agent_writes_to_log( 
+       {:app_name => "My App"},
+       "Application: My App")
+  end
+
+  def test_logs_error_with_bad_app_name
+    running_agent_writes_to_log( 
+       {:app_name => false},
+        "Unable to determine application name.")
+  end
+
+  def test_logs_dispatcher
+    dispatcher = "Y U NO SERVER WEBPAGE"
+
+    running_agent_writes_to_log(
+      {:dispatcher => dispatcher},
+      dispatcher)
+  end
+
+  def test_logs_missing_dispatcher
+    running_agent_writes_to_log(
+      {:dispatcher => ''},
+      "No dispatcher detected")
+  end
+
+  def test_logs_raw_sql_warning
+    NewRelic::Agent.config.apply_config(:'transaction_tracer.record_sql' => 'obfuscated')
+
+    running_agent_writes_to_log(
+      {:'transaction_tracer.record_sql' => 'raw'},
+      "Agent is configured to send raw SQL to the service")
+  end
+
+  def test_logs_if_sending_errors_on_change
+    NewRelic::Agent.config.apply_config(:'error_collector.enabled' => false)
+
+    running_agent_writes_to_log(
+      {:'error_collector.enabled' => true},
+      "Errors will be sent")
+  end
+
+  def test_logs_if_not_sending_errors_on_change
+    NewRelic::Agent.config.apply_config(:'error_collector.enabled' => true)
+
+    running_agent_writes_to_log(
+      {:'error_collector.enabled' => false},
+      "Errors will not be sent")
+  end
+
+  def test_logs_transaction_tracing_disabled
+    running_agent_writes_to_log(
+      {:'transaction_tracer.enabled' => false},
+      "Transaction traces will not be sent")
+  end
+
+  def test_invalid_license_key
+    with_connect_response(401)
+    running_agent_writes_to_log({},
+      "Visit NewRelic.com to obtain a valid license key")
+  end
+
+  def test_logs_monitor_mode_disabled
+    running_agent_writes_to_log(
+      {:monitor_mode => false },
+      "Agent configured not to send data in this environment.")
+  end
+
+  def test_logs_mising_license_key
+    running_agent_writes_to_log(
+      { :license_key => false },
+      "No license key found in newrelic.yml config.")
+  end
+
+  def test_logs_invalid_license_key
+    running_agent_writes_to_log(
+      { :license_key => 'a' * 30 },
+      "Invalid license key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
+  end
+
+  def test_logs_forking_workers
+    running_agent_writes_to_log(
+      { :dispatcher => :passenger },
+      "Connecting workers after forking.")
+  end
+
+  # Initialization
+  def setup
+    $collector ||= NewRelic::FakeCollector.new
+    $collector.reset
+    $collector.mock['connect'] = [200, {'return_value' => {"agent_run_id" => 666 }}]
+    $collector.run
+
+    NewRelic::Agent.reset_config 
+    NewRelic::Agent.agent = NewRelic::Agent::Agent.new
+    NewRelic::Control.instance(true)
+
+    @logger = NewRelic::Agent::MemoryLogger.new
+    NewRelic::Agent.logger = @logger
+    NewRelic::Agent::AgentLogger.stubs(:new).with(any_parameters).returns(@logger)
+  end
+
+  def teardown
+    $collector.reset
+  end
+
+  # Helpers
+  def running_agent_writes_to_log(options, msg)
+    run_agent_with(options) do
+      saw?(msg)
+    end
+  end
+
+  def with_connect_response(status=200, response={})
+    $collector.mock['connect'] = [status, response]
+  end
+
+  def run_agent_with(options = {})
+    NewRelic::Agent.manual_start(options)
+    NewRelic::Agent.shutdown
+    yield
+  end
+
+  def saw?(*expected_messages)
+    flattened = @logger.messages.flatten
+    expected_messages.each do |expected|
+      found = flattened.any? {|msg| msg.to_s.include?(expected)}
+      @logger.messages.each {|msg| puts msg.inspect} if !found
+      assert(found, "Didn't see message '#{expected}'")
+    end
+  end
+end

data/test/multiverse/suites/monitor_mode_false/Envfile

@@ -0,0 +1,2 @@
+self.newrelic_gemfile_options=(':require => false')
+

data/test/multiverse/suites/monitor_mode_false/config/newrelic.yml

@@ -0,0 +1,25 @@
+development:
+  browser_monitoring:
+    auto_instrument: true
+  error_collector:
+    capture_source: true
+    enabled: true
+  apdex_t: 0.5
+  ssl: false
+  monitor_mode: false
+  license_key: bootstrap_newrelic_admin_license_key_000
+  developer_mode: false
+  app_name: test
+  host: staging-collector.newrelic.com
+  api_host: 127.0.0.1
+  port: 80
+  transaction_tracer:
+    record_sql: obfuscated
+    enabled: true
+    stack_trace_threshold: 0.5
+    transaction_threshold: 1.0
+  capture_params: false
+  log_level: debug
+  disable_serialization: false
+  log_file_name: mon_mode_false_newrelic.log
+  agent_enabled: false

data/test/multiverse/suites/monitor_mode_false/no_dns_resolv.rb

@@ -0,0 +1,29 @@
+require 'resolv'
+
+class NoDnsResolv < Test::Unit::TestCase
+  def test_should_no_resolve_hostname_when_agent_is_disabled
+    Resolv.class_eval do
+
+      if RUBY_VERSION == '1.9.2'
+        class_variable_set(:@@getaddress_called,false)
+      else
+        @@getaddress_called = false
+      end
+
+      def self.getaddress(host)
+        @@getaddress_called = true
+        puts "address for #{host} requested"
+        "127.0.0.1"
+      end
+
+      def self.getaddress_called?
+        @@getaddress_called
+      end
+    end
+
+    require 'newrelic_rpm'
+
+    assert(!Resolv.getaddress_called?,
+          'called Resolv.getaddress when we should not have')
+  end
+end

data/test/multiverse/suites/no_load/Envfile

@@ -0,0 +1,2 @@
+self.newrelic_gemfile_options=(':require => false')
+

data/test/multiverse/suites/no_load/config/newrelic.yml

@@ -0,0 +1,22 @@
+---
+development:
+  error_collector:
+    capture_source: true
+    enabled: true
+  apdex_t: 0.5
+  ssl: false
+  monitor_mode: true
+  license_key: bootstrap_newrelic_admin_license_key_000
+  developer_mode: false
+  app_name: test
+  host: 127.0.0.1
+  api_host: 127.0.0.1
+  port: 30303
+  transaction_tracer:
+    record_sql: raw
+    enabled: true
+    stack_trace_threshold: 0.5
+    transaction_threshold: 1.0
+  capture_params: false
+  log_level: debug
+  disable_serialization: false

data/test/multiverse/suites/no_load/start_up_test.rb

@@ -0,0 +1,14 @@
+# RUBY-839 make sure there is no STDOUT chatter
+require 'open3'
+
+class StartUpTest < Test::Unit::TestCase
+  def test_should_not_print_to_stdout_when_logging_available
+    ruby = 'require "newrelic_rpm"; NewRelic::Agent.manual_start; NewRelic::Agent.shutdown'
+    cmd = "bundle exec ruby -e '#{ruby}'"
+
+    sin, sout, serr = Open3.popen3(cmd)
+
+    jruby_noise = "JRuby limited openssl loaded. http://jruby.org/openssl\ngem install jruby-openssl for full support.\n"
+    assert_equal '', (sout.read + serr.read).sub(jruby_noise, '')
+  end
+end

data/test/multiverse/suites/rails_3_error_tracing/Envfile

@@ -0,0 +1,15 @@
+suite_condition("Rails 3 does not support 1.8.6") do
+  RUBY_VERSION != '1.8.6'
+end
+
+gemfile <<-RB
+  gem 'rails', '~>3.2.0'
+RB
+
+gemfile <<-RB
+  gem 'rails', '~>3.1.0'
+RB
+
+gemfile <<-RB
+  gem 'rails', '~>3.0.0'
+RB

data/test/multiverse/suites/rails_3_error_tracing/config/newrelic.yml

@@ -0,0 +1,165 @@
+#
+# This file configures the NewRelic RPM Agent, NewRelic RPM monitors Rails 
+# applications with deep visibility and low overhead.  For more information, 
+# visit www.newrelic.com.
+#
+# 
+#
+# here are the settings that are common to all environments
+common: &default_settings
+
+  # ============================== LICENSE KEY ===============================
+  # You must specify the licence key associated with your New Relic account.
+  # This key binds your Agent's data to your account in the New Relic RPM service.
+
+  #license_key: 'bootstrap_newrelic_admin_license_key_000'
+  #host: localhost
+  #port: 3000
+
+  license_key: 'bd0e1d52adade840f7ca727d29a86249e89a6f1c'
+  host: localhost
+
+  # Agent Enabled
+  # Use this setting to force the agent to run or not run.
+  # Default is 'auto' which means the agent will install and run only if a
+  # valid dispatcher such as Mongrel is running.  This prevents it from running
+  # with Rake or the console.  Set to false to completely turn the agent off
+  # regardless of the other settings.  Valid values are true, false and auto.
+  # agent_enabled: auto
+  
+  # Application Name
+  # Set this to be the name of your application as you'd like it show up in RPM.
+  # RPM will then auto-map instances of your application into a RPM "application"
+  # on your home dashboard page. This setting does not prevent you from manually
+  # defining applications.
+  app_name: Rails 3 view test ap
+
+  # When 'enabled' is turned on, the agent collects performance data by inserting lightweight
+  # tracers on key methods inside the rails framework and asynchronously aggregating
+  # and reporting this performance data to the NewRelic RPM service at newrelic.com.
+  enabled: false
+
+  # The newrelic agent generates its own log file to keep its logging information
+  # separate from that of your application.  Specify its log level here.
+  log_level: debug
+  
+  # The newrelic agent communicates with the RPM service via http by default.
+  # If you want to communicate via https to increase security, then turn on
+  # SSL by setting this value to true.  Note, this will result in increased
+  # CPU overhead to perform the encryption involved in SSL communication, but this
+  # work is done asynchronously to the threads that process your application code, so
+  # it should not impact response times.
+  ssl: false
+  
+  # Set your application's Apdex threshold value with the 'apdex_t' setting, in seconds. The
+  # apdex_t value determines the buckets used to compute your overall Apdex score. Requests
+  # that take less than apdex_t seconds to process will be classified as Satisfying transactions;
+  # more than apdex_t seconds as Tolerating transactions; and more than four times the apdex_t 
+  # value as Frustrating transactions. For more
+  # about the Apdex standard, see http://support.newrelic.com/faqs/general/apdex
+  apdex_t: 1.0
+    
+
+  # Proxy settings for connecting to the RPM server.
+  #
+  # If a proxy is used, the host setting is required.  Other settings are optional.  Default
+  # port is 8080.
+  #
+  # proxy_host: hostname
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+  
+  # Tells transaction tracer and error collector (when enabled) whether or not to capture HTTP params. 
+  # When true, the RoR filter_parameter_logging mechanism is used so that sensitive parameters are not recorded
+  capture_params: true
+
+
+  # Transaction tracer captures deep information about slow
+  # transactions and sends this to the RPM service once a minute. Included in the
+  # transaction is the exact call sequence of the transactions including any SQL statements
+  # issued.
+  transaction_tracer:
+  
+    # Transaction tracer is enabled by default. Set this to false to turn it off. This feature
+    # is only available at the Silver and above product levels.
+    enabled: true
+    
+    # Threshold in seconds for when to collect a transaction trace. When the response time of
+    # a controller action exceeds this threshold, a transaction trace will be recorded and sent
+    # to RPM. Valid values are any float value, or (default) "apdex_f", which will use the
+    # threshold for an dissatisfying Apdex controller action - four times the Apdex T value.
+    transaction_threshold: apdex_f
+ 
+    # When transaction tracer is on, SQL statements can optionally be recorded. The recorder
+    # has three modes, "off" which sends no SQL, "raw" which sends the SQL statement in its 
+    # original form, and "obfuscated", which strips out numeric and string literals
+    record_sql: obfuscated
+    
+    # Threshold in seconds for when to collect stack trace for a SQL call. In other words, 
+    # when SQL statements exceed this threshold, then capture and send to RPM the current
+    # stack trace. This is helpful for pinpointing where long SQL calls originate from  
+    stack_trace_threshold: 0.500
+  
+  # Error collector captures information about uncaught exceptions and sends them to RPM for
+  # viewing
+  error_collector:
+    
+    # Error collector is enabled by default. Set this to false to turn it off. This feature
+    # is only available at the Silver and above product levels
+    enabled: true
+    
+    # Tells error collector whether or not to capture a source snippet around the place of the
+    # error when errors are View related.
+    capture_source: true    
+    
+    # To stop specific errors from reporting to RPM, set this property to comma separated 
+    # values
+    #
+    #ignore_errors: ActionController::RoutingError, ...
+    ignore_errors: IgnoredError
+
+  # (Advanced) Uncomment this to ensure the cpu and memory samplers won't run.  Useful when you
+  # are using the agent to monitor an external resource
+  # disable_samplers: true
+
+# override default settings based on your application's environment
+
+# NOTE if your application has other named environments, you should
+# provide newrelic conifguration settings for these enviromnents here.
+
+development:
+  <<: *default_settings
+  # turn off communication to RPM service in development mode.
+  # NOTE: for initial evaluation purposes, you may want to temporarily turn
+  # the agent on in development mode.
+  enabled: true
+
+  # When running in Developer Mode, the New Relic Agent will present 
+  # performance information on the last 100 transactions you have 
+  # executed since starting the mongrel.  to view this data, go to 
+  # http://localhost:3000/newrelic
+  developer: true
+
+test:
+  <<: *default_settings
+  # it almost never makes sense to turn on the agent when running unit, functional or
+  # integration tests or the like.
+  enabled: true
+  log_level: debug
+
+# Turn on the agent in production for 24x7 monitoring.  NewRelic testing shows
+# an average performance impact of < 5 ms per transaction, you you can leave this on
+# all the time without incurring any user-visible performance degredation.
+production:
+  <<: *default_settings
+  enabled: true
+
+# many applications have a staging environment which behaves identically to production.
+# Support for that environment is provided here.  By default, the staging environment has
+# the agent turned on.
+staging:
+  <<: *default_settings
+  enabled: true
+  app_name: My Application (Staging)