mmtrix_rpm 1.0.0.1

data/test/mmtrix/agent/configuration/server_source_test.rb

@@ -0,0 +1,202 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','test_helper'))
+require 'mmtrix/agent/configuration/server_source'
+
+module Mmtrix::Agent::Configuration
+  class ServerSourceTest < Minitest::Test
+    def setup
+      config = {
+        'agent_config' => {
+          'slow_sql.enabled'                         => true,
+          'transaction_tracer.transaction_threshold' => 'apdex_f',
+          'transaction_tracer.record_sql'            => 'raw',
+          'error_collector.enabled'                  => true
+        },
+        'apdex_t'                => 1.0,
+        'collect_errors'         => false,
+        'collect_traces'         => true,
+        'web_transactions_apdex' => { 'Controller/some/txn' => 1.5 }
+      }
+      @source = ServerSource.new(config)
+    end
+
+    def test_should_set_apdex_t
+      assert_equal 1.0, @source[:apdex_t]
+    end
+
+    def test_should_set_agent_config_values
+      assert_equal 'raw', @source[:'transaction_tracer.record_sql']
+    end
+
+    def test_should_not_dot_the_agent_config_sub_hash
+      assert_nil @source[:'agent_config.slow_sql.enabled']
+    end
+
+    def test_should_enable_tracer_as_configured
+      assert @source[:'slow_sql.enabled']
+    end
+
+    def test_should_disable_tracer_as_configured
+      assert !@source[:'error_collector.enabled']
+    end
+
+    def test_should_ignore_apdex_f_setting_for_transaction_threshold
+      assert_equal nil, @source[:'transaction_tracer.transaction_threshold']
+    end
+
+    def test_should_not_dot_the_web_transactions_apdex_hash
+      assert_equal 1.5, @source[:web_transactions_apdex]['Controller/some/txn']
+    end
+
+    def test_should_disable_gated_features_when_server_says_to
+      rsp = {
+        'collect_errors' => false,
+        'collect_traces' => false,
+        'collect_analytics_events' => false,
+        'collect_custom_events'    => false
+      }
+      existing_config = {
+        :'error_collector.enabled'        => true,
+        :'slow_sql.enabled'               => true,
+        :'transaction_tracer.enabled'     => true,
+        :'analytics_events.enabled'       => true,
+        :'custom_insights_events.enabled' => true
+      }
+      @source = ServerSource.new(rsp, existing_config)
+      refute @source[:'error_collector.enabled']
+      refute @source[:'slow_sql.enabled']
+      refute @source[:'transaction_tracer.enabled']
+      refute @source[:'analytics_events.enabled']
+      refute @source[:'custom_insights_events.enabled']
+    end
+
+    def test_should_enable_gated_features_when_server_says_to
+      rsp = {
+        'collect_errors' => true,
+        'collect_traces' => true,
+        'collect_analytics_events' => true,
+        'collect_custom_events'    => true
+      }
+      existing_config = {
+        :'error_collector.enabled'        => true,
+        :'slow_sql.enabled'               => true,
+        :'transaction_tracer.enabled'     => true,
+        :'analytics_events.enabled'       => true,
+        :'custom_insights_events.enabled' => true
+      }
+      @source = ServerSource.new(rsp, existing_config)
+      assert @source[:'error_collector.enabled']
+      assert @source[:'slow_sql.enabled']
+      assert @source[:'transaction_tracer.enabled']
+      assert @source[:'analytics_events.enabled']
+      assert @source[:'custom_insights_events.enabled']
+    end
+
+    def test_should_allow_manual_disable_of_gated_features
+      rsp = {
+        'collect_errors' => true,
+        'collect_traces' => true,
+        'collect_analytics_events' => true
+      }
+      existing_config = {
+        :'error_collector.enabled'    => false,
+        :'slow_sql.enabled'           => false,
+        :'transaction_tracer.enabled' => false,
+        :'analytics_events.enabled'   => false
+      }
+      @source = ServerSource.new(rsp, existing_config)
+      assert !@source[:'error_collector.enabled']
+      assert !@source[:'slow_sql.enabled']
+      assert !@source[:'transaction_tracer.enabled']
+      assert !@source[:'analytics_events.enabled']
+    end
+
+    def test_should_enable_gated_features_when_server_says_yes_and_existing_says_no
+      rsp = {
+        'collect_errors' => true,
+        'collect_traces' => true,
+        'collect_analytics_events' => true,
+        'collect_custom_events'    => true,
+        'agent_config' => {
+          'transaction_tracer.enabled'     => true,
+          'slow_sql.enabled'               => true,
+          'error_collector.enabled'        => true,
+          'analytics_events.enabled'       => true,
+          'custom_insights_events.enabled' => true
+        }
+      }
+      existing_config = {
+        :'error_collector.enabled'        => false,
+        :'slow_sql.enabled'               => false,
+        :'transaction_tracer.enabled'     => false,
+        :'analytics_events.enabled'       => false,
+        :'custom_insights_events.enabled' => false
+      }
+      @source = ServerSource.new(rsp, existing_config)
+      assert @source[:'error_collector.enabled']
+      assert @source[:'slow_sql.enabled']
+      assert @source[:'transaction_tracer.enabled']
+      assert @source[:'analytics_events.enabled']
+    end
+
+    def test_should_not_gate_when_gating_keys_absent
+      rsp = {
+        'agent_config' => {
+          'transaction_tracer.enabled'     => true,
+          'slow_sql.enabled'               => true,
+          'error_collector.enabled'        => true,
+          'analytics_events.enabled'       => true,
+          'custom_insights_events.enabled' => true
+        }
+      }
+      @source = ServerSource.new(rsp, {})
+      assert @source[:'error_collector.enabled']
+      assert @source[:'slow_sql.enabled']
+      assert @source[:'transaction_tracer.enabled']
+      assert @source[:'analytics_events.enabled']
+      assert @source[:'custom_insights_events.enabled']
+    end
+
+    def test_should_strip_non_ssc_keys
+      rsp = {
+        'agent_config' => {
+          'attributes.include' => 'foo,bar',
+          'slow_sql.explain_threshold' => 42
+        }
+      }
+
+      source = ServerSource.new(rsp, {})
+      refute_includes source.keys, :'attributes.include'
+      assert_includes source.keys, :'slow_sql.explain_threshold'
+    end
+
+    def test_should_strip_unrecognized_keys_in_agent_config_hash
+      rsp = {
+        'agent_config' => {
+          'platypus' => 'mammal'
+        }
+      }
+
+      source = ServerSource.new(rsp, {})
+      refute_includes source.keys, :platypus
+    end
+
+    def test_should_not_merge_in_keys_that_are_not_allowed_at_top_level
+      rsp = {
+        'slow_sql.explain_threshold' => 42
+      }
+      source = ServerSource.new(rsp, {})
+      refute_includes source.keys, :'slow_sql.explain_threshold'
+    end
+
+    def test_all_top_level_keys_should_be_allowed_from_server
+      ServerSource::TOP_LEVEL_KEYS.each do |key|
+        assert DEFAULTS[key.to_sym], "Did not find entry in config DEFAULTS hash for to-level server config key #{key}"
+        assert DEFAULTS[key.to_sym][:allowed_from_server], "Expected top-level server config key #{key} to be allowed from server"
+      end
+    end
+  end
+end

