instana 1.4.11 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d2fe1c3a1066ce9cdf96311a5f8410ed3bc3287
-  data.tar.gz: 5954ed7f8f68915123c5744aac205410396c46c4
+  metadata.gz: bead9a4a515329922c151505eae7f209c49be9d2
+  data.tar.gz: bb7eb569bb0127e6d245858f3bbe595b1c8a62d4
 SHA512:
-  metadata.gz: c4716bb1f8e1dff2ae322bc6eead9bc7f6a2cebd364d11f6c098a320a6bfdb57d3dcc4a58ef4f8d2d1fad1c901ca6abc9998bd93b2db49a34bec6a914088c122
-  data.tar.gz: dd5ba99e78b1096c24954c43f234e424e8e7a94aef533f827b607d6306aa9bbd16b34c3763d53f9813ef978561cab84f426825a5cf5c42e75678f01e9b761b94
+  metadata.gz: cbe325aa85a8bca25ae4aaa0cd4317d2476d9b475d1fbd497722ccd3ea54472482f42f78cc1d7d035c4305344fd3fbc9e8531feb1dd4dcd5208aab20c14f5ae6
+  data.tar.gz: 4cfd9167eec7ad906cea0259c238ed47efa07748a6ba8aaa8de243b4a957632576b8ffebc98ae308d729226c714d1a06bd7ac6c43676e17b1aefb017a575dc9d

data/.gitignore

