Otel migration

Gemfile

@@ -15,3 +15,8 @@ gem 'simplecov', '~> 0.21.2'
 
 # instana.gemspec
 gemspec
+
+gem "opentelemetry-api", "~> 1.4"
+
+gem "rubocop", "~> 1.71"
+gem "opentelemetry-common", "~> 0.22.0"

Rakefile

@@ -22,7 +22,7 @@ Rake::TestTask.new(:test) do |t|
   else
     t.test_files = Dir[
       'test/*_test.rb',
-      'test/{agent,tracing,backend,snapshot}/*_test.rb'
+      'test/{agent,trace,backend,snapshot}/*_test.rb'
     ]
   end
 end

examples/opentracing.rb → examples/otel.rb

@@ -17,19 +17,19 @@
 entry_span.set_tag(:'span.kind', "entry")
 
 intermediate_span = OpenTracing.start_span("myintermediate", :child_of => entry_span)
-intermediate_span.finish()
+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()
+db_span.finish
 
 intermediate_span = OpenTracing.start_span("myintermediate", :child_of => entry_span)
 intermediate_span.log("ALLOK", :message => "All seems ok")
-intermediate_span.finish()
+intermediate_span.finish
 
 entry_span.set_tag(:'http.status_code', 200)
-entry_span.finish()
+entry_span.finish

examples/tracing.rb

@@ -1,5 +1,6 @@
 # This file outlines the Instana Ruby Tracing API.
 #
+# Replace the below line once otel based standards are implemended
 # This same tracer also supports OpenTracing.  See `opentracing.rb` for
 # separate documentation.
 

instana.gemspec

@@ -47,5 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency('concurrent-ruby', '>= 1.1')
   spec.add_runtime_dependency('csv', '>= 0.1')
   spec.add_runtime_dependency('sys-proctable', '>= 1.2.2')
+  spec.add_runtime_dependency('opentelemetry-api', '~> 1.4')
+  spec.add_runtime_dependency('opentelemetry-common')
   spec.add_runtime_dependency('oj', '>=3.0.11') unless RUBY_PLATFORM =~ /java/i
 end

lib/instana/base.rb

@@ -14,6 +14,7 @@ class << self
     attr_accessor :pid
     attr_reader :secrets
     attr_reader :serverless
+    attr_accessor :tracer_provider
 
     ##
     # setup
@@ -22,8 +23,9 @@ class << self
     # to run" state.
     #
     def setup
-      @agent  = ::Instana::Backend::Agent.new
-      @tracer = ::Instana::Tracer.new
+      @agent = ::Instana::Backend::Agent.new
+      @tracer_provider = ::Instana::Trace::TracerProvider.new
+      @tracer = @tracer_provider.tracer('instana_tracer')
       @processor = ::Instana::Processor.new
       @secrets = ::Instana::Secrets.new
       @serverless = ::Instana::Serverless.new

lib/instana/instrumentation/action_cable.rb

@@ -27,8 +27,10 @@ def transmit(data, via: nil)
         }
 
         context = connection.instana_trace_context
-        ::Instana.tracer.start_or_continue_trace(:'rpc-server', rpc_tags, context) do
-          super(data, via: via)
+        Trace.with_span(OpenTelemetry::Trace.non_recording_span(context)) do
+          ::Instana.tracer.in_span(:'rpc-server', attributes: rpc_tags) do
+            super(data, via: via)
+          end
         end
       end
 
@@ -44,8 +46,10 @@ def dispatch_action(action, data)
         }
 
         context = connection.instana_trace_context
-        ::Instana.tracer.start_or_continue_trace(:'rpc-server', rpc_tags, context) do
-          super(action, data)
+        Trace.with_span(OpenTelemetry::Trace.non_recording_span(context)) do
+          ::Instana.tracer.in_span(:'rpc-server', attributes: rpc_tags) do
+            super(action, data)
+          end
         end
       end
     end

lib/instana/instrumentation/action_controller.rb

@@ -11,9 +11,8 @@ def process_action(*args)
             action: action_name
           }
         }
