instana 1.7.8 → 1.7.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 316edaafce9e919b5191950fcd3a8dfd7ca39ef6
-  data.tar.gz: 28b3899692291381011da1602da9b3512e5637ff
+  metadata.gz: af911c681182db8726372c73e8fd2560374b8508
+  data.tar.gz: 230dcaa3a019e7c571a1b10726fc33550092de54
 SHA512:
-  metadata.gz: 37f348d6f49c0a6b4214e50d157349d6191fc61c17604d62e1a50ff32730201697220cced8986d4f0abec8e41eaeee95d342952b3b2fd97338bd7fd03c63a21a
-  data.tar.gz: d442ed00f217b08b4b29f64166c66ff1ecd4f551e238787587d203f887b450eb14933d0349b59f844530cc2e18e4790e57586498d3d4363274fc44891b7907e8
+  metadata.gz: 0b80e44dcdeaaed59c3b3f1ee2f4b8b7984b22a5b81ae17a1470de2d6c8a34a8b106ef9e07b2b46cc3a086ce292f10ffe40cc24e60a7530f2d16ea5dcae54dda
+  data.tar.gz: f62f4130454c5affedfcf5c322ed2cb83a2ca0ebf48fbd1c846529c2e9bacbe9fd1098a8feedcd5f9c1e0be45530ba91310defdbeacca909d3ec599be6a84875

data/examples/opentracing.rb

@@ -0,0 +1,31 @@
+# This file contains a basic OpenTracing example.
+#
+# Note:  The instana gem automatically sets the Instana tracer
+# to `OpenTracing.global_tracer`.  Once the gem is loaded, you can
+# immediately start making OpenTracing calls.
+#
+require "opentracing"
+
+entry_span = OpenTracing.start_span("HandMadeRackServer")
+
+entry_span.set_tag(:'http.method', :get)
+entry_span.set_tag(:'http.url', "/users")
+entry_span.set_tag(:'span.kind', "entry")
+
+intermediate_span = OpenTracing.start_span("myintermediate", :child_of => entry_span)
+intermediate_span.finish()
+
+db_span = OpenTracing.start_span('mydbspan', :child_of => entry_span)
+db_span.set_tag(:'db.instance', "users")
+db_span.set_tag(:'db.statement', "SELECT * FROM user_table")
+db_span.set_tag(:'db.type', "mysql")
+db_span.set_tag(:'db.user', "mysql_login")
+db_span.set_tag(:'span.kind', "exit")
+db_span.finish()
+
+intermediate_span = OpenTracing.start_span("myintermediate", :child_of => entry_span)
+intermediate_span.log("ALLOK", :message => "All seems ok")
+intermediate_span.finish()
+
+entry_span.set_tag(:'http.status_code', 200)
+entry_span.finish()

data/examples/tracing.rb

@@ -1,6 +1,10 @@
-# This file outlines some of the concepts with Instana tracing.
-# Please also see rdoc for latest info:
-# http://www.rubydoc.info/gems/instana/0.9.0.pre.slywolf3/Instana/Tracer
+# This file outlines the Instana Ruby Tracing API.
+#
+# This same tracer also supports OpenTracing.  See `opentracing.rb` for
+# separate documentation.
+
+# This API is also documented on rubydoc:
+# http://www.rubydoc.info/gems/instana/1.7.8/Instana/Tracer
 
 #######################################
 ## Block tracing
@@ -74,4 +78,3 @@ ensure
 end
 
 Instana::Tracer.log_end(:mywebserver)
-

data/lib/instana/tracing/span.rb

@@ -98,7 +98,7 @@ module Instana
         if HTTP_SPANS.include?(@data[:n])
           set_tags(:http => { :error => "#{e.class}: #{e.message}" })
         else
-          set_tags(:log => { :message => e.message, :parameters => e.class.to_s })
+          log(:error, Time.now, { :message => e.message, :parameters => e.class.to_s })
         end
         e.instance_variable_set(:@instana_logged, true)
       end
@@ -115,6 +115,7 @@ module Instana
     def configure_custom(name)
       @data[:n] = :sdk
       @data[:data] = { :sdk => { :name => name.to_sym } }
+      @data[:data][:sdk][:custom] = { :tags => {}, :logs => {} }
       self
     end
 
@@ -243,6 +244,10 @@ module Instana
       @data[:n] == :sdk
     end
 
+    def inspect
+      @data.inspect
+    end
+
     #############################################################
     # OpenTracing Compatibility Methods
     #############################################################
