mmtrix_rpm 1.0.0.1

data/test/multiverse/suites/agent_only/config/mmtrix.yml

@@ -0,0 +1,27 @@
+---
+development:
+  error_collector:
+    enabled: true
+  apdex_t: 0.24
+  ssl: false
+  monitor_mode: true
+  license_key: bootstrap_mmtrix_admin_license_key_000
+  developer_mode: false
+  app_name: test
+  host: 127.0.0.1
+  api_host: 127.0.0.1
+  port: <%= $collector ||= nil; $collector && $collector.port %>
+  transaction_tracer:
+    record_sql: obfuscated
+    enabled: true
+    stack_trace_threshold: 0.5
+  capture_params: false
+  browser_monitoring:
+    auto_instrument: true
+  labels:
+    Server: Yaml
+
+# A few tests use this in confirming behavior around mis-matched environments
+# Doesn't need to actually support running the agent in production mode.
+production:
+  enabled: false

data/test/multiverse/suites/agent_only/cross_application_tracing_test.rb

@@ -0,0 +1,94 @@
+# 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 'rack/test'
+require 'fake_collector'
+require './testing_app'
+require 'mmtrix/rack/agent_hooks'
+
+class CrossApplicationTracingTest < Minitest::Test
+  include MultiverseHelpers
+  setup_and_teardown_agent(:cross_process_id => "boo",
+                           :encoding_key => "\0",
+                           :trusted_account_ids => [1]) \
+  do |collector|
+    collector.stub('connect', {
+      'agent_run_id' => 666,
+      'transaction_name_rules' => [{"match_expression" => "ignored_transaction",
+                                    "ignore"           => true}]})
+  end
+
+  include Rack::Test::Methods
+
+  def app
+    Rack::Builder.app { run TestingApp.new }
+  end
+
+  def test_cross_app_doesnt_modify_without_header
+    get '/'
+    assert_nil last_response.headers["X-Mmtrix-App-Data"]
+  end
+
+  def test_cross_app_doesnt_modify_with_invalid_header
+    get '/', nil, {'HTTP_X_MMTRIX_ID' => Base64.encode64('otherjunk')}
+    assert_nil last_response.headers["X-Mmtrix-App-Data"]
+  end
+
+  def test_cross_app_writes_out_information
+    get '/', nil, {'HTTP_X_MMTRIX_ID' => Base64.encode64('1#234')}
+    refute_nil last_response.headers["X-Mmtrix-App-Data"]
+    assert_metrics_recorded(['ClientApplication/1#234/all'])
+  end
+
+  def test_cross_app_doesnt_modify_if_txn_is_ignored
+    get '/', {'transaction_name' => 'ignored_transaction'}, {'HTTP_X_MMTRIX_ID' => Base64.encode64('1#234')}
+    assert_nil last_response.headers["X-Mmtrix-App-Data"]
+  end
+
+  def test_cross_app_error_attaches_process_id_to_intrinsics
+    assert_raises(RuntimeError) do
+      get '/', {'fail' => 'true'}, {'HTTP_X_MMTRIX_ID' => Base64.encode64('1#234')}
+    end
+
+    assert_includes attributes_for(last_traced_error, :intrinsic), :client_cross_process_id
+  end
+
+  load_cross_agent_test("cat_map").each do |test_case|
+    # We only can do test cases here that don't involve outgoing calls
+    if !test_case["outboundRequests"]
+      if test_case['inboundPayload']
+        request_headers = {
+          'HTTP_X_MMTRIX_ID'          => Base64.encode64('1#234'),
+          'HTTP_X_MMTRIX_TRANSACTION' => json_dump_and_encode(test_case['inboundPayload'])
+        }
+      else
+        request_headers = {}
+      end
+
+      define_method("test_#{test_case['name']}") do
+        txn_name_parts = test_case['transactionName'].split('/')
+        txn_category   = txn_name_parts[0..1].join('/')
+        txn_name       = txn_name_parts[2..-1].join('/')
+
+        request_params = {
+          'transaction_name' => txn_name,
+          'transaction_category' => txn_category,
+          'guid' => test_case['transactionGuid']
+        }
+
+        with_config('app_name' => test_case['appName']) do
+          get '/', request_params, request_headers
+        end
+
+        event = get_last_analytics_event
+        assert_event_attributes(
+          event,
+          test_case['name'],
+          test_case['expectedIntrinsicFields'],
+          test_case['nonExpectedIntrinsicFields']
+        )
+      end
+    end
+  end
+end

