instana 1.1.0 → 1.2.0

data/test/instrumentation/net-http_test.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+
+class NetHTTPTest < Minitest::Test
+  def test_config_defaults
+    assert ::Instana.config[:nethttp].is_a?(Hash)
+    assert ::Instana.config[:nethttp].key?(:enabled)
+    assert_equal true, ::Instana.config[:nethttp][:enabled]
+  end
+
+  def test_block_request
+    clear_all!
+    WebMock.allow_net_connect!
+    url = "http://127.0.0.1:6511/"
+
+    uri = URI.parse(url)
+    req = Net::HTTP::Get.new(uri)
+
+    response = nil
+    Instana.tracer.start_or_continue_trace('net-http-test') do
+      Net::HTTP.start(req.uri.hostname, req.uri.port, :open_timeout => 1, :read_timeout => 1) do |http|
+        response = http.request(req)
+      end
+    end
+
+    assert_equal 2, ::Instana.processor.queue_count
+
+    traces = Instana.processor.queued_traces
+    rs_trace = traces[0]
+    http_trace = traces[1]
+
+    # Net::HTTP trace validation
+    assert_equal 2, http_trace.spans.count
+    spans = http_trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    # Span name validation
+    assert_equal :sdk, first_span[:n]
+    assert_equal :'net-http', second_span[:n]
+
+    # first_span is the parent of second_span
+    assert_equal first_span.id, second_span[:p]
+
+    # data keys/values
+    refute_nil second_span.key?(:data)
+    refute_nil second_span[:data].key?(:http)
+    assert_equal "http://127.0.0.1:6511/", second_span[:data][:http][:url]
+    assert_equal "200", second_span[:data][:http][:status]
+    assert second_span.key?(:stack)
+
+    # Rack server trace validation
+    assert_equal 1, rs_trace.spans.count
+    rs_span = rs_trace.spans.to_a[0]
+
+    # Rack server trace should have the same trace ID
+    assert_equal http_trace.id, rs_span[:t].to_i
+    # Rack server trace should have net-http has parent span
+    assert_equal second_span.id, rs_span[:p].to_i
+
+    WebMock.disable_net_connect!
+  end
+
+  def test_basic_post_without_uri
+    clear_all!
+    WebMock.allow_net_connect!
+
+    response = nil
+    Instana.tracer.start_or_continue_trace('net-http-test') do
+      http = Net::HTTP.new("127.0.0.1", 6511)
+      response = http.request(Net::HTTP::Post.new("/"))
+    end
+
+    assert_equal 2, ::Instana.processor.queue_count
+
+    traces = Instana.processor.queued_traces
+    rs_trace = traces[0]
+    http_trace = traces[1]
+
+    # Net::HTTP trace validation
+    assert_equal 2, http_trace.spans.count
+    spans = http_trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    # Span name validation
+    assert_equal :sdk, first_span[:n]
+    assert_equal :'net-http', second_span[:n]
+
+    # first_span is the parent of second_span
+    assert_equal first_span.id, second_span[:p]
+
+    # data keys/values
+    refute_nil second_span.key?(:data)
+    refute_nil second_span[:data].key?(:http)
+    assert_equal "http://127.0.0.1:6511/", second_span[:data][:http][:url]
+    assert_equal "200", second_span[:data][:http][:status]
+    assert second_span.key?(:stack)
+
+    # Rack server trace validation
+    assert_equal 1, rs_trace.spans.count
+    rs_span = rs_trace.spans.to_a[0]
+
+    # Rack server trace should have the same trace ID
+    assert_equal http_trace.id, rs_span[:t].to_i
+    # Rack server trace should have net-http has parent span
+    assert_equal second_span.id, rs_span[:p].to_i
+
+    WebMock.disable_net_connect!
+  end
+
+  def test_request_with_dns_error
+    clear_all!
+    WebMock.allow_net_connect!
+
+    begin
+      Instana.tracer.start_or_continue_trace('net-http-error-test') do
+        http = Net::HTTP.new("asdfasdf.asdfsadf", 80)
+        http.request(Net::HTTP::Get.new("/blah"))
+      end
+    rescue Exception
+      nil
+    end
+
+    traces = Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    t = traces[0]
+    assert_equal 1, t.spans.count
+    assert t.has_error?
+    spans = t.spans.to_a
+    first_span = spans[0]
+
+    assert_equal :'net-http-error-test', first_span.name
+    assert first_span.custom?
+    assert first_span[:data][:sdk][:custom].key?(:log)
+    assert first_span[:data][:sdk][:custom][:log].key?(:message)
+    assert first_span[:data][:sdk][:custom][:log].key?(:parameters)
+
+    WebMock.disable_net_connect!
+  end
+end