-
         request.env['INSTANA_HTTP_PATH_TEMPLATE'] = matched_path_template
-        ::Instana::Tracer.trace(:actioncontroller, call_payload) { super(*args) }
+        ::Instana.tracer.in_span(:actioncontroller, attributes: call_payload) { super(*args) }
       end
 
       def render(*args, &block)
@@ -22,8 +21,7 @@ def render(*args, &block)
             name: describe_render_options(args.first) || 'Default'
           }
         }
-
-        ::Instana::Tracer.trace(:actionview, call_payload) { super(*args, &block) }
+        ::Instana.tracer.in_span(:actionview, attributes: call_payload) { super(*args, &block) }
       end
 
       private

lib/instana/instrumentation/action_mailer.rb

@@ -12,7 +12,7 @@ def method_missing(method_name, *args) # rubocop:disable Style/MissingRespondToM
               method: method_name.to_s
             }
           }
-          Instana::Tracer.trace(:'mail.actionmailer', tags) { super }
+          Instana.tracer.in_span(:'mail.actionmailer', attributes: tags) { super }
         else
           super
         end

lib/instana/instrumentation/action_view.rb

@@ -13,7 +13,7 @@ def render_partial(*args)
             }
           }
 
-          ::Instana::Tracer.trace(:render, call_payload) { super(*args) }
+          ::Instana.tracer.in_span(:render, attributes: call_payload) { super(*args) }
         end
 
         def render_collection(*args)
@@ -24,7 +24,7 @@ def render_collection(*args)
             }
           }
 
-          ::Instana::Tracer.trace(:render, call_payload) { super(*args) }
+          ::Instana.tracer.in_span(:render, attributes: call_payload) { super(*args) }
         end
 
         def render_partial_template(*args)
@@ -35,7 +35,7 @@ def render_partial_template(*args)
             }
           }
 
-          ::Instana::Tracer.trace(:render, call_payload) { super(*args) }
+          ::Instana.tracer.in_span(:render, attributes: call_payload) { super(*args) }
         end
       end
 
@@ -48,7 +48,7 @@ def render_collection(*args)
             }
           }
 
-          ::Instana::Tracer.trace(:render, call_payload) { super(*args) }
+          ::Instana.tracer.in_span(:render, attributes: call_payload) { super(*args) }
         end
       end
     end

lib/instana/instrumentation/active_job.rb

@@ -1,5 +1,19 @@
 # (c) Copyright IBM Corp. 2021
 # (c) Copyright Instana Inc. 2021
+module OpenTelemetry
+  module Trace
+    module Propagation
+      module TraceContext
+        # A TraceParent is an implementation of the W3C trace context specification
+        # https://www.w3.org/TR/trace-context/
+        # {Trace::SpanContext}
+        class TraceParent
+          REGEXP = /^(?<version>[A-Fa-f0-9]{2})-(?<trace_id>[A-Fa-f0-9]{32})-(?<span_id>[A-Fa-f0-9]{32})-(?<flags>[A-Fa-f0-9]{2})(?<ignored>-.*)?$/
+        end
+      end
+    end
+  end
+end
 
 module Instana
   module Instrumentation
@@ -15,7 +29,7 @@ def self.prepended(target)
             }
           }
 