data/test/multiverse/suites/agent_only/custom_analytics_events_test.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+class CustomAnalyticsEventsTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  def test_custom_analytics_events_are_submitted
+    t0 = freeze_time
+    Mmtrix::Agent.record_custom_event(:DummyType, :foo => :bar, :baz => :qux)
+
+    Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+    events = last_custom_event_submission
+
+    expected_event = [{'type' => 'DummyType', 'timestamp' => t0.to_i },
+                      {'foo' => 'bar', 'baz' => 'qux'}]
+    assert_equal(expected_event, events.first)
+  end
+
+  def test_record_custom_event_returns_falsy_if_event_was_dropped
+    max_samples = Mmtrix::Agent.config[:'custom_insights_events.max_samples_stored']
+    max_samples.times do
+      Mmtrix::Agent.record_custom_event(:DummyType, :foo => :bar)
+    end
+
+    result = Mmtrix::Agent.record_custom_event(:DummyType, :foo => :bar)
+    refute(result)
+  end
+
+  def test_record_doesnt_record_if_invalid_event_type
+    bad_event_type  = 'bad$news'
+    good_event_type = 'good news'
+
+    Mmtrix::Agent.record_custom_event(bad_event_type,  :foo => :bar)
+    Mmtrix::Agent.record_custom_event(good_event_type, :foo => :bar)
+
+    Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+    events = last_custom_event_submission
+
+    assert_equal(1, events.size)
+    assert_equal(good_event_type, events.first[0]['type'])
+  end
+
+  def test_events_are_not_recorded_when_disabled_by_feature_gate
+    connect_response = {
+      'agent_run_id'          => 1,
+      'collect_custom_events' => false
+    }
+
+    $collector.stub('connect', connect_response)
+
+    trigger_agent_reconnect
+
+    Mmtrix::Agent.record_custom_event('whatever', :foo => :bar)
+
+    Mmtrix::Agent.agent.send(:harvest_and_send_analytic_event_data)
+    assert_equal(0, $collector.calls_for(:custom_event_data).size)
+  end
+
+  def last_custom_event_submission
+    submissions = $collector.calls_for('custom_event_data')
+    assert_equal(1, submissions.size)
+    submissions.first.events
+  end
+end

data/test/multiverse/suites/agent_only/custom_queue_time_test.rb

@@ -0,0 +1,60 @@
+# 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 'mmtrix_rpm'
+
+class CustomQueueTimeTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  DummyRequest = Struct.new(:headers, :cookies) do
+    def path
+      "/"
+    end
+  end
+
+  class DummyApp
+    include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+
+    def run_transaction(request, simulated_queue_time)
+      opts = { :name => 'run_transaction', :class_name => 'DummyApp', :request => request }
+
+      advance_time(simulated_queue_time)
+
+      perform_action_with_mmtrix_trace(opts) do
+        # nothing
+      end
+    end
+  end
+
+  def setup
+    freeze_time
+    @headers = { 'HTTP_X_REQUEST_START' => "t=#{Time.now.to_f}" }
+  end
+
+  def test_pulls_request_headers_from_passed_in_rack_request
+    request = Rack::Request.new(@headers)
+    DummyApp.new.run_transaction(request, 10)
+
+    assert_metrics_recorded(
+      'WebFrontend/QueueTime' => {
+        :call_count      => 1,
+        :total_call_time => 10
+      }
+    )
+  end
+
+  def test_pulls_request_headers_from_passed_in_request_responding_to_headers
+    request = DummyRequest.new(@headers, {})
+    DummyApp.new.run_transaction(request, 10)
+
+    assert_metrics_recorded(
+      'WebFrontend/QueueTime' => {
+        :call_count      => 1,
+        :total_call_time => 10
+      }
+    )
+  end
+end