data/test/instrumentation/rest-client_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class RestClientTest < Minitest::Test
+  def test_config_defaults
+    assert ::Instana.config[:'rest-client'].is_a?(Hash)
+    assert ::Instana.config[:'rest-client'].key?(:enabled)
+    assert_equal true, ::Instana.config[:'rest-client'][:enabled]
+  end
+
+  def test_basic_get
+    clear_all!
+    WebMock.allow_net_connect!
+
+    url = "http://127.0.0.1:6511/"
+
+    Instana.tracer.start_or_continue_trace('restclient-test') do
+      RestClient.get url
+    end
+
+    assert_equal 2, ::Instana.processor.queue_count
+
+    traces = Instana.processor.queued_traces
+    rs_trace = traces[0]
+    http_trace = traces[1]
+
+    # RestClient trace validation
+    assert_equal 3, http_trace.spans.count
+    spans = http_trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+    third_span = spans[2]
+
+    # Span name validation
+    assert first_span.custom?
+    assert_equal :"restclient-test", first_span.name
+    assert_equal :"rest-client", second_span.name
+    assert_equal :"net-http", third_span.name
+
+    # first_span is the parent of second_span
+    assert_equal first_span.id, second_span[:p]
+    # second_span is parent of third_span
+    assert_equal second_span.id, third_span[:p]
+
+    # data keys/values
+    refute_nil third_span.key?(:data)
+    refute_nil third_span[:data].key?(:http)
+    assert_equal "http://127.0.0.1:6511/", third_span[:data][:http][:url]
+    assert_equal "200", third_span[:data][:http][:status]
+
+    # Rack server trace validation
+    assert_equal 1, rs_trace.spans.count
+    rs_span = rs_trace.spans.to_a[0]
+
+    # Rack server trace should have the same trace ID
+    assert_equal http_trace.id, rs_span[:t].to_i
+    # Rack server trace should have net-http has parent span
+    assert_equal third_span.id, rs_span[:p].to_i
+
+    WebMock.disable_net_connect!
+  end
+end

data/test/models/block.rb

@@ -0,0 +1,18 @@
+class Block < ActiveRecord::Base
+  def do_work(*args)
+    block = Block.first
+    block.name = "Charlie"
+    block.color = "Black"
+    block.save
+  end
+end
+
+class CreateBlocks < ActiveRecord::Migration
+  def change
+    create_table :blocks do |t|
+      t.string :name
+      t.string :color
+      t.timestamps
+    end
+  end
+end

data/test/servers/rackapp_6511.rb

@@ -0,0 +1,20 @@
+require 'rack/handler/puma'
+require 'rack/builder'
+require 'instana/rack'
+
+::Instana.logger.info "Booting instrumented background Rackapp on port 6511 for tests."
+
+Thread.new do
+  app = Rack::Builder.new {
+    use ::Instana::Rack
+    map "/" do
+      run Proc.new { |env|
+        [200, {"Content-Type" => "application/json"}, ["[\"Stan\",\"is\",\"on\",\"the\",\"scene!\"]"]]
+      }
+    end
+  }
+
+  Rack::Handler::Puma.run(app, {:Host => '127.0.0.1', :Port => 6511})
+end
+
+sleep(2)

data/test/servers/rails_3205.rb

