instana 1.1.0 → 1.2.0

data/lib/instana/version.rb

@@ -1,4 +1,4 @@
 module Instana
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
   VERSION_FULL = "instana-#{VERSION}"
 end

data/test/agent/agent_test.rb

@@ -0,0 +1,139 @@
+require 'test_helper'
+
+class AgentTest < Minitest::Test
+  def test_agent_host_detection
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url)
+    assert_equal true, ::Instana.agent.host_agent_ready?
+  end
+
+  def test_successful_discovery
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url)
+    stub_request(:get, docker_url)
+    discovered = ::Instana.agent.run_discovery
+
+    assert discovered.is_a?(Hash)
+    assert_equal "127.0.0.1", discovered[:agent_host]
+    assert_equal 42699, discovered[:agent_port]
+  end
+
+  def test_failed_discovery
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url).to_raise(Errno::ECONNREFUSED)
+    stub_request(:get, docker_url).to_raise(Errno::ECONNREFUSED)
+    discovered = ::Instana.agent.run_discovery
+
+    assert_equal nil, discovered
+  end
+
+  def test_custom_configure_agent
+    original_host = ::Instana.config[:agent_host]
+    original_port = ::Instana.config[:agent_port]
+
+    # Set custom agent/port
+    ::Instana.config[:agent_host] = '172.0.12.100'
+    ::Instana.config[:agent_port] = 12829
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, url)
+    discovered = ::Instana.agent.run_discovery
+
+    assert discovered.is_a?(Hash)
+    assert_equal "172.0.12.100", discovered[:agent_host]
+    assert_equal 12829, discovered[:agent_port]
+
+    ::Instana.config[:agent_host] = original_host
+    ::Instana.config[:agent_port] = original_port
+  end
+
+  def test_no_host_agent
+    localhost_url = "http://#{::Instana::Agent::LOCALHOST}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, localhost_url).to_raise(Errno::ECONNREFUSED)
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, docker_url).to_timeout
+    assert_equal false, ::Instana.agent.host_agent_ready?
+  end
+
+  def test_announce_sensor
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    json = { 'pid' => Process.pid, 'agentUuid' => 'abc' }.to_json
+    stub_request(:put, url).to_return(:body => json, :status => 200)
+
+    assert_equal true, ::Instana.agent.announce_sensor
+  end
+
+  def test_failed_announce_sensor
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    stub_request(:put, url).to_raise(Errno::ECONNREFUSED)
+
+    assert_equal false, ::Instana.agent.announce_sensor
+  end
+
+  def test_metric_report
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    json = { 'pid' => Process.pid, 'agentUuid' => 'abc' }.to_json
+    stub_request(:put, url).to_return(:body => json, :status => 200)
+    ::Instana.agent.announce_sensor
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.#{Process.pid}"
+    stub_request(:post, url)
+
+    payload = { :test => 'true' }
+    assert_equal true, ::Instana.agent.report_metrics(payload)
+  end
+
+  def test_failed_metric_report
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.discovery"
+    json = { 'pid' => Process.pid, 'agentUuid' => 'abc' }.to_json
+    stub_request(:put, url).to_return(:body => json, :status => 200)
+
+    ::Instana.agent.announce_sensor
+
+    url = "http://#{::Instana.config[:agent_host]}:#{::Instana.config[:agent_port]}/com.instana.plugin.ruby.#{Process.pid}"
+    stub_request(:post, url).to_raise(Errno::ECONNREFUSED)
+
+    payload = { :test => 'true' }
+    assert_equal false, ::Instana.agent.report_metrics(payload)
+  end
+
+  def test_agent_timeout
+    # Fake discovery values
+    discovery = {}
+    discovery[:agent_host] = ::Instana.config[:agent_host]
+    discovery[:agent_port] = ::Instana.config[:agent_port]
+    ::Instana.agent.instance_variable_set(:@discovered, discovery)
+
+    localhost_url = "http://#{::Instana::Agent::LOCALHOST}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, localhost_url).to_timeout
+    docker_url = "http://#{::Instana.agent.instance_variable_get(:@default_gateway)}:#{::Instana.config[:agent_port]}/"
+    stub_request(:get, docker_url).to_timeout
+    assert_equal false, ::Instana.agent.host_agent_ready?
+  end
+end

data/test/apps/cuba.rb

@@ -0,0 +1,15 @@
+require "cuba/safe"
+
+Cuba.plugin ::Cuba::Safe
+
+Cuba.define do
+  on get do
+    on "hello" do
+      res.write "Hello Instana!"
+    end
+
+    on root do
+      res.redirect '/hello'
+    end
+  end
+end

data/test/apps/roda.rb