data/test/multiverse/suites/agent_only/encoding_handling_test.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+if RUBY_VERSION >= '1.9'
+
+class EncodingHandlingTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  # We're hitting a Rubinius bug when running this test there:
+  # https://github.com/rubinius/rubinius/issues/2899
+  unless Mmtrix::LanguageSupport.rubinius?
+    def test_handles_mis_encoded_database_queries
+      with_config(:'transaction_tracer.transaction_threshold' => 0.0,
+        :'transaction_tracer.record_sql' => :raw) do
+        in_transaction do
+          state = Mmtrix::Agent::TransactionState.tl_get
+          agent.transaction_sampler.notice_sql(bad_string, nil, 42, state)
+        end
+        assert_endpoint_received_string('transaction_sample_data', normalized_bad_string)
+      end
+    end
+  end
+
+  def test_handles_mis_encoded_request_params
+    with_config(:'capture_params' => true,
+      :'transaction_tracer.transaction_threshold' => 0.0) do
+      options = { :filtered_params => { bad_string => bad_string }}
+      in_transaction(options) do
+        # nothin
+      end
+    end
+    assert_endpoint_received_string('transaction_sample_data', normalized_bad_string)
+  end
+
+  def test_handles_mis_encoded_custom_attributes
+    with_config(:'transaction_tracer.transaction_threshold' => 0.0) do
+      in_transaction do
+        Mmtrix::Agent.add_custom_attributes(:foo => bad_string)
+      end
+    end
+    assert_endpoint_received_string('transaction_sample_data', normalized_bad_string)
+  end
+
+  def test_handles_mis_encoded_custom_attributes_on_analytics_events
+    in_transaction(:category => :controller) do
+      Mmtrix::Agent.add_custom_attributes(:foo => bad_string)
+    end
+    assert_endpoint_received_string('analytic_event_data', normalized_bad_string)
+  end
+
+  def test_handles_mis_encoded_custom_attributes_on_errors
+    Mmtrix::Agent.notice_error('bad news', :custom_params => {'foo' => bad_string})
+    assert_endpoint_received_string('error_data', normalized_bad_string)
+  end
+
+  def test_handles_mis_encoded_exception_message
+    Mmtrix::Agent.notice_error(bad_string)
+    assert_endpoint_received_string('error_data', normalized_bad_string)
+  end
+
+  def test_handles_mis_encoded_metric_names
+    Mmtrix::Agent.record_metric(bad_string, 42)
+    assert_endpoint_received_string('metric_data', normalized_bad_string)
+  end
+
+  def test_handles_mis_encoded_transaction_names
+    with_config(:'transaction_tracer.transaction_threshold' => 0.0) do
+      in_transaction do
+        Mmtrix::Agent.set_transaction_name(bad_string)
+      end
+    end
+    expected_transaction_name = "other/#{normalized_bad_string}"
+    assert_endpoint_received_string('transaction_sample_data', expected_transaction_name)
+  end
+
+  def test_handles_mis_encoded_strings_in_environment_report
+    $collector.reset
+    ::Mmtrix::EnvironmentReport.report_on('Dummy') do
+      bad_string
+    end
+    agent.instance_variable_set(:@environment_report, agent.environment_for_connect)
+    agent.connect_to_server
+    assert_endpoint_received_string('connect', normalized_bad_string)
+  end
+
+  def assert_endpoint_received_string(endpoint, string)
+    agent.send(:transmit_data)
+    agent.send(:transmit_event_data)
+    requests = $collector.calls_for(endpoint)
+    assert_equal(1, requests.size)
+    request = requests.first
+    request.decode! if request.respond_to?(:decode!)
+    assert_contains_string(request, string)
+  end
+
+  def assert_contains_string(request, string)
+    object_graph = request.body
+    object_graph = request.samples if request.respond_to?(:samples)
+    assert object_graph_contains_string?(request.body, string), "Did not find desired string in #{request.body.inspect}"
+  end
+
+  def object_graph_contains_string?(object_graph, string)
+    case object_graph
+    when String
+      string == object_graph
+    when Array
+      object_graph.any? { |x| object_graph_contains_string?(x, string) }
+    when Hash
+      (
+        object_graph_contains_string?(object_graph.keys, string) ||
+        object_graph_contains_string?(object_graph.values, string)
+      )
+    else
+      false
+    end
+  end
+
+  def bad_string
+    [128].to_a.pack("C*").force_encoding('UTF-8')
+  end
+
+  def normalized_bad_string
+    bad_string.force_encoding('ISO-8859-1').encode('UTF-8')
+  end
+end
+
+end

data/test/multiverse/suites/agent_only/exclusive_time_test.rb