@@ -0,0 +1,95 @@
+
+::Instana.logger.warn "Starting background Ruby on Rails application on port 3205"
+
+require "rails/all"
+require "action_controller/railtie" # require more if needed
+require 'rack/handler/puma'
+require File.expand_path(File.dirname(__FILE__) + '/../models/block')
+
+ActiveRecord::Base.establish_connection(ENV['DATABASE_URL'])
+
+unless ActiveRecord::Base.connection.table_exists? 'blocks'
+  if Rails::VERSION::STRING < '4.0'
+    CreateBlocks.migrate(:up)
+  else
+    ActiveRecord::Migration.run(CreateBlocks)
+  end
+end
+
+class RailsTestApp < Rails::Application
+  routes.append do
+    get "/test/world" => "test#world"
+    get "/test/db"    => "test#db"
+    get "/test/error" => "test#error"
+
+    get "/api/world" => "socket#world"
+    get "/api/error" => "socket#error"
+  end
+
+  # Enable cache classes. Production style.
+  config.cache_classes = true
+  config.eager_load = false
+
+  # uncomment below to display errors
+  # config.consider_all_requests_local = true
+
+  config.active_support.deprecation = :stderr
+
+  config.middleware.delete Rack::Lock
+  config.middleware.delete ActionDispatch::Flash
+
+  # We need a secret token for session, cookies, etc.
+  config.secret_token = "doesntneedtobesecurefortests"
+  config.secret_key_base = "blueredaquarossoseven"
+end
+
+class TestController < ActionController::Base
+  def world
+    if ::Rails::VERSION::MAJOR > 4
+      render :plain => "Hello test world!"
+    else
+      render :text => "Hello test world!"
+    end
+  end
+
+  def db
+    white_block = Block.new(:name => 'Part #28349', :color => 'White')
+    white_block.save
+    found = Block.where(:name => 'Part #28349').first
+    found.delete
+
+    if ::Rails::VERSION::MAJOR > 4
+      render :plain => "Hello test db!"
+    else
+      render :text => "Hello test db!"
+    end
+  end
+
+  def error
+    raise Exception.new("Warning: This is a simulated Error")
+  end
+end
+
+if ::Rails::VERSION::MAJOR > 4
+  class SocketController < ActionController::API
+    def world
+      if ::Rails::VERSION::MAJOR > 4
+        render :plain => "Hello api world!"
+      else
+        render :text => "Hello api world!"
+      end
+    end
+
+    def error
+      raise Exception.new("Warning: This is a simulated Socket API Error")
+    end
+  end
+end
+
+RailsTestApp.initialize!
+
+Thread.new do
+  Rack::Handler::Puma.run(RailsTestApp.to_app, {:Host => '127.0.0.1', :Port => 3205})
+end
+
+sleep(1)

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+ENV['INSTANA_GEM_TEST'] = 'true'
+require "rubygems"
+require "bundler/setup"
+Bundler.require(:default, :test)
+
+require "minitest/spec"
+require "minitest/autorun"
+require "minitest/reporters"
+require "minitest/debugger" if ENV['DEBUG']
+require 'webmock/minitest'
+::WebMock.disable_net_connect!(allow_localhost: true)
+
+require "instana/test"
+::Instana::Test.setup_environment
+
+# Boot background webservers to test against.
+require "./test/servers/rackapp_6511"
+
+case File.basename(ENV['BUNDLE_GEMFILE'])
+when /rails50|rails42|rails32/
+  require './test/servers/rails_3205'
+end
+
+WebMock.disable_net_connect!(allow_localhost: true)
+
+Minitest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+
+# Set this (or a subset) if you want increased debug output
+#::Instana.logger.debug_level = [ :agent, :agent_comm, :trace ]
+
+# Used to reset the gem to boot state.  It clears out any queued and/or staged
+# traces and resets the tracer to no active trace.
+#
+def clear_all!
+  ::Instana.processor.clear!
+  ::Instana.tracer.clear!
+  nil
+end

data/test/tracing/custom_test.rb