@@ -7,5 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+/log/
 .ruby-version
 gemfiles/*.lock

data/gemfiles/libraries.gemfile

@@ -13,10 +13,10 @@ end
 group :development do
   gem 'ruby-debug',   :platforms => [:mri_18, :jruby]
   gem 'debugger',     :platform  =>  :mri_19
-  gem 'byebug',       :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+  gem 'byebug',       :platforms => [:mri_20, :mri_21, :mri_22, :mri_23, :mri_24]
   if RUBY_VERSION > '1.8.7'
     gem 'pry'
-    gem 'pry-byebug', :platforms => [:mri_20, :mri_21, :mri_22, :mri_23]
+    gem 'pry-byebug', :platforms => [:mri_20, :mri_21, :mri_22, :mri_23, :mri_24]
   else
     gem 'pry', '0.9.12.4'
   end
@@ -27,6 +27,9 @@ gem "sinatra", '1.4.7'
 gem "cuba"
 gem "roda"
 
+# gRPC
+gem 'grpc'
+
 # HTTP Clients
 gem 'rest-client'
 

data/lib/instana/config.rb

@@ -39,6 +39,7 @@ module Instana
       @config[:excon]              = { :enabled => true }
       @config[:nethttp]            = { :enabled => true }
       @config[:'rest-client']      = { :enabled => true }
+      @config[:grpc]               = { :enabled => true }
     end
 
     def [](key)

data/lib/instana/instrumentation/grpc.rb

@@ -0,0 +1,84 @@
+call_types = [:request_response, :client_streamer, :server_streamer, :bidi_streamer]
+
+if defined?(GRPC::ActiveCall) && ::Instana.config[:grpc][:enabled]
+  call_types.each do |call_type|
+    GRPC::ClientStub.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{call_type}_with_instana(method, *others, **options)
+        kvs = { rpc: {} }
+
+        unless ::Instana.tracer.tracing?
+          return #{call_type}_without_instana(method, *others, **options)
+        end
+
+        kvs[:rpc][:flavor] = :grpc
+        kvs[:rpc][:host] = @host
+        kvs[:rpc][:call] = method
+        kvs[:rpc][:call_type] = :#{call_type}
+
+        ::Instana.tracer.log_entry(:'rpc-client', kvs)
+
+        context = ::Instana.tracer.context
+        if context
+          options[:metadata] = (options[:metadata] || {}).merge(
+            'x-instana-t' => context.trace_id_header,
+            'x-instana-s' => context.span_id_header
+          )
+        end
+
+        #{call_type}_without_instana(method, *others, **options)
+      rescue => e
+        kvs[:rpc][:error] = true
+        ::Instana.tracer.log_info(kvs)
+        ::Instana.tracer.log_error(e)
+        raise
+      ensure
+        ::Instana.tracer.log_exit(:'rpc-client', {})
+      end
+
+      alias #{call_type}_without_instana #{call_type}
+      alias #{call_type} #{call_type}_with_instana
+    RUBY
+  end
+  ::Instana.logger.warn 'Instrumenting GRPC client'
+end
+
+if defined?(GRPC::RpcDesc) && ::Instana.config[:grpc][:enabled]
+  call_types.each do |call_type|
+    GRPC::RpcDesc.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def handle_#{call_type}_with_instana(active_call, mth)
+        kvs = { rpc: {} }
+        metadata = active_call.metadata
+
+        incoming_context = {}
+        if metadata.key?('x-instana-t')
+          incoming_context[:trace_id]  = ::Instana::Util.header_to_id(metadata['x-instana-t'])
+          incoming_context[:span_id]   = ::Instana::Util.header_to_id(metadata['x-instana-s']) if metadata.key?('x-instana-s')
+          incoming_context[:level]     = metadata['x-instana-l'] if metadata.key?('x-instana-l')
+        end
+
+        kvs[:rpc][:flavor] = :grpc
+        kvs[:rpc][:host] = Socket.gethostname
+        kvs[:rpc][:call] = "/\#{mth.owner.service_name}/\#{name}"
+        kvs[:rpc][:call_type] = :#{call_type}
+        kvs[:rpc][:peer] = { address: active_call.peer }
+
+        ::Instana.tracer.log_start_or_continue(
+          :'rpc-server', kvs, incoming_context
+        )
+
+        handle_#{call_type}_without_instana(active_call, mth)
+      rescue => e
+        kvs[:rpc][:error] = true
+        ::Instana.tracer.log_info(kvs)
+        ::Instana.tracer.log_error(e)
+        raise
+      ensure
+        ::Instana.tracer.log_end(:'rpc-server', {}) if ::Instana.tracer.tracing?
+      end
+
+      alias handle_#{call_type}_without_instana handle_#{call_type}
+      alias handle_#{call_type} handle_#{call_type}_with_instana
+    RUBY
+  end
+  ::Instana.logger.warn 'Instrumenting GRPC server'
+end

data/lib/instana/tracing/span.rb

@@ -1,9 +1,11 @@
 module Instana
   class Span
-    REGISTERED_SPANS = [ :actioncontroller, :actionview, :activerecord, :excon, :memcache, :'net-http', :rack, :render ].freeze
-    ENTRY_SPANS = [ :rack ].freeze
-    EXIT_SPANS = [ :'net-http', :excon, :activerecord ].freeze
-    HTTP_SPANS = ENTRY_SPANS + EXIT_SPANS
+    REGISTERED_SPANS = [ :actioncontroller, :actionview, :activerecord, :excon,
+                         :memcache, :'net-http', :rack, :render, :'rpc-client',
+                         :'rpc-server' ].freeze
+    ENTRY_SPANS = [ :rack, :'rpc-server' ].freeze
+    EXIT_SPANS = [ :activerecord, :excon, :'net-http', :'rpc-client' ].freeze
+    HTTP_SPANS = [ :rack, :excon, :'net-http' ].freeze
 
     attr_accessor :parent
     attr_accessor :baggage

data/lib/instana/version.rb

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

data/test/apps/grpc_server.rb

@@ -0,0 +1,81 @@
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "PingPongService.PingRequest" do
+    optional :message, :string, 1
+  end
+  add_message "PingPongService.PongReply" do
+    optional :message, :string, 1
+  end
+end
+
+module PingPongService
+  PingRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("PingPongService.PingRequest").msgclass
+  PongReply = Google::Protobuf::DescriptorPool.generated_pool.lookup("PingPongService.PongReply").msgclass
+end
+require 'grpc'
+
+module PingPongService
+  # The greeting service definition.
+  class Service
+    include GRPC::GenericService
+
+    self.marshal_class_method = :encode
+    self.unmarshal_class_method = :decode
+    self.service_name = 'PingPongService'
+
+    rpc :Ping, PingRequest, PongReply
+    rpc :PingWithClientStream, stream(PingRequest), PongReply
+    rpc :PingWithServerStream, PingRequest, stream(PongReply)
+    rpc :PingWithBidiStream, stream(PingRequest), stream(PongReply)
+
+    rpc :FailToPing, PingRequest, PongReply
+    rpc :FailToPingWithClientStream, stream(PingRequest), PongReply
+    rpc :FailToPingWithServerStream, PingRequest, stream(PongReply)
+    rpc :FailToPingWithBidiStream, stream(PingRequest), stream(PongReply)
+  end
+
+  Stub = Service.rpc_stub_class
+end
+
+class PingPongServer < PingPongService::Service
+  def ping(ping_request, active_call)
+    PingPongService::PongReply.new(message: "Hello #{ping_request.message}")
+  end
+
+  def ping_with_client_stream(active_call)
+    message = ''
+    active_call.each_remote_read do |req|
+      message += req.message
+    end
+    PingPongService::PongReply.new(message: message)
+  end
+
+  def ping_with_server_stream(ping_request, active_call)
+    (0..5).map do |index|
+      PingPongService::PongReply.new(message: index.to_s)
+    end
+  end
+
+  def ping_with_bidi_stream(ping_requests)
+    ping_requests.map do |ping_request|
+      PingPongService::PongReply.new(message: ping_request.message)
+    end
+  end
+
+  def fail_to_ping(ping_request, active_call)
+    raise 'Unexpected failed'
+  end
+
+  def fail_to_ping_with_client_stream(active_call)
+    raise 'Unexpected failed'
+  end
+
+  def fail_to_ping_with_server_stream(ping_request, active_call)
+    raise 'Unexpected failed'
+  end
+
+  def fail_to_ping_with_bidi_stream(ping_requests)
+    raise 'Unexpected failed'
+  end
+end

data/test/instrumentation/grpc_test.rb

@@ -0,0 +1,317 @@
+require 'test_helper'
+
+class GrpcTest < Minitest::Test
+  def client_stub
+    PingPongService::Stub.new('127.0.0.1:50051', :this_channel_is_insecure)
+  end
+
+  # The order of traces are non-deterministic, could not predict
+  # which trace is server or client. This method is to choose the
+  # right trace based on span's name
+  def differentiate_trace(traces)
+    trying_client = traces[0]
+    trying_server = traces[1]
+
+    try_successfully = trying_client.spans.any? do |span|
+      span.name == :'rpc-client'
+    end
+
+    if try_successfully
+      [trying_client, trying_server]
+    else
+      [trying_server, trying_client]
+    end
+  end
+
+  def assert_client_trace(client_trace, call: '', call_type: '', error: nil)
+    assert_equal 2, client_trace.spans.count
+    spans = client_trace.spans.to_a
+    first_span = spans[0]
+    second_span = spans[1]
+
+    # Span name validation
+    assert_equal :sdk, first_span[:n]
+    assert_equal :rpctests, first_span[:data][:sdk][:name]
+    assert_equal :'rpc-client', second_span[:n]
+
+    # first_span is the parent of second_span
+    assert_equal first_span.id, second_span[:p]
+
+    data = second_span[:data]
+    assert_equal '127.0.0.1:50051', data[:rpc][:host]
+    assert_equal :grpc, data[:rpc][:flavor]
+    assert_equal call, data[:rpc][:call]
+    assert_equal call_type, data[:rpc][:call_type]
+
+    if error
+      assert_equal true, data[:rpc][:error]
+      assert_equal "2:RuntimeError: #{error}", data[:log][:message]
+    end
+  end
+
+  def assert_server_trace(server_trace, call: '', call_type: '', error: nil)
+    assert_equal 1, server_trace.spans.count
+    span = server_trace.spans.to_a.first
+
+    # Span name validation
+    assert_equal :'rpc-server', span[:n]
+
+    data = span[:data]
+    assert_equal :grpc, data[:rpc][:flavor]
+    assert_equal call, data[:rpc][:call]
+    assert_equal call_type, data[:rpc][:call_type]
+
+    if error
+      assert_equal true, data[:rpc][:error]
+      assert_equal error, data[:log][:message]
+    end
+  end
+
+  def test_request_response
+    clear_all!
+    response = nil
+
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      response = client_stub.ping(
+        PingPongService::PingRequest.new(message: 'Hello World')
+      )
+    end
+
+    assert 'Hello World', response.message
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/Ping',
+      call_type: :request_response
+    )
+
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/Ping',
+      call_type: :request_response
+    )
+  end
+
+  def test_client_streamer
+    clear_all!
+    response = nil
+
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      response = client_stub.ping_with_client_stream(
+        (0..5).map do |index|
+          PingPongService::PingRequest.new(message: index.to_s)
+        end
+      )
+    end
+
+    assert '01234', response.message
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/PingWithClientStream',
+      call_type: :client_streamer
+    )
+
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/PingWithClientStream',
+      call_type: :client_streamer
+    )
+  end
+
+  def test_server_streamer
+    clear_all!
+    responses = []
+
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      responses = client_stub.ping_with_server_stream(
+        PingPongService::PingRequest.new(message: 'Hello World')
+      )
+    end
+    sleep 1
+
+    assert %w(0 1 2 3 4), responses.map(&:message)
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/PingWithServerStream',
+      call_type: :server_streamer
+    )
+
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/PingWithServerStream',
+      call_type: :server_streamer
+    )
+  end
+
+  def test_bidi_streamer
+    clear_all!
+    responses = []
+
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      responses = client_stub.ping_with_bidi_stream(
+        (0..5).map do |index|
+          PingPongService::PingRequest.new(message: (index * 2).to_s)
+        end
+      )
+    end
+    sleep 1
+
+    assert %w(0 2 4 6 8), responses.to_a.map(&:message)
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/PingWithBidiStream',
+      call_type: :bidi_streamer
+    )
+
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/PingWithBidiStream',
+      call_type: :bidi_streamer
+    )
+  end
+
+  def test_request_response_failure
+    clear_all!
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      begin
+        client_stub.fail_to_ping( PingPongService::PingRequest.new(message: 'Hello World'))
+      rescue
+      end
+    end
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/FailToPing',
+      call_type: :request_response,
+      error: 'Unexpected failed'
+    )
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/FailToPing',
+      call_type: :request_response,
+      error: 'Unexpected failed'
+    )
+  end
+
+  def test_client_streamer_failure
+    clear_all!
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      begin
+        client_stub.fail_to_ping_with_client_stream(
+          (0..5).map do |index|
+            PingPongService::PingRequest.new(message: index.to_s)
+          end
+        )
+      rescue
+      end
+    end
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/FailToPingWithClientStream',
+      call_type: :client_streamer,
+      error: 'Unexpected failed'
+    )
+
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/FailToPingWithClientStream',
+      call_type: :client_streamer,
+      error: 'Unexpected failed'
+    )
+  end
+
+  def test_server_streamer_failure
+    clear_all!
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      begin
+        client_stub.fail_to_ping_with_server_stream(
+          PingPongService::PingRequest.new(message: 'Hello World')
+        )
+      rescue
+      end
+    end
+    sleep 1
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/FailToPingWithServerStream',
+      call_type: :server_streamer
+    )
+
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/FailToPingWithServerStream',
+      call_type: :server_streamer,
+      error: 'Unexpected failed'
+    )
+  end
+
+  def test_bidi_streamer_failure
+    clear_all!
+    Instana.tracer.start_or_continue_trace(:rpctests) do
+      client_stub.fail_to_ping_with_bidi_stream(
+        (0..5).map do |index|
+          PingPongService::PingRequest.new(message: (index * 2).to_s)
+        end
+      )
+    end
+    sleep 1
+
+    assert_equal 2, ::Instana.processor.queue_count
+    client_trace, server_trace = differentiate_trace(
+      Instana.processor.queued_traces
+    )
+
+    assert_client_trace(
+      client_trace,
+      call: '/PingPongService/FailToPingWithBidiStream',
+      call_type: :bidi_streamer
+    )
+
+    assert_server_trace(
+      server_trace,
+      call: '/PingPongService/FailToPingWithBidiStream',
+      call_type: :bidi_streamer,
+      error: 'Unexpected failed'
+    )
+  end
+end

data/test/servers/grpc_50051.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../apps/grpc_server.rb')
+
+::Instana.logger.info "Booting instrumented gRPC server on port 50051 for tests."
+
+grpc_thread = Thread.new do
+  s = GRPC::RpcServer.new
+  Thread.current[:server] = s
+
+  s.add_http2_port('127.0.0.1:50051', :this_port_is_insecure)
+  s.handle(PingPongServer)
+  s.run_till_terminated
+end
+
+Minitest.after_run do
+  ::Instana.logger.info "Killing gRPC server"
+  grpc_thread[:server].stop
+  sleep 2
+end
+
+sleep 2

data/test/test_helper.rb

@@ -21,6 +21,8 @@ when /rails50|rails42|rails32/
   # Allow localhost calls to the internal rails servers
   ::WebMock.disable_net_connect!(allow_localhost: true)
   require './test/servers/rails_3205'
+when /libraries/
+  require './test/servers/grpc_50051.rb'
 end
 
 Minitest::Reporters.use! MiniTest::Reporters::SpecReporter.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.4.11
+  version: 1.5.0
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,6 +201,7 @@ files:
 - lib/instana/instrumentation.rb
 - lib/instana/instrumentation/dalli.rb
 - lib/instana/instrumentation/excon.rb
+- lib/instana/instrumentation/grpc.rb
 - lib/instana/instrumentation/net-http.rb
 - lib/instana/instrumentation/rack.rb
 - lib/instana/instrumentation/rest-client.rb
@@ -222,6 +223,7 @@ files:
 - log/.keep
 - test/agent/agent_test.rb
 - test/apps/cuba.rb
+- test/apps/grpc_server.rb
 - test/apps/roda.rb
 - test/apps/sinatra.rb
 - test/config_test.rb
@@ -239,9 +241,11 @@ files:
 - test/instana_test.rb
 - test/instrumentation/dalli_test.rb
 - test/instrumentation/excon_test.rb
+- test/instrumentation/grpc_test.rb
 - test/instrumentation/net-http_test.rb
 - test/instrumentation/rest-client_test.rb
 - test/models/block.rb
+- test/servers/grpc_50051.rb
 - test/servers/rackapp_6511.rb
 - test/servers/rails_3205.rb
 - test/test_helper.rb
@@ -277,6 +281,7 @@ summary: Ruby sensor for Instana
 test_files:
 - test/agent/agent_test.rb
 - test/apps/cuba.rb
+- test/apps/grpc_server.rb
 - test/apps/roda.rb
 - test/apps/sinatra.rb
 - test/config_test.rb
@@ -294,9 +299,11 @@ test_files:
 - test/instana_test.rb
 - test/instrumentation/dalli_test.rb
 - test/instrumentation/excon_test.rb
+- test/instrumentation/grpc_test.rb
 - test/instrumentation/net-http_test.rb
 - test/instrumentation/rest-client_test.rb
 - test/models/block.rb
+- test/servers/grpc_50051.rb
 - test/servers/rackapp_6511.rb
 - test/servers/rails_3205.rb
 - test/test_helper.rb