@@ -266,7 +271,8 @@ module Instana
     def set_tag(key, value)
       if custom?
         @data[:data][:sdk][:custom] ||= {}
-        @data[:data][:sdk][:custom][key] = value
+        @data[:data][:sdk][:custom][:tags] ||= {}
+        @data[:data][:sdk][:custom][:tags][key] = value
 
         if key.to_sym == :'span.kind'
           case value.to_sym
@@ -333,7 +339,7 @@ module Instana
     #
     def tags(key = nil)
       if custom?
-        tags = @data[:data][:sdk][:custom]
+        tags = @data[:data][:sdk][:custom][:tags]
       else
         tags = @data[:data][key]
       end
@@ -347,8 +353,16 @@ module Instana
     # @param timestamp [Time] time of the log
     # @param fields [Hash] Additional information to log
     #
-    def log(event = nil, _timestamp = Time.now, **fields)
-      set_tags(:log => { :message => event, :parameters => fields })
+    def log(event = nil, timestamp = Time.now, **fields)
+      ts = ::Instana::Util.time_to_ms(timestamp).to_s
+      if custom?
+        @data[:data][:sdk][:custom][:logs][ts] = fields
+        @data[:data][:sdk][:custom][:logs][ts][:event] = event
+      else
+        set_tags(:log => fields)
+      end
+    rescue StandardError => e
+      Instana.logger.debug "#{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}"
     end
 
     # Finish the {Span}

data/lib/instana/version.rb

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

data/test/instrumentation/net-http_test.rb

@@ -131,9 +131,10 @@ class NetHTTPTest < Minitest::Test
 
     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)
+    ts_key = first_span[:data][:sdk][:custom][:logs].keys.first
+    assert first_span[:data][:sdk][:custom][:logs].key?(ts_key)
+    assert first_span[:data][:sdk][:custom][:logs][ts_key].key?(:event)
+    assert first_span[:data][:sdk][:custom][:logs][ts_key].key?(:parameters)
 
     WebMock.disable_net_connect!
   end

data/test/test_helper.rb

@@ -8,8 +8,8 @@ require "minitest/spec"
 require "minitest/autorun"
 require "minitest/reporters"
 require "minitest/debugger" if ENV['DEBUG']
-require 'webmock/minitest'
 require "minitest/benchmark"
+require 'webmock/minitest'
 
 require "instana/test"
 ::Instana::Test.setup_environment
@@ -17,10 +17,11 @@ require "instana/test"
 # Boot background webservers to test against.
 require "./test/servers/rackapp_6511"
 
+# Allow localhost calls to the internal rails servers
+::WebMock.disable_net_connect!(allow_localhost: true)
+
 case File.basename(ENV['BUNDLE_GEMFILE'])
 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/
   # Configure gRPC

data/test/tracing/custom_test.rb

@@ -30,8 +30,9 @@ class CustomTracingTest < Minitest::Test
     assert first_span.key?(:data)
     assert first_span[:data].key?(:sdk)
     assert first_span[:data][:sdk].key?(:custom)
+    assert first_span[:data][:sdk][:custom].key?(:tags)
     assert_equal :custom_trace, first_span[:data][:sdk][:name]
-    assert_equal 1, first_span[:data][:sdk][:custom][:one]
+    assert_equal 1, first_span[:data][:sdk][:custom][:tags][:one]
     assert_equal :ruby, first_span[:ta]
 
     assert first_span.key?(:f)
@@ -85,13 +86,14 @@ class CustomTracingTest < Minitest::Test
     assert second_span.key?(:data)
     assert second_span[:data].key?(:sdk)
     assert second_span[:data][:sdk].key?(:custom)
+    assert second_span[:data][:sdk][:custom].key?(:tags)
     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]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_entry_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_info_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_exit_kv]
   end
 
   def test_custom_tracing_with_error
@@ -148,13 +150,14 @@ class CustomTracingTest < Minitest::Test
     assert second_span.key?(:data)
     assert second_span[:data].key?(:sdk)
     assert second_span[:data][:sdk].key?(:custom)
+    assert second_span[:data][:sdk][:custom].key?(:tags)
     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]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_entry_kv]
+    assert !second_span[:data][:sdk][:custom][:tags].key?(:on_info_kv)
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:on_exit_kv]
 
     # Check the error
     assert_equal true, second_span[:error]

data/test/tracing/opentracing_test.rb