-          ::Instana::Tracer.trace(:activejob, tags) do
+          ::Instana.tracer.in_span(:activejob, attributes: tags) do
             context = ::Instana.tracer.context
             job.arguments.append({
                                    instana_context: context ? context.to_hash : nil
@@ -37,11 +51,12 @@ def self.prepended(target)
           incoming_context = if job.arguments.is_a?(Array) && job.arguments.last.is_a?(Hash) && job.arguments.last.key?(:instana_context)
                                instana_context = job.arguments.last[:instana_context]
                                job.arguments.pop
-                               instana_context ? ::Instana::SpanContext.new(instana_context[:trace_id], instana_context[:span_id]) : nil
+                               instana_context ? ::Instana::SpanContext.new(trace_id: instana_context[:trace_id], span_id: instana_context[:span_id]) : nil
                              end
-
-          ::Instana::Tracer.start_or_continue_trace(:activejob, tags, incoming_context) do
-            block.call
+          Trace.with_span(OpenTelemetry::Trace.non_recording_span(incoming_context)) do
+            ::Instana.tracer.in_span(:activejob, attributes: tags) do
+              block.call
+            end
           end
         end
       end

lib/instana/instrumentation/active_record.rb

@@ -35,7 +35,7 @@ def maybe_sanitize(sql)
 
       def maybe_trace(call_payload, name, &blk)
         if ::Instana.tracer.tracing? && !ignored?(call_payload, name)
-          ::Instana.tracer.trace(:activerecord, call_payload, &blk)
+          ::Instana.tracer.in_span(:activerecord, attributes: call_payload, &blk)
         else
           yield
         end

lib/instana/instrumentation/aws_sdk_dynamodb.rb

@@ -11,7 +11,7 @@ def call(context)
             table: table_name_from(context)
           }
 
-          ::Instana.tracer.trace(:dynamodb, {dynamodb: dynamo_tags}) { @handler.call(context) }
+          ::Instana.tracer.in_span(:dynamodb, attributes: {dynamodb: dynamo_tags}) { @handler.call(context) }
         end
 
         private

lib/instana/instrumentation/aws_sdk_lambda.rb

@@ -25,7 +25,7 @@ def call(context)
             type: context.params[:invocation_type]
           }.reject { |_, v| v.nil? }
 
-          ::Instana.tracer.start_or_continue_trace(:"aws.lambda.invoke", {aws: {lambda: {invoke: tags}}}) do
+          ::Instana.tracer.in_span(:"aws.lambda.invoke", attributes: {aws: {lambda: {invoke: tags}}}) do
             response = @handler.call(context)
             if response.respond_to? :status_code
               ::Instana.tracer.log_info(:http => {:status => response.status_code })

lib/instana/instrumentation/aws_sdk_s3.rb

@@ -12,7 +12,7 @@ def call(context)
             key: key_from_context(context)
           }.reject { |_, v| v.nil? }
 
-          ::Instana.tracer.trace(:s3, {s3: s3_tags}) { @handler.call(context) }
+          ::Instana.tracer.in_span(:s3, attributes: {s3: s3_tags}) { @handler.call(context) }
         end
 
         private

lib/instana/instrumentation/aws_sdk_sns.rb

@@ -14,7 +14,7 @@ def call(context)
           }.reject { |_, v| v.nil? }
 
           if context.operation_name == :publish
-            ::Instana.tracer.trace(:sns, {sns: sns_tags}) { @handler.call(context) }
+            ::Instana.tracer.in_span(:sns, attributes: {sns: sns_tags}) { @handler.call(context) }
           else
             @handler.call(context)
           end

lib/instana/instrumentation/aws_sdk_sqs.rb

@@ -15,7 +15,7 @@ def call(context)
 
           span_tags = tags_for(context.operation_name, context.params).reject { |_, v| v.nil? }
 
-          ::Instana.tracer.trace(:sqs, {sqs: span_tags}) do |span|
+          ::Instana.tracer.in_span(:sqs, attributes: {sqs: span_tags}) do |span|
             case context.operation_name
             when :send_message
               inject_instana_headers(span, context.params)

lib/instana/instrumentation/dalli.rb

@@ -17,7 +17,7 @@ def perform(*args, &blk)
         entry_payload[:memcache][:command] = op
         entry_payload[:memcache][:key] = key
 
-        ::Instana.tracer.log_entry(:memcache, entry_payload)
+        ::Instana.tracer.start_span(:memcache, attributes: entry_payload)
         exit_payload = { :memcache => {} }
 
         result = super(*args, &blk)

lib/instana/instrumentation/excon.rb

@@ -16,10 +16,10 @@ def request_call(datum)
         if datum[:pipeline] == true
           # Pass the context along in the datum so we get back on response
           # and can close out the async span
-          datum[:instana_span] = ::Instana.tracer.log_async_entry(:excon, payload)
+          datum[:instana_span] = ::Instana.tracer.start_span(:excon, attributes: payload)
           t_context = datum[:instana_span].context
         else