@@ -0,0 +1,10 @@
+class InstanaRodaApp < Roda
+  route do |r|
+    r.root do
+      r.redirect '/hello'
+    end
+    r.get "hello" do
+      "Hello Roda + Instana"
+    end
+  end
+end

data/test/apps/sinatra.rb

@@ -0,0 +1,5 @@
+class InstanaSinatraApp < ::Sinatra::Base
+  get '/' do
+    "Hello Sinatra!"
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class ConfigTest < Minitest::Test
+  def test_that_config_exists
+    refute_nil ::Instana.config
+    assert_instance_of(::Instana::Config, ::Instana.config)
+  end
+
+  def test_that_it_has_defaults
+    assert_equal '127.0.0.1', ::Instana.config[:agent_host]
+    assert_equal 42699, ::Instana.config[:agent_port]
+
+    ::Instana.config[:metrics].each do |k, v|
+      assert_equal true, ::Instana.config[:metrics][k].key?(:enabled)
+    end
+  end
+end

data/test/frameworks/cuba_test.rb

@@ -0,0 +1,44 @@
+
+if defined?(::Cuba)
+  require 'test_helper'
+  require File.expand_path(File.dirname(__FILE__) + '/../apps/cuba')
+  require 'rack/test'
+
+  class CubaTest < Minitest::Test
+    include Rack::Test::Methods
+
+    def app
+      Cuba
+    end
+
+    def test_basic_get
+      clear_all!
+
+      r = get '/hello'
+      assert last_response.ok?
+
+      assert r.headers.key?("X-Instana-T")
+      assert r.headers.key?("X-Instana-S")
+
+      spans = ::Instana.processor.queued_spans
+      assert_equal 1, spans.count
+
+      first_span = spans.first
+      assert_equal :rack, first_span[:n]
+      assert first_span.key?(:data)
+      assert first_span[:data].key?(:http)
+
+      assert first_span[:data][:http].key?(:method)
+      assert_equal "GET", first_span[:data][:http][:method]
+
+      assert first_span[:data][:http].key?(:url)
+      assert_equal "/hello", first_span[:data][:http][:url]
+
+      assert first_span[:data][:http].key?(:status)
+      assert_equal 200, first_span[:data][:http][:status]
+
+      assert first_span[:data][:http].key?(:host)
+      assert_equal "example.org", first_span[:data][:http][:host]
+    end
+  end
+end

data/test/frameworks/rack_test.rb

@@ -0,0 +1,152 @@
+require 'test_helper'
+require 'rack/test'
+require 'rack/lobster'
+require "instana/rack"
+
+class RackTest < Minitest::Test
+  include Rack::Test::Methods
+
+  def app
+    @app = Rack::Builder.new {
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use Instana::Rack
+      map "/mrlobster" do
+        run Rack::Lobster.new
+      end
+    }
+  end
+
+  def test_basic_get
+    clear_all!
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal :ruby, first_span[:ta]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:http)
+    assert_equal "GET", first_span[:data][:http][:method]
+    assert_equal "/mrlobster", first_span[:data][:http][:url]
+    assert_equal 200, first_span[:data][:http][:status]
+    assert_equal 'example.org', first_span[:data][:http][:host]
+    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]
+
+    # Backtrace fingerprint validation
+    assert first_span.key?(:stack)
+    assert_equal 2, first_span[:stack].count
+    refute_nil first_span[:stack].first[:f].match(/instana\/instrumentation\/rack.rb/)
+  end
+
+  def test_basic_post
+    clear_all!
+    post '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal :ruby, first_span[:ta]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:http)
+    assert_equal "POST", first_span[:data][:http][:method]
+    assert_equal "/mrlobster", first_span[:data][:http][:url]
+    assert_equal 200, first_span[:data][:http][:status]
+    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_basic_put
+    clear_all!
+    put '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal :ruby, first_span[:ta]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:http)
+    assert_equal "PUT", first_span[:data][:http][:method]
+    assert_equal "/mrlobster", first_span[:data][:http][:url]
+    assert_equal 200, first_span[:data][:http][:status]
+    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_context_continuation
+    clear_all!
+    header 'X-INSTANA-T', Instana::Util.id_to_header(1234)
+    header 'X-INSTANA-S', Instana::Util.id_to_header(4321)
+
+    get '/mrlobster'
+    assert last_response.ok?
+
+    spans = ::Instana.processor.queued_spans
+
+    # Span validation
+    assert_equal 1, spans.count
+    first_span = spans.first
+    assert_equal :rack, first_span[:n]
+    assert_equal :ruby, first_span[:ta]
+    assert first_span.key?(:data)
+    assert first_span[:data].key?(:http)
+    assert_equal "GET", first_span[:data][:http][:method]
+    assert_equal "/mrlobster", first_span[:data][:http][:url]
+    assert_equal 200, first_span[:data][:http][:status]
+    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]
+
+    # Context validation
+    # The first span should have the passed in trace ID
+    # and specify the passed in span ID as it's parent.
+    assert_equal 1234, first_span[:t]
+    assert_equal 4321, first_span[:p]
+  end
+
+  def test_instana_response_headers
+    clear_all!
+    get '/mrlobster'
+    assert last_response.ok?
+
+    refute_nil last_response.headers.key?("X-Instana-T")
+    refute_nil last_response.headers.key?("X-Instana-S")
+  end
+
+  def test_that_url_params_not_logged
+    clear_all!
+    get '/mrlobster?blah=2&wilma=1&betty=2;fred=3'
+
+    traces = ::Instana.processor.queued_traces
+    assert_equal 1, traces.count
+
+    trace = traces[0]
+    refute_nil trace.spans.first.key?(:data)
+    refute_nil trace.spans.first[:data].key?(:http)
+    refute_nil trace.spans.first[:data][:http].key?(:url)
+    assert_equal '/mrlobster', trace.spans.first[:data][:http][:url]
+
+    assert last_response.ok?
+  end
+end