data/test/mmtrix/agent/configuration/yaml_source_test.rb

@@ -0,0 +1,117 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','..','test_helper'))
+require 'mmtrix/agent/configuration/yaml_source'
+
+module Mmtrix::Agent::Configuration
+  class YamlSourceTest < Minitest::Test
+    def setup
+      @test_yml_path = File.expand_path(File.join(File.dirname(__FILE__),
+                                                 '..','..','..',
+                                                 'config','mmtrix.yml'))
+      @source = YamlSource.new(@test_yml_path, 'test')
+    end
+
+    def test_should_load_given_yaml_file
+      assert_equal '127.0.0.1', @source[:api_host]
+    end
+
+    def test_should_apply_erb_transformations
+      assert_equal 'heyheyhey', @source[:erb_value]
+      assert_equal '', @source[:message]
+      assert_equal '', @source[:license_key]
+    end
+
+    def test_config_booleans
+      assert_equal true, @source[:tval]
+      assert_equal false, @source[:fval]
+      assert_nil @source[:not_in_yaml_val]
+      assert_equal true, @source[:yval]
+      assert_equal 'sure', @source[:sval]
+    end
+
+    def test_appnames
+      assert_equal %w[a b c], @source[:app_name]
+    end
+
+    def test_should_load_the_config_for_the_correct_env
+      refute_equal 'the.wrong.host', @source[:host]
+    end
+
+    def test_should_convert_to_dot_notation
+      assert_equal 'raw', @source[:'transaction_tracer.record_sql']
+    end
+
+    def test_should_still_have_nested_hashes_around
+      refute_nil @source[:transaction_tracer]
+    end
+
+    def test_should_ignore_apdex_f_setting_for_transaction_threshold
+      assert_equal nil, @source[:'transaction_tracer.transaction_threshold']
+    end
+
+    def test_should_correctly_handle_floats
+      assert_equal 1.1, @source[:apdex_t]
+    end
+
+    def test_should_not_log_error_by_default
+      expects_no_logging(:error)
+      YamlSource.new(@test_yml_path, 'test')
+    end
+
+    def test_should_log_if_no_file_is_found
+      expects_logging(:warn, any_parameters)
+      YamlSource.new('no_such_file.yml', 'test')
+    end
+
+    def test_should_log_if_environment_is_not_present
+      expects_logging(:error, includes(@test_yml_path))
+      YamlSource.new(@test_yml_path, 'nonsense')
+    end
+
+    def test_should_not_fail_to_log_missing_file_during_startup
+      without_logger do
+        ::Mmtrix::Agent::StartupLogger.any_instance.expects(:warn)
+        YamlSource.new('no_such_file.yml', 'test')
+      end
+    end
+
+    def test_should_not_fail_to_log_invalid_file_during_startup
+      without_logger do
+        ::Mmtrix::Agent::StartupLogger.any_instance.expects(:error)
+
+        File.stubs(:exist?).returns(true)
+        File.stubs(:read).raises(StandardError.new("boo"))
+
+        YamlSource.new('fake.yml', 'test')
+      end
+    end
+
+    def test_should_mark_error_on_read_as_failure
+      File.stubs(:exist?).returns(true)
+      File.stubs(:read).raises(StandardError.new("boo"))
+
+      source = YamlSource.new('fake.yml', 'test')
+      assert source.failed?
+    end
+
+    def test_should_mark_erb_error_as_failure
+      ERB.stubs(:new).raises(StandardError.new("boo"))
+
+      source = YamlSource.new(@test_yml_path, 'test')
+      assert source.failed?
+    end
+
+    def test_should_mark_missing_section_as_failure
+      source = YamlSource.new(@test_yml_path, 'yolo')
+      assert source.failed?
+    end
+
+    def test_failure_should_include_message
+      source = YamlSource.new(@test_yml_path, 'yolo')
+      assert_includes source.failures.flatten.join(' '), 'yolo'
+    end
+  end
+end