@@ -0,0 +1,176 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+class ExclusiveTimeTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  def test_traced_node_without_metrics_dont_decrease_exclusive_time
+    traced_class = Class.new do
+      include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+      include Mmtrix::Agent::MethodTracer
+
+      def outer
+        advance_time 2
+        inner_a
+        inner_b
+      end
+      add_transaction_tracer :outer, :class_name => 'traced'
+
+      def inner_a
+        advance_time 5
+      end
+      add_method_tracer :inner_a, 'inner_a', :metric => false
+
+      def inner_b
+        advance_time 10
+      end
+      add_method_tracer :inner_b, 'inner_b'      
+    end
+
+    freeze_time
+    traced_class.new.outer
+
+    txn_name = 'Controller/traced/outer'
+    assert_metrics_recorded(
+      txn_name => {
+        :call_count           => 1,
+        :total_call_time      => 2 + 5 + 10,
+        :total_exclusive_time => 2 + 5
+      },
+      ['inner_b', txn_name] => {
+        :call_count           => 1,
+        :total_call_time      => 10,
+        :total_exclusive_time => 10
+      })
+  end
+
+  def test_exclusive_time_should_propagate_through_nodes_that_dont_record_metrics
+    traced_class = Class.new do
+      include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+      include Mmtrix::Agent::MethodTracer
+
+      def outer
+        advance_time 2
+        inner_a
+      end
+      add_transaction_tracer :outer, :class_name => 'traced'
+
+      def inner_a
+        advance_time 5
+        inner_b
+      end
+      add_method_tracer :inner_a, 'inner_a', :metric => false
+
+      def inner_b
+        advance_time 10
+      end
+      add_method_tracer :inner_b, 'inner_b'
+    end
+
+    freeze_time
+    txn_name = 'Controller/traced/outer'
+
+    traced_class.new.outer
+
+    assert_metrics_recorded(
+      txn_name => {
+        :call_count           => 1,
+        :total_call_time      => 2 + 5 + 10,
+        :total_exclusive_time => 2 + 5
+      },
+      ['inner_b', txn_name] => {
+        :call_count           => 1,
+        :total_call_time      => 10,
+        :total_exclusive_time => 10
+      })
+  end
+
+  def test_exclusive_time_on_unscoped_metric_should_be_zero_if_scoped_metric_matches
+    traced_class = Class.new do
+      include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+      include Mmtrix::Agent::MethodTracer
+
+      def outer_a
+        advance_time 2
+        outer_b
+      end
+      add_transaction_tracer :outer_a, :class_name => 'traced'
+
+      def outer_b
+        advance_time 5
+        inner
+      end
+      add_transaction_tracer :outer_b, :class_name => 'traced'
+
+      def inner
+        advance_time 10
+      end
+      add_method_tracer :inner, 'inner'
+    end
+
+    freeze_time
+    traced_class.new.outer_a
+
+    txn_name = 'Controller/traced/outer_b'
+    assert_metrics_recorded(
+       txn_name => {
+        :call_count           => 1,
+        :total_call_time      => 2 + 5 + 10,
+        :total_exclusive_time => 0
+      },
+      ['Nested/Controller/traced/outer_a', txn_name] => {
+        :call_count           => 1,
+        :total_call_time      => 2 + 5 + 10,
+        :total_exclusive_time => 2
+      },
+      ['Nested/Controller/traced/outer_b', txn_name] => {
+        :call_count           => 1,
+        :total_call_time      => 5 + 10,
+        :total_exclusive_time => 5
+      },
+      ['inner', txn_name] => {
+        :call_count           => 1,
+        :total_call_time      => 10,
+        :total_exclusive_time => 10
+      }
+    )
+  end
+
+  def test_exclusive_time_on_unscoped_metric_should_be_non_zero_if_no_nested_transaction
+    traced_class = Class.new do
+      include Mmtrix::Agent::Instrumentation::ControllerInstrumentation
+      include Mmtrix::Agent::MethodTracer
+
+      def outer
+        advance_time 2
+        inner
+      end
+      add_transaction_tracer :outer, :class_name => 'traced'
+
+      def inner
+        advance_time 10
+      end
+      add_method_tracer :inner, 'inner'
+    end
+
+    freeze_time
+    traced_class.new.outer
+
+    txn_name = 'Controller/traced/outer'
+    assert_metrics_recorded(
+       txn_name => {
+        :call_count           => 1,
+        :total_call_time      => 2 + 10,
+        :total_exclusive_time => 2
+      },
+      ['inner', txn_name] => {
+        :call_count           => 1,
+        :total_call_time      => 10,
+        :total_exclusive_time => 10
+      }
+    )
+  end
+end

data/test/multiverse/suites/agent_only/harvest_timestamps_test.rb