@@ -0,0 +1,143 @@
+require 'test_helper'
+
+class CustomTracingTest < Minitest::Test
+  def test_custom_tracing
+    clear_all!
+
+    assert_equal false, ::Instana.tracer.tracing?
+    # Start tracing
+    ::Instana.tracer.log_start_or_continue(:custom_trace, {:one => 1})
+    assert_equal true, ::Instana.tracer.tracing?
+    ::Instana.tracer.log_info({:info_logged => 1})
+    # End tracing
+    ::Instana.tracer.log_end(:rack, {:close_one => 1})
+    assert_equal false, ::Instana.tracer.tracing?
+
+    traces = ::Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    t = traces.first
+    assert_equal 1, t.spans.size
+    assert t.valid?
+
+    first_span = t.spans.first
+    assert_equal :sdk, first_span[:n]
+
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:sdk)
+    assert first_span[:data][:sdk].key?(:custom)
+    assert_equal :custom_trace, first_span[:data][:sdk][:name]
+    assert_equal 1, first_span[:data][:sdk][:custom][:one]
+    assert_equal :ruby, first_span[:ta]
+
+    assert first_span.key?(:f)
+    assert first_span[:f].key?(:e)
+    assert first_span[:f].key?(:h)
+    assert_equal ::Instana.agent.agent_uuid, first_span[:f][:h]
+  end
+
+  def test_custom_tracing_with_args
+    clear_all!
+    assert_equal false, ::Instana.tracer.tracing?
+
+    # Start tracing
+    ::Instana.tracer.log_start_or_continue(:rack, :on_trace_start => 1)
+    assert_equal true, ::Instana.tracer.tracing?
+
+    kvs = {}
+    kvs[:on_entry_kv] = 1
+    kvs[:arguments] = [[1,2,3], "test_arg", :ok]
+    kvs[:return] = true
+
+    ::Instana.tracer.log_entry(:custom_span, kvs)
+    ::Instana.tracer.log_info({:on_info_kv => 1})
+    ::Instana.tracer.log_exit(:custom_span, :on_exit_kv => 1)
+
+    # End tracing
+    ::Instana.tracer.log_end(:rack, {:on_trace_end => 1})
+    assert_equal false, ::Instana.tracer.tracing?
+
+    traces = ::Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    t = traces.first
+    assert_equal 2, t.spans.size
+    assert t.valid?
+
+    first_span, second_span = t.spans.to_a
+
+    assert_equal :rack, first_span[:n]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:on_trace_start)
+    assert_equal 1, first_span[:data][:on_trace_start]
+    assert first_span[:data].key?(:on_trace_end)
+    assert_equal 1, first_span[:data][:on_trace_end]
+
+    assert_equal :sdk, second_span[:n]
+    assert second_span.key?(:data)
+    assert second_span[:data].key?(:sdk)
+    assert second_span[:data][:sdk].key?(:custom)
+    assert :custom_span, second_span[:data][:sdk][:name]
+    assert :unknown, second_span[:data][:sdk][:type]
+    assert [[1, 2, 3], "test_arg", :ok], second_span[:data][:sdk][:arguments]
+    assert true, second_span[:data][:sdk][:return]
+    assert_equal 1, second_span[:data][:sdk][:custom][:on_entry_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:on_info_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:on_exit_kv]
+  end
+
+  def test_custom_tracing_with_error
+    clear_all!
+    assert_equal false, ::Instana.tracer.tracing?
+
+    # Start tracing
+    ::Instana.tracer.log_start_or_continue(:rack, :on_trace_start => 1)
+    assert_equal true, ::Instana.tracer.tracing?
+
+    begin
+      kvs = {}
+      kvs[:on_entry_kv] = 1
+      kvs[:arguments] = [[1,2,3], "test_arg", :ok]
+      kvs[:return] = true
+
+      ::Instana.tracer.log_entry(:custom_span, kvs)
+      raise "custom tracing error.  This is only a test"
+      ::Instana.tracer.log_info({:on_info_kv => 1})
+    rescue => e
+      ::Instana.tracer.log_error(e)
+    ensure
+      ::Instana.tracer.log_exit(:custom_span, :on_exit_kv => 1)
+    end
+    ::Instana.tracer.log_end(:rack, {:on_trace_end => 1})
+    assert_equal false, ::Instana.tracer.tracing?
+
+    traces = ::Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    t = traces.first
+    assert_equal 2, t.spans.size
+    assert t.valid?
+
+    first_span, second_span = t.spans.to_a
+
+    assert_equal :rack, first_span[:n]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:on_trace_start)
+    assert_equal 1, first_span[:data][:on_trace_start]
+    assert first_span[:data].key?(:on_trace_end)
+    assert_equal 1, first_span[:data][:on_trace_end]
+
+    assert_equal :sdk, second_span[:n]
+    assert second_span.key?(:data)
+    assert second_span[:data].key?(:sdk)
+    assert second_span[:data][:sdk].key?(:custom)
+    assert :custom_span, second_span[:data][:sdk][:name]
+    assert :unknown, second_span[:data][:sdk][:type]
+    assert [[1, 2, 3], "test_arg", :ok], second_span[:data][:sdk][:arguments]
+    assert true, second_span[:data][:sdk][:return]
+    assert_equal 1, second_span[:data][:sdk][:custom][:on_entry_kv]
+    assert !second_span[:data][:sdk][:custom].key?(:on_info_kv)
+    assert_equal 1, second_span[:data][:sdk][:custom][:on_exit_kv]
+
+    # Check the error
+    assert_equal true, second_span[:error]
+    assert_equal 1, second_span[:ec]
+  end
+end