data/test/mmtrix/agent/cross_app_monitor_test.rb

@@ -0,0 +1,248 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper'))
+
+module Mmtrix::Agent
+  class CrossAppMonitorTest < Minitest::Test
+    MMTRIX_ID_HEADER        = Mmtrix::Agent::CrossAppMonitor::MMTRIX_ID_HEADER_KEY
+    MMTRIX_TXN_HEADER       = Mmtrix::Agent::CrossAppMonitor::MMTRIX_TXN_HEADER_KEY
+    CONTENT_LENGTH_KEY        = "HTTP_CONTENT_LENGTH"
+
+    AGENT_CROSS_APP_ID        = "qwerty"
+    REQUEST_CROSS_APP_ID      = "42#1234"
+    TRANSACTION_GUID          = '941B0E8001E444E8'
+    REF_TRANSACTION_GUID      = '830092CDE59421D4'
+
+    TRANSACTION_NAME          = 'transaction'
+    QUEUE_TIME                = 1000
+    APP_TIME                  = 2000
+
+    ENCODING_KEY_NOOP         = "\0"
+    TRUSTED_ACCOUNT_IDS       = [42,13]
+
+    CROSS_APP_ID_POSITION     = 0
+    TRANSACTION_NAME_POSITION = 1
+    QUEUE_TIME_POSITION       = 2
+    APP_TIME_POSITION         = 3
+    CONTENT_LENGTH_POSITION   = 4
+
+    def setup
+      Mmtrix::Agent.reset_config
+      Mmtrix::Agent.drop_buffered_data
+      @events = Mmtrix::Agent::EventListener.new
+      @response = {}
+
+      @monitor = Mmtrix::Agent::CrossAppMonitor.new(@events)
+      @config = {
+        :cross_process_id       => AGENT_CROSS_APP_ID,
+        :encoding_key           => ENCODING_KEY_NOOP,
+        :trusted_account_ids    => TRUSTED_ACCOUNT_IDS,
+        :disable_harvest_thread => true
+      }
+
+      Mmtrix::Agent.config.add_config_for_testing(@config)
+      @events.notify(:finished_configuring)
+    end
+
+    def teardown
+      Mmtrix::Agent.config.remove_config(@config)
+      Mmtrix::Agent.instance.events.clear
+    end
+
+
+    #
+    # Tests
+    #
+
+    def test_adds_response_header
+      with_default_timings
+
+      when_request_runs
+
+      assert_equal 'WyJxd2VydHkiLCJ0cmFuc2FjdGlvbiIsMTAwMC4wLDIwMDAuMCwtMSwiOTQxQjBFODAwMUU0NDRFOCJd', response_app_data
+      assert_equal [AGENT_CROSS_APP_ID, TRANSACTION_NAME, QUEUE_TIME, APP_TIME, -1, TRANSACTION_GUID], unpacked_response
+    end
+
+    def test_encodes_transaction_name
+      Mmtrix::Agent::TransactionState.any_instance.stubs(:timings).returns(stub(
+          :transaction_name => "\"'goo",
+          :queue_time_in_seconds => QUEUE_TIME,
+          :app_time_in_seconds => APP_TIME))
+
+      when_request_runs
+
+      assert_equal "\"'goo", unpacked_response[TRANSACTION_NAME_POSITION]
+    end
+
+    def test_doesnt_write_response_header_if_id_blank
+      with_default_timings
+
+      when_request_runs(for_id(''))
+      assert_nil response_app_data
+    end
+
+    def test_doesnt_write_response_header_if_untrusted_id
+      with_default_timings
+
+      when_request_runs(for_id("4#1234"))
+      assert_nil response_app_data
+    end
+
+    def test_doesnt_write_response_header_if_improperly_formatted_id
+      with_default_timings
+
+      when_request_runs(for_id("42"))
+      assert_nil response_app_data
+    end
+
+    def test_doesnt_add_header_if_no_id_in_request
+      when_request_runs({})
+      assert_nil response_app_data
+    end
+
+    def test_doesnt_add_header_if_no_id_on_agent
+      with_config( :cross_process_id => '' ) do
+        when_request_runs
+        assert_nil response_app_data
+      end
+    end
+
+    def test_doesnt_add_header_if_config_disabled
+      with_config(:"cross_application_tracer.enabled" => false, :cross_application_tracing => false) do
+        when_request_runs
+        assert_nil response_app_data
+      end
+    end
+
+    def test_doesnt_add_header_if_missing_encoding_key
+      with_config( :encoding_key => '' ) do
+        when_request_runs
+        assert_nil response_app_data
+      end
+    end
+
+    def test_includes_content_length
+      with_default_timings
+
+      when_request_runs(for_id(REQUEST_CROSS_APP_ID).merge(CONTENT_LENGTH_KEY => 3000))
+      assert_equal 3000, unpacked_response[CONTENT_LENGTH_POSITION]
+    end
+
+    def test_finds_content_length_from_headers
+      request = { 'HTTP_CONTENT_LENGTH' => 42 }
+      assert_equal(42, @monitor.content_length_from_request(request))
+    end
+
+    def test_writes_attributes
+      with_default_timings
+
+      txn = when_request_runs
+
+      assert_equal REQUEST_CROSS_APP_ID, attributes_for(txn, :intrinsic)[:client_cross_process_id]
+      assert_equal REF_TRANSACTION_GUID, attributes_for(txn, :intrinsic)[:referring_transaction_guid]
+    end
+
+    def test_writes_metric
+      with_default_timings
+
+      when_request_runs
+
+      assert_metrics_recorded(["ClientApplication/#{REQUEST_CROSS_APP_ID}/all"])
+    end
+
+    def test_doesnt_write_metric_if_id_blank
+      with_default_timings
+
+      when_request_runs(for_id(''))
+
+      assert_metrics_recorded_exclusive(['transaction'])
+    end
+
+    def test_setting_response_headers_freezes_transaction_name
+      in_transaction do
+        request = for_id(REQUEST_CROSS_APP_ID)
+        @events.notify(:before_call, request)
+
+        assert !Mmtrix::Agent::Transaction.tl_current.name_frozen?
+        @events.notify(:after_call, request, [200, @response, ''])
+        assert Mmtrix::Agent::Transaction.tl_current.name_frozen?
+      end
+    end
+
+    def test_listener_in_other_thread_has_correct_txn_state
+      t = Thread.new do
+        in_transaction('transaction') do
+          request = for_id(REQUEST_CROSS_APP_ID)
+
+          @events.notify(:before_call, request)
+          # Fake out our GUID for easier comparison in tests
+          Mmtrix::Agent::Transaction.tl_current.stubs(:guid).returns(TRANSACTION_GUID)
+          @events.notify(:after_call, request, [200, @response, ''])
+        end
+      end
+
+      t.join
+
+      assert_metrics_recorded(["ClientApplication/#{REQUEST_CROSS_APP_ID}/all"])
+    end
+
+    def test_path_hash
+      with_config(:app_name => 'test') do
+        h0 = @monitor.path_hash('23547', 0)
+        h1 = @monitor.path_hash('step1', 0)
+        h2 = @monitor.path_hash('step2', h1.to_i(16))
+        h3 = @monitor.path_hash('step3', h2.to_i(16))
+        h4 = @monitor.path_hash('step4', h3.to_i(16))
+
+        assert_equal("eaaec1df", h0)
+        assert_equal("2e9a0b02", h1)
+        assert_equal("01d3f0eb", h2)
+        assert_equal("9a1b45e5", h3)
+        assert_equal("e9eecfee", h4)
+      end
+    end
+
+    #
+    # Helpers
+    #
+
+    def when_request_runs(request=for_id(REQUEST_CROSS_APP_ID))
+      in_transaction('transaction') do |txn|
+        @events.notify(:before_call, request)
+        # Fake out our GUID for easier comparison in tests
+        Mmtrix::Agent::Transaction.tl_current.stubs(:guid).returns(TRANSACTION_GUID)
+        @events.notify(:after_call, request, [200, @response, ''])
+        txn
+      end
+    end
+
+    def with_default_timings
+      Mmtrix::Agent::TransactionState.any_instance.stubs(:timings).returns(stub(
+          :transaction_name => TRANSACTION_NAME,
+          :queue_time_in_seconds => QUEUE_TIME,
+          :app_time_in_seconds => APP_TIME))
+    end
+
+    def for_id(id)
+      encoded_id = id == "" ? "" : Base64.encode64(id)
+      encoded_txn_info = json_dump_and_encode([ REF_TRANSACTION_GUID, false ])
+
+      return {
+        MMTRIX_ID_HEADER => encoded_id,
+        MMTRIX_TXN_HEADER => encoded_txn_info,
+      }
+    end
+
+    def response_app_data
+      @response['X-Mmtrix-App-Data']
+    end
+
+    def unpacked_response
+      return nil unless response_app_data
+      Mmtrix::JSONWrapper.load(Base64.decode64(response_app_data))
+    end
+
+  end
+end