data/test/frameworks/rails/actioncontroller_test.rb

@@ -0,0 +1,123 @@
+require 'test_helper'
+
+class ActionControllerTest < Minitest::Test
+  def test_config_defaults
+    assert ::Instana.config[:action_controller].is_a?(Hash)
+    assert ::Instana.config[:action_controller].key?(:enabled)
+    assert_equal true, ::Instana.config[:action_controller][:enabled]
+  end
+
+  def test_controller_reporting
+    clear_all!
+
+    Net::HTTP.get(URI.parse('http://localhost:3205/test/world'))
+
+    traces = Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    trace = traces.first
+
+    assert_equal 2, trace.spans.count
+    spans = trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    assert_equal :rack, first_span.name
+
+    assert_equal :actioncontroller, second_span.name
+    assert_equal "TestController", second_span[:data][:actioncontroller][:controller]
+    assert_equal "world", second_span[:data][:actioncontroller][:action]
+  end
+
+  def test_controller_error
+    clear_all!
+
+    Net::HTTP.get(URI.parse('http://localhost:3205/test/error'))
+
+    traces = Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    trace = traces.first
+
+    assert_equal 2, trace.spans.count
+    spans = trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    assert_equal :rack, first_span.name
+
+    assert_equal :actioncontroller, second_span.name
+    assert_equal "TestController", second_span[:data][:actioncontroller][:controller]
+    assert_equal "error", second_span[:data][:actioncontroller][:action]
+    assert second_span.key?(:error)
+    assert second_span.key?(:stack)
+    assert_equal "Warning: This is a simulated Error", second_span[:data][:log][:message]
+    assert_equal "Exception", second_span[:data][:log][:parameters]
+  end
+
+  def test_api_controller_reporting
+    # Run only when ActionController::API is used/defined
+    skip unless defined?(::ActionController::API)
+
+    clear_all!
+
+    Net::HTTP.get(URI.parse('http://localhost:3205/api/world'))
+
+    traces = Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    trace = traces.first
+
+    assert_equal 2, trace.spans.count
+    spans = trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    assert_equal :rack, first_span.name
+
+    assert_equal :actioncontroller, second_span.name
+    assert_equal "SocketController", second_span[:data][:actioncontroller][:controller]
+    assert_equal "world", second_span[:data][:actioncontroller][:action]
+  end
+
+  def test_api_controller_error
+    # Run only when ActionController::API is used/defined
+    skip unless defined?(::ActionController::API)
+
+    clear_all!
+
+    Net::HTTP.get(URI.parse('http://localhost:3205/api/error'))
+
+    traces = Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    trace = traces.first
+
+    assert_equal 2, trace.spans.count
+    spans = trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    assert_equal :rack, first_span.name
+
+    assert_equal :actioncontroller, second_span.name
+    assert_equal "SocketController", second_span[:data][:actioncontroller][:controller]
+    assert_equal "error", second_span[:data][:actioncontroller][:action]
+    assert second_span.key?(:error)
+    assert second_span.key?(:stack)
+    assert_equal "Warning: This is a simulated Socket API Error", second_span[:data][:log][:message]
+    assert_equal "Exception", second_span[:data][:log][:parameters]
+  end
+
+  def test_404
+    clear_all!
+
+    Net::HTTP.get(URI.parse('http://localhost:3205/test/404'))
+
+    traces = Instana.processor.queued_traces
+    assert_equal 1, traces.count
+    trace = traces.first
+
+    assert_equal 1, trace.spans.count
+    spans = trace.spans.to_a
+    first_span = spans[0]
+
+    assert_equal :rack, first_span.name
+  end
+end