-          ::Instana.tracer.log_entry(:excon, payload)
+          ::Instana.tracer.start_span(:excon, attributes: payload)
           t_context = ::Instana.tracer.context
         end
 

lib/instana/instrumentation/graphql.rb

@@ -35,13 +35,13 @@ def platform_trace(platform_key, key, data)
         }
 
         begin
-          ::Instana.tracer.log_entry(:'graphql.server')
+          span = ::Instana.tracer.start_span(:'graphql.server', attributes: {graphql: payload})
           yield
         rescue Exception => e
-          ::Instana.tracer.log_error(e)
+          span.record_exception(e)
           raise e
         ensure
-          ::Instana.tracer.log_exit(:'graphql.server', {graphql: payload})
+          span.finish
         end
       end
 

lib/instana/instrumentation/grpc.rb

@@ -22,7 +22,7 @@ module GRPCCientInstrumentation
             kvs[:rpc][:call] = method
             kvs[:rpc][:call_type] = call_type
 
-            ::Instana.tracer.log_entry(:'rpc-client', kvs)
+            current_span = ::Instana.tracer.start_span(:'rpc-client', attributes: kvs)
 
             context = ::Instana.tracer.context
             if context
@@ -35,11 +35,11 @@ module GRPCCientInstrumentation
             super(method, *others, **options)
           rescue => e
             kvs[:rpc][:error] = true
-            ::Instana.tracer.log_info(kvs)
-            ::Instana.tracer.log_error(e)
+            current_span.set_tags(kvs)
+            current_span.record_exception(e)
             raise
           ensure
-            ::Instana.tracer.log_exit(:'rpc-client', {})
+            current_span.finish
           end
         end
       end
@@ -60,9 +60,9 @@ module GRPCServerInstrumentation
 
             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')
+              incoming_context = SpanContext.new(trace_id: ::Instana::Util.header_to_id(metadata['x-instana-t']),
+                                                 span_id: metadata.key?('x-instana-s') ? ::Instana::Util.header_to_id(metadata['x-instana-s']) : nil,
+                                                 level: metadata.key?('x-instana-l') ? metadata['x-instana-l'] : nil)
             end
 
             kvs[:rpc][:flavor] = :grpc
@@ -71,18 +71,19 @@ module GRPCServerInstrumentation
             kvs[:rpc][:call_type] = call_type
             kvs[:rpc][:peer] = { address: active_call.peer }
 
-            ::Instana.tracer.log_start_or_continue(
-              :'rpc-server', kvs, incoming_context
-            )
+            span = OpenTelemetry::Trace.non_recording_span(incoming_context) if incoming_context
+            parent_context = Trace.context_with_span(span) if incoming_context
+
+            current_span = ::Instana.tracer.start_span(:'rpc-server', attributes: kvs, with_parent: parent_context)
 
             super(active_call, mth, *others)
           rescue => e
             kvs[:rpc][:error] = true
-            ::Instana.tracer.log_info(kvs)
-            ::Instana.tracer.log_error(e)
+            current_span.set_tags(kvs)
+            current_span.record_exception(e)
             raise
           ensure
-            ::Instana.tracer.log_end(:'rpc-server', {}) if ::Instana.tracer.tracing?
+            current_span.finish if ::Instana.tracer.tracing?
           end
         end
       end

lib/instana/instrumentation/mongo.rb

@@ -20,19 +20,19 @@ def started(event)
         json: filter_statement(event.command)
       }
 
-      @requests[event.request_id] = ::Instana.tracer.log_async_entry(:mongo, {mongo: tags})
+      @requests[event.request_id] = ::Instana.tracer.start_span(:mongo, attributes: {mongo: tags})
     end
 
     def failed(event)
       span = @requests.delete(event.request_id)
       span.add_error(Exception.new(event.message))
 
-      ::Instana.tracer.log_async_exit(:mongo, {}, span)
+      span.finish
     end
 
     def succeeded(event)
       span = @requests.delete(event.request_id)
-      ::Instana.tracer.log_async_exit(:mongo, {}, span)
+      span.finish
     end
 
     private