@@ -0,0 +1,83 @@
+# 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 'mmtrix_rpm'
+
+class HarvestTimestampsTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  def test_resets_metric_data_timestamps_after_forking
+    freeze_time
+
+    t1 = advance_time 10
+
+    simulate_fork
+    Mmtrix::Agent.after_fork
+
+    t2 = advance_time 10
+    trigger_metric_data_post
+
+    metric_data_post = $collector.calls_for('metric_data').first
+    start_ts, end_ts = metric_data_post[1..2]
+
+    assert_equal(t1.to_f, start_ts)
+    assert_equal(t2.to_f, end_ts)
+  end
+
+  def test_start_timestamp_maintained_on_harvest_failure
+    t0 = freeze_time.to_f
+
+    simulate_fork
+    Mmtrix::Agent.after_fork
+
+    $collector.stub('metric_data', {}, 503)
+    t1 = advance_time(10).to_f
+    trigger_metric_data_post
+    first_post = last_metric_data_post
+
+    $collector.reset
+    t2 = advance_time(10).to_f
+    trigger_metric_data_post
+    second_post = last_metric_data_post
+
+    assert_equal([t0, t1], first_post[1..2])
+    assert_equal([t0, t2], second_post[1..2])
+  end
+
+  def test_timestamps_updated_even_if_filling_metric_id_cache_fails
+    t0 = freeze_time.to_f
+
+    simulate_fork
+    Mmtrix::Agent.after_fork
+
+    # Induce a failure in filling the metric ID cache by handing back a bogus
+    # response to the first metric_data post.
+    $collector.stub('metric_data', [[[[]]]], 200)
+    t1 = advance_time(10).to_f
+    trigger_metric_data_post
+    first_post = last_metric_data_post
+
+    $collector.reset
+    t2 = advance_time(10).to_f
+    trigger_metric_data_post
+    second_post = last_metric_data_post
+
+    assert_equal([t0, t1], first_post[1..2])
+    assert_equal([t1, t2], second_post[1..2])
+  end
+
+  def trigger_metric_data_post
+    Mmtrix::Agent.agent.send(:transmit_data)
+  end
+
+  def last_metric_data_post
+    $collector.calls_for('metric_data').last
+  end
+
+  def simulate_fork
+    Mmtrix::Agent.instance.harvester.instance_variable_set(:@starting_pid, nil)
+  end
+end

data/test/multiverse/suites/agent_only/http_response_code_test.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+# This file is distributed under Mmtrix's license terms.
+# See https://github.com/mmtrix/rpm/blob/master/LICENSE for complete details.
+
+# https://mmtrix.atlassian.net/browse/RUBY-765
+require 'fake_collector'
+
+class HttpResponseCodeTest < Minitest::Test
+  include MultiverseHelpers
+
+  setup_and_teardown_agent
+
+  def test_request_entity_too_large
+    $collector.stub_exception('metric_data', {'error_type' => 'RuntimeError', 'message' => 'too much'}, 413)
+
+    Mmtrix::Agent.increment_metric('Custom/too_big')
+    assert_metrics_recorded(['Custom/too_big'])
+
+    agent.send(:harvest_and_send_timeslice_data)
+
+    # make sure the data gets thrown away after we called collector without crashing
+    assert_metrics_not_recorded(['Custom/too_big'])
+    assert_equal(1, $collector.calls_for('metric_data').size)
+  end
+
+  def test_unsupported_media_type
+    $collector.stub_exception('metric_data', {'error_type' => 'RuntimeError', 'message' => 'looks bad'}, 415)
+
+    Mmtrix::Agent.increment_metric('Custom/too_big')
+    assert_metrics_recorded(['Custom/too_big'])
+
+    agent.send(:harvest_and_send_timeslice_data)
+
+    # make sure the data gets thrown away after we called collector without crashing
+    assert_metrics_not_recorded(['Custom/too_big'])
+    assert_equal(1, $collector.calls_for('metric_data').size)
+  end
+end

data/test/multiverse/suites/agent_only/keepalive_test.rb

@@ -0,0 +1,24 @@
+# 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 'mmtrix_rpm'
+
+class KeepaliveTest < Minitest::Test
+  include MultiverseHelpers
+
+  def test_can_reestablish_connection
+    setup_agent(:aggressive_keepalive => true)
+
+    Mmtrix::Agent.agent.send(:transmit_data)
+
+    # This is simulating the remote peer closing the TCP connection between
+    # harvest cycles.
+    $collector.last_socket.close
+
+    Mmtrix::Agent.agent.send(:transmit_data)
+
+    metric_data_calls = $collector.calls_for('metric_data')
+    assert_equal(2, metric_data_calls.size)
+  end
+end