data/test/mmtrix/agent/cross_app_tracing_test.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+require File.expand_path(File.join(File.dirname(__FILE__),'..','..','test_helper'))
+require 'mmtrix/agent/cross_app_tracing'
+
+module Mmtrix
+  module Agent
+    class CrossAppTracingTest < Minitest::Test
+
+      attr_reader :node, :request, :response
+
+      def setup
+        @node = stub_everything
+        @request = stub_everything(:uri => URI.parse("http://mmtrix.com"),
+                                   :type => "Fake",
+                                   :method => "GET")
+        @response = stub_everything
+        @state = Mmtrix::Agent::TransactionState.tl_get
+      end
+
+      def test_start_trace
+        t0   = Time.now
+        node = CrossAppTracing.start_trace(@state, t0, request)
+        refute_nil node
+      end
+
+      def test_start_trace_has_nil_node_on_agent_failure
+        @state.traced_method_stack.stubs(:push_frame).raises("Boom!")
+        t0      = Time.now
+        node = CrossAppTracing.start_trace(@state, t0, request)
+        assert_nil node
+      end
+
+      def test_finish_trace_treats_nil_start_time_as_agent_error
+        expects_logging(:error, any_parameters)
+        expects_no_pop_frame
+        CrossAppTracing.finish_trace(@state, nil, node, request, response)
+      end
+
+      # Since we log and swallow errors, assert on the logging to ensure these
+      # paths are cleanly accepting nils, not just smothering the exceptions.
+
+      def test_finish_trace_allows_nil_node
+        expects_no_logging(:error)
+        CrossAppTracing.finish_trace(@state, Time.now, nil, request, response)
+      end
+
+      def test_finish_trace_allows_nil_request
+        expects_no_logging(:error)
+        expects_pop_frame
+        CrossAppTracing.finish_trace(@state, Time.now, node, nil, response)
+      end
+
+      def test_finish_trace_allows_nil_response
+        expects_no_logging(:error)
+        expects_pop_frame
+        CrossAppTracing.finish_trace(@state, Time.now, node, request, nil)
+      end
+
+      def expects_pop_frame
+        @state.traced_method_stack.stubs(:pop_frame).once
+      end
+
+      def expects_no_pop_frame
+        @state.traced_method_stack.stubs(:pop_frame).never
+      end
+    end
+  end
+end