@@ -213,7 +213,7 @@ class OpenTracerTest < Minitest::Test
     span[:data][:sdk].delete(:type)
     span.set_tag(:'span.kind', :blah)
     assert_equal false, span[:data][:sdk].key?(:type)
-    assert_equal :blah, span[:data][:sdk][:custom][:'span.kind']
+    assert_equal :blah, span[:data][:sdk][:custom][:tags][:'span.kind']
 
     span.finish
   end
@@ -250,6 +250,9 @@ class OpenTracerTest < Minitest::Test
 
     assert_equal ts_start_ms, span[:ts]
     assert_equal (ts_finish_ms - ts_start_ms), span[:d]
+
+    assert_equal 1234, span[:data][:sdk][:custom][:tags][:start_tag]
+    assert_equal 'tag_value', span[:data][:sdk][:custom][:tags][:another_tag]
   end
 
   def test_nested_spans_using_child_of

data/test/tracing/tracer_async_test.rb

@@ -45,8 +45,8 @@ class TracerAsyncTest < Minitest::Test
     # KV checks
     assert_equal 1, first_span[:data][:rack_start_kv]
     assert_equal 1, first_span[:data][:rack_end_kv]
-    assert_equal 1, second_span[:data][:sdk][:custom][:entry_kv]
-    assert_equal 1, second_span[:data][:sdk][:custom][:exit_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:entry_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:exit_kv]
   end
 
   def test_diff_thread_async_tracing
@@ -103,14 +103,14 @@ class TracerAsyncTest < Minitest::Test
     # first span in second trace
     assert_equal :async_thread, first_span.name
     assert first_span.duration
-    assert_equal 1, first_span[:data][:sdk][:custom][:async_start]
-    assert_equal 1, first_span[:data][:sdk][:custom][:async_end]
+    assert_equal 1, first_span[:data][:sdk][:custom][:tags][:async_start]
+    assert_equal 1, first_span[:data][:sdk][:custom][:tags][:async_end]
 
     # second span in second trace
     assert_equal :sleepy_time, second_span.name
     assert second_span.duration
-    assert_equal 1, second_span[:data][:sdk][:custom][:tired]
-    assert_equal 1, second_span[:data][:sdk][:custom][:wake_up]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:tired]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:wake_up]
 
     # Validate linkage
     # first_span is the parent of first_span
@@ -169,8 +169,8 @@ class TracerAsyncTest < Minitest::Test
 
     # second span validation
     assert_equal :my_async_op, second_span.name
-    assert_equal 1, second_span[:data][:sdk][:custom][:async_entry_kv]
-    assert !second_span[:data][:sdk][:custom].key?(:async_exit_kv)
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:async_entry_kv]
+    assert !second_span[:data][:sdk][:custom][:tags].key?(:async_exit_kv)
     assert_equal nil, second_span.duration
 
     # first_span is the parent of first_span
@@ -252,12 +252,12 @@ class TracerAsyncTest < Minitest::Test
     # KV checks
     assert_equal 1, first_span[:data][:rack_start_kv]
     assert_equal 1, first_span[:data][:rack_end_kv]
-    assert_equal 1, second_span[:data][:sdk][:custom][:entry_kv]
-    assert_equal 1, second_span[:data][:sdk][:custom][:exit_kv]
-    assert_equal 2, third_span[:data][:sdk][:custom][:entry_kv]
-    assert_equal 2, third_span[:data][:sdk][:custom][:exit_kv]
-    assert_equal 3, fourth_span[:data][:sdk][:custom][:entry_kv]
-    assert_equal 3, fourth_span[:data][:sdk][:custom][:exit_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:entry_kv]
+    assert_equal 1, second_span[:data][:sdk][:custom][:tags][:exit_kv]
+    assert_equal 2, third_span[:data][:sdk][:custom][:tags][:entry_kv]
+    assert_equal 2, third_span[:data][:sdk][:custom][:tags][:exit_kv]
+    assert_equal 3, fourth_span[:data][:sdk][:custom][:tags][:entry_kv]
+    assert_equal 3, fourth_span[:data][:sdk][:custom][:tags][:exit_kv]
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: instana
 version: !ruby/object:Gem::Version
-  version: 1.7.8
+  version: 1.7.9
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,6 +192,7 @@ files:
 - benchmarks/time_processing.rb
 - bin/console
 - bin/setup
+- examples/opentracing.rb
 - examples/tracing.rb
 - gemfiles/libraries.gemfile
 - gemfiles/rails32.gemfile