solarwinds_apm 6.0.0.preV2 → 6.0.0.preV3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f218890396745c5ba75f0819fa07e3717014fe7aa4072136cf62c23bcbadf34
-  data.tar.gz: b02cde4d6b896bc60da7fe2c1ab67fd01500a97073d6b67cae497eca70773fa7
+  metadata.gz: 6ac8eac87b0a75af0fc92b5f220fd70393a893b1b3291b013d11e5dfa29ee99e
+  data.tar.gz: 2fc862e44f562b7d29c85cd7b54fcb490c4ba5c8575f817a4d65d6cf9914479b
 SHA512:
-  metadata.gz: f699da24367449958aaff9900c3a0e6ef312917a98df5eda9fd7694a7ccf0f4b27a4f9ff02c3b855d89f2360215b6b0e0b3cfcb541f3b34cc05f7c6de468520f
-  data.tar.gz: 65b88f0502aadd4e1e0fda69e39c73350efc100c5a64d226ccd474aa11409af8fd40a5ee1f5735516a2fd7ac5fc20fb16e5f8140c2550029bf8fafdd049d0002
+  metadata.gz: 3f08999c45b7fe14c224df1af5bd4fc83ba9efd21fb4d6bac5ec36bfe437448ce0622ce8997e9acf47c90010fda716a1f92f35b7336b41fb29ac33ded939abfa
+  data.tar.gz: 2e9dc14242b180518bf23d39db3c8f93dde26855fc5a9ee356a7d712ac624e0939adf5390f02770a1bd56d38fa34d9cb91566d7747e073982514e9ae6e09b380

data/ext/oboe_metal/lib/liboboe-1.0-aarch64.so.sha256

@@ -1 +1 @@
-b931c715d8ddaa9f2b91c72ad708ed3467e6e68ee4255756123b2ca96f1b98d0
+86a0c98301b157fd2ec184e585d70e40753c721c52fbc596ab09aa3d422d5f1f

data/ext/oboe_metal/lib/liboboe-1.0-alpine-aarch64.so.sha256

@@ -1 +1 @@
-c8189fe6f5b31c15c31d3b005aebcff90f97ff82e92d9e0d3b254bbbe2a7367d
+534122daed4a1a81a9e66828f206662ea8f6bf891fb84438cc3daef5f78a7af4

data/ext/oboe_metal/lib/liboboe-1.0-alpine-x86_64.so.sha256

@@ -1 +1 @@
-2824ba630ba794ff6280358922b54e8e1be4ccdb145376f90601e6652d149525
+89936e04f0b8cddf3fb94c8a4c21d16aa780d6e4fbf4bb66eba42eb33fe15cc6

data/ext/oboe_metal/lib/liboboe-1.0-x86_64.so.sha256

@@ -1 +1 @@
-82a003ec82e3703260cdc215ef4c0c0bc7bc916cef27ef509034b60fd5ef9b35
+623f5b308759754c8d771567d5346c46e1d9b53739995a9b5594cc08f8bc6e54

data/ext/oboe_metal/src/VERSION

@@ -1,2 +1 @@
-12.4.0
-
+13.0.0

data/ext/oboe_metal/src/oboe.h

@@ -432,16 +432,6 @@ int oboe_init_reporter(const char *protocol, oboe_init_options_t *options);
  */
 int oboe_init_options_set_defaults(oboe_init_options_t *options);
 
-/**
- * Disconnect or shut down the Oboe reporter, but allow it to be reconnect()ed.
- */
-void oboe_reporter_disconnect();    /* TODO: Need implementation. */
-
-/**
- * Reconnect or restart the Oboe reporter.
- */
-void oboe_reporter_reconnect();     /* TODO: Need implementation. */
-
 /**
  * tell reporter to flush all messages that are currently buffered
  */
@@ -712,8 +702,6 @@ void oboe_settings_rate_set(int sample_rate);
 void oboe_settings_mode_set(int tracing_mode);
 void oboe_settings_trigger_set(int trigger_mode);
 
-int oboe_rand_get_value();
-
 /**
  * Convert a tracing mode to a printable string.
  */

data/ext/oboe_metal/src/oboe_swig_wrap.cc

@@ -1932,7 +1932,7 @@ SWIG_ruby_failed(VALUE SWIGUNUSEDPARM(arg1), VALUE SWIGUNUSEDPARM(arg2))
 } 
 
 
-/*@SWIG:/usr/local/share/swig/4.0.2/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
+/*@SWIG:/usr/share/swig4.0/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
 SWIGINTERN VALUE SWIG_AUX_NUM2LONG(VALUE arg)
 {
   VALUE *args = (VALUE *)arg;
@@ -2120,7 +2120,7 @@ SWIG_From_std_string  (const std::string& s)
   #define SWIG_From_double   rb_float_new 
 
 
-/*@SWIG:/usr/local/share/swig/4.0.2/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
+/*@SWIG:/usr/share/swig4.0/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
 SWIGINTERN VALUE SWIG_AUX_NUM2ULONG(VALUE arg)
 {
   VALUE *args = (VALUE *)arg;
@@ -2172,7 +2172,7 @@ SWIG_AsVal_unsigned_SS_int (VALUE obj, unsigned int *val)
 
 
 #ifdef SWIG_LONG_LONG_AVAILABLE
-/*@SWIG:/usr/local/share/swig/4.0.2/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
+/*@SWIG:/usr/share/swig4.0/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
 SWIGINTERN VALUE SWIG_AUX_NUM2LL(VALUE arg)
 {
   VALUE *args = (VALUE *)arg;
@@ -2203,7 +2203,7 @@ SWIG_AsVal_long_SS_long (VALUE obj, long long *val)
 #endif
 
 
-/*@SWIG:/usr/local/share/swig/4.0.2/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
+/*@SWIG:/usr/share/swig4.0/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
 SWIGINTERN VALUE SWIG_AUX_NUM2DBL(VALUE arg)
 {
   VALUE *args = (VALUE *)arg;
@@ -2234,7 +2234,7 @@ SWIG_AsVal_double (VALUE obj, double *val)
 
 
 #ifdef SWIG_LONG_LONG_AVAILABLE
-/*@SWIG:/usr/local/share/swig/4.0.2/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
+/*@SWIG:/usr/share/swig4.0/ruby/rubyprimtypes.swg,19,%ruby_aux_method@*/
 SWIGINTERN VALUE SWIG_AUX_NUM2ULL(VALUE arg)
 {
   VALUE *args = (VALUE *)arg;

data/lib/rails/generators/solarwinds_apm/templates/solarwinds_apm_initializer.rb

@@ -107,11 +107,7 @@ if defined?(SolarWindsAPM::Config)
   #
   # Currently allowed array of hash
   #
-  # and the hashes within the :url list either:
-  #   :extensions  takes an array of strings for filtering (not regular expressions!)
-  #   :tracing     defaults to :disabled, can be set to :enabled to override
-  #              the global :disabled setting
-  # or:
+  # and the hashes within the :transaction_settings list:
   #   :regexp      is a regular expression that is applied to the incoming path
   #   :opts        (optional) nil(default) or Regexp::IGNORECASE (options for regexp)
   #   :tracing     defaults to :disabled, can be set to :enabled to override
@@ -121,10 +117,6 @@ if defined?(SolarWindsAPM::Config)
   # down execution.
   #
   SolarWindsAPM::Config[:transaction_settings] = [
-    #   {
-    #     extensions: %w[long_job],
-    #     tracing: :disabled
-    #   },
     #   {
     #     regexp: '^.*\/long_job\/.*$',
     #     opts: Regexp::IGNORECASE,

data/lib/solarwinds_apm/api/current_trace_info.rb

@@ -108,7 +108,6 @@ module SolarWindsAPM
           span_id  = span.context.hex_span_id
           trace_flags = span.context.trace_flags.sampled?? '01' : '00'
           tracestring = "00-#{trace_id}-#{span_id}-#{trace_flags}"
-          
           [trace_id, span_id, trace_flags, tracestring]
         end
 

data/lib/solarwinds_apm/api/opentelemetry.rb

@@ -0,0 +1,39 @@
+module SolarWindsAPM
+  module API
+    module OpenTelemetry
+      # Create custom span based on current last span
+      #
+      # Wrap OpenTelemetry function OpenTelemetry.tracer_provider.tracer.in_span
+      #
+      # === Argument:
+      #
+      # * +name+ - (int, default 3000) the maximum time to wait in milliseconds
+      # * +attributes+ - (hash, default nil)
+      # * +links+ - (string, default nil)
+      # * +start_timestamp+ - (int, default nil)
+      # * +kind+ - (symbol, default nil)
+      #
+      # === Example:
+      #
+      #   SolarWindsAPM::API.in_span('custom_span') do |span|
+      #     url = URI.parse("http://www.google.ca/")
+      #     req = Net::HTTP::Get.new(url.to_s)
+      #     res = Net::HTTP.start(url.host, url.port) {|http| http.request(req)}
+      #   end
+      # 
+      # === Returns:
+      # * Objective
+      #
+      def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil, &block)
+        if block.nil?
+          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] please provide block when using in_span function"}
+          return
+        end
+
+        SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] solarwinds_apm in_span with OTEL_SERVICE_NAME #{ENV['OTEL_SERVICE_NAME']}"}
+        current_tracer = ::OpenTelemetry.tracer_provider.tracer(ENV['OTEL_SERVICE_NAME'])
+        current_tracer.in_span(name, attributes: attributes, links: links, start_timestamp: start_timestamp, kind: kind, &block)
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/api/transaction_name.rb

@@ -31,27 +31,27 @@ module SolarWindsAPM
       #
       def set_transaction_name(custom_name=nil)
         
-        return false if custom_name.nil? || custom_name.empty? 
-        return true  if SolarWindsAPM::Context.toString == '00-00000000000000000000000000000000-0000000000000000-00' # noop
-
-        solarwinds_processor = SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor]
-        if solarwinds_processor.nil?
+        status = true
+        if custom_name.nil? || custom_name.empty? 
+          status = false
+        elsif SolarWindsAPM::Context.toString == '99-00000000000000000000000000000000-0000000000000000-00' # noop
+          status = true
+        elsif SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor].nil?
           SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Solarwinds processor is missing. Set transaction name failed."}
-          return false
-        end
+          status = false
+        else
+          solarwinds_processor       = SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor]
+          current_span               = ::OpenTelemetry::Trace.current_span
+          entry_trace_id             = current_span.context.hex_trace_id
+          entry_span_id, trace_flags = solarwinds_processor.txn_manager.get_root_context_h(entry_trace_id)&.split('-')
 
-        entry_trace_id = ::OpenTelemetry::Baggage.value(::SolarWindsAPM::Constants::INTL_SWO_CURRENT_TRACE_ID)
-        entry_span_id  = ::OpenTelemetry::Baggage.value(::SolarWindsAPM::Constants::INTL_SWO_CURRENT_SPAN_ID)
+          status = false if entry_trace_id.nil? || entry_span_id.nil? || trace_flags.nil?
+          status = false if entry_trace_id == '0'*32 || entry_span_id == '0'*16 || trace_flags == '00' # not sampled
 
-        if entry_trace_id.nil? || entry_span_id.nil? 
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Cannot cache custom transaction name #{custom_name} because OTel service entry span not started; ignoring"}
-          return false
+          solarwinds_processor.txn_manager.set("#{entry_trace_id}-#{entry_span_id}",custom_name) 
+          SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Cached custom transaction name for #{entry_trace_id}-#{entry_span_id} as #{custom_name}"}
         end
-
-        trace_span_id = "#{entry_trace_id}-#{entry_span_id}"
-        solarwinds_processor.txn_manager.set(trace_span_id,custom_name) 
-        SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Cached custom transaction name for #{trace_span_id} as #{custom_name}"}
-        true
+        status
       end
     end
   end

data/lib/solarwinds_apm/api.rb

@@ -4,11 +4,13 @@
 require_relative './api/transaction_name'
 require_relative './api/current_trace_info'
 require_relative './api/tracing'
+require_relative './api/opentelemetry'
 
 module SolarWindsAPM
   module API
     extend SolarWindsAPM::API::TransactionName
     extend SolarWindsAPM::API::CurrentTraceInfo
     extend SolarWindsAPM::API::Tracing
+    extend SolarWindsAPM::API::OpenTelemetry
   end
 end

data/lib/solarwinds_apm/config.rb

@@ -176,7 +176,7 @@ module SolarWindsAPM
 
       # `tracing: disabled` is the default
       disabled = settings.select { |v| !v.has_key?(:tracing) || v[:tracing] == :disabled }
-      enabled = settings.select { |v| v[:tracing] == :enabled }
+      enabled  = settings.select { |v| v[:tracing] == :enabled }
 
       SolarWindsAPM::Config[:enabled_regexps] = compile_regexp(enabled)
       SolarWindsAPM::Config[:disabled_regexps] = compile_regexp(disabled)
@@ -184,11 +184,8 @@ module SolarWindsAPM
     private_class_method :compile_settings
 
     def self.compile_regexp(settings)
-      regexp_regexp     = compile_settings_regexp(settings)
-      extensions_regexp = compile_settings_extensions(settings)
-
-      regexps = [regexp_regexp, extensions_regexp].flatten.compact
-
+      regexp_regexp = compile_settings_regexp(settings)
+      regexps       = [regexp_regexp].flatten.compact
       regexps.empty? ? nil : regexps
     end
     private_class_method :compile_regexp
@@ -213,19 +210,6 @@ module SolarWindsAPM
     end
     private_class_method :compile_settings_regexp
 
-    def self.compile_settings_extensions(value)
-      extensions = value.select do |v|
-        v.has_key?(:extensions) &&
-          v[:extensions].is_a?(Array) &&
-          !v[:extensions].empty?
-      end
-      extensions = extensions.map { |v| v[:extensions] }.flatten
-      extensions.keep_if { |v| v.is_a?(String) }
-
-      extensions.empty? ? nil : Regexp.new("(#{Regexp.union(extensions).source})(\\?.+){0,1}$")
-    end
-    private_class_method :compile_settings_extensions
-
     def self.reset_regexps
       SolarWindsAPM::Config[:enabled_regexps] = nil
       SolarWindsAPM::Config[:disabled_regexps] = nil

data/lib/solarwinds_apm/constants.rb

@@ -20,12 +20,10 @@ module SolarWindsAPM
     INTL_SWO_PROPAGATOR              = "solarwinds_propagator".freeze
     INTL_SWO_DEFAULT_PROPAGATORS     = [INTL_SWO_TRACECONTEXT_PROPAGATOR, "baggage",INTL_SWO_PROPAGATOR].freeze
     INTL_SWO_SUPPORT_EMAIL           = "SWO-support@solarwinds.com".freeze
-    INTL_SWO_CURRENT_SPAN_ID         = "sw-current-entry-span-id".freeze
-    INTL_SWO_CURRENT_TRACE_ID        = "sw-current-trace-id".freeze
-    INTL_SWO_CURRENT_TRACE_FLAG      = "sw-current-trace-flag".freeze
-
     INTL_SWO_OTEL_SCOPE_NAME         = "otel.scope.name".freeze
     INTL_SWO_OTEL_SCOPE_VERSION      = "otel.scope.version".freeze
+    INTL_SWO_OTEL_STATUS             = "otel.status".freeze
+    INTL_SWO_OTEL_STATUS_DESCRIPTION = "otel.status_description".freeze
 
     INTERNAL_TRIGGERED_TRACE         = "TriggeredTrace".freeze
   end

data/lib/solarwinds_apm/noop/context.rb

@@ -12,7 +12,7 @@ module SolarWindsAPM
     # toString would return the current trace context as string
     #
     def self.toString
-      '00-00000000000000000000000000000000-0000000000000000-00'
+      '99-00000000000000000000000000000000-0000000000000000-00'
     end
 
     ##

data/lib/solarwinds_apm/oboe_init_options.rb

@@ -213,11 +213,8 @@ module SolarWindsAPM
     end
 
     def read_certificates
-      file = String.new
-      file = "#{__dir__}/cert/star.appoptics.com.issuer.crt" if appoptics_collector?
-      file = ENV['SW_APM_TRUSTEDPATH'] if !ENV['SW_APM_TRUSTEDPATH'].nil? && !ENV['SW_APM_TRUSTEDPATH']&.empty?
-
-      return file if file.empty?
+      file = appoptics_collector?? "#{__dir__}/cert/star.appoptics.com.issuer.crt" : ENV['SW_APM_TRUSTEDPATH']
+      return String.new if file.nil? || file&.empty?
 
       begin
         certificate = File.open(file,"r").read

data/lib/solarwinds_apm/opentelemetry/solarwinds_exporter.rb

@@ -19,12 +19,13 @@ module SolarWindsAPM
 
       def export(span_data, _timeout: nil)
         return FAILURE if @shutdown
-        
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] span_data: #{span_data}"}
+
+        status = SUCCESS
         span_data.each do |data|
-          log_span_data(data)
+          status = log_span_data(data)
         end
-        SUCCESS
+
+        status
       end
 
       def force_flush(timeout: nil) # rubocop:disable Lint/UnusedMethodArgument
@@ -39,64 +40,63 @@ module SolarWindsAPM
       private
 
       def log_span_data(span_data)
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] span_data: #{span_data.inspect}\n"}
+
+        md = build_meta_data(span_data)
+        event = nil
+        if span_data.parent_span_id != ::OpenTelemetry::Trace::INVALID_SPAN_ID 
+          parent_md = build_meta_data(span_data, parent: true)
+          event = @context.createEntry(md, (span_data.start_timestamp.to_i / 1000).to_i, parent_md)
+          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] Continue trace from parent metadata: #{parent_md.toString}."}
+        else
+          event = @context.createEntry(md, (span_data.start_timestamp.to_i / 1000).to_i) 
+          add_info_transaction_name(span_data, event)
+          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] Start a new trace."}
+        end
+        
+        layer_name = "#{span_data.kind}:#{span_data.name}"
+        event.addInfo('Layer', layer_name)
+        event.addInfo('sw.span_kind', span_data.kind.to_s)
+        event.addInfo('Language', 'Ruby')
+        
+        add_instrumentation_scope(event, span_data)
+        add_instrumented_framework(event, span_data)
+        add_span_data_attributes(event, span_data.attributes) if span_data.attributes
 
-        begin
-          md = build_meta_data(span_data)
-          event = nil
-
-          if span_data.parent_span_id != ::OpenTelemetry::Trace::INVALID_SPAN_ID 
-
-            parent_md = build_meta_data(span_data, parent: true)
-            SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] Continue trace from parent. parent_md: #{parent_md}, span_data: #{span_data.inspect}"}
-            event = @context.createEntry(md, (span_data.start_timestamp.to_i / 1000).to_i, parent_md)
-          else
-
-            SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}]  Start a new trace."}
-            event = @context.createEntry(md, (span_data.start_timestamp.to_i / 1000).to_i) 
-            add_info_transaction_name(span_data, event)
-          end
-          
-          event.addInfo('Layer', span_data.name)
-          event.addInfo('sw.span_kind', span_data.kind.to_s)
-          event.addInfo('Language', 'Ruby')
-          
-          add_info_instrumentation_scope(event, span_data)
-          add_info_instrumented_framework(event, span_data)
-
-          if span_data.attributes
-            if span_data.attributes['http.target']
-              http_target = span_data.attributes['http.target']
-              http_target = http_target.split('?').first if SolarWindsAPM::Config[:log_args] == false # remove url parameters
-              event.addInfo('http.target', http_target)
-              span_data.attributes.each do |k, v|
-                next if k == 'http.target'
-                
-                event.addInfo(k, v)
-              end
-            else
-              span_data.attributes.each { |k, v| event.addInfo(k, v) }
-            end
-          end
-
-          @reporter.send_report(event, with_system_timestamp: false)
+        event.addInfo(SolarWindsAPM::Constants::INTL_SWO_OTEL_STATUS, span_data.status.ok?? 'OK' : 'ERROR')
+        event.addInfo(SolarWindsAPM::Constants::INTL_SWO_OTEL_STATUS_DESCRIPTION, span_data.status.description) unless span_data.status.description.empty?
 
-          # info / exception event
-          span_data.events&.each do |span_data_event|
-            span_data_event.name == 'exception' ? report_exception_event(span_data_event) : report_info_event(span_data_event)
-          end
+        @reporter.send_report(event, with_system_timestamp: false)
 
-          event = @context.createExit((span_data.end_timestamp.to_i / 1000).to_i)
-          event.addInfo('Layer', span_data.name)
-          @reporter.send_report(event, with_system_timestamp: false)
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] Exit a trace: #{event.metadataString}"}
-        rescue StandardError => e
-          SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] \n #{e.message} #{e.backtrace}\n"}
-          raise
+        # info / exception event
+        span_data.events&.each do |span_data_event|
+          span_data_event.name == 'exception' ? report_exception_event(span_data_event) : report_info_event(span_data_event)
         end
 
+        event = @context.createExit((span_data.end_timestamp.to_i / 1000).to_i)
+        event.addInfo('Layer', layer_name)
+        @reporter.send_report(event, with_system_timestamp: false)
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] Exit a trace: #{event.metadataString}"}
+        SUCCESS
+      rescue StandardError => e
+        SolarWindsAPM.logger.info {"[#{self.class}/#{__method__}] exporter error: \n #{e.message} #{e.backtrace}\n"}
+        FAILURE
       end
 
-      def add_info_instrumentation_scope(event, span_data)
+      ##
+      # extract the span_data.attributes (OpenTelemetry::SDK::Trace::SpanData.attributes)
+      def add_span_data_attributes(event, span_attributes)
+        target     = 'http.target'
+        attributes = span_attributes.dup
+        attributes[target] = attributes[target].split('?').first if attributes[target] && SolarWindsAPM::Config[:log_args] == false # remove url parameters
+        attributes.each { |k, v| event.addInfo(k, v) }
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] span_data attributes added: #{attributes.inspect}"}
+      end
+
+      ##
+      # get instrumentation scope data: scope name and version.
+      # the version if the opentelemetry-instrumentation-* gem version
+      def add_instrumentation_scope(event, span_data)
         scope_name = ""
         scope_version = ""
         if span_data.instrumentation_scope
@@ -104,14 +104,13 @@ module SolarWindsAPM
           scope_version = span_data.instrumentation_scope.version if span_data.instrumentation_scope.version
         end
         event.addInfo(SolarWindsAPM::Constants::INTL_SWO_OTEL_SCOPE_NAME, scope_name) 
-        event.addInfo(SolarWindsAPM::Constants::INTL_SWO_OTEL_SCOPE_VERSION, scope_version)
+        event.addInfo(SolarWindsAPM::Constants::INTL_SWO_OTEL_SCOPE_VERSION, scope_version)        
       end
 
-      # 
-      # get the framework version (the real version not the sdk instrumentation version)
-      # 
-      def add_info_instrumented_framework(event, span_data)
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] add_info_instrumented_framework: #{span_data.instrumentation_scope.name}"}
+      ##
+      # add the gem library version to event
+      # p.s. gem library version is not same as the opentelemetry-instrumentation-* gem version
+      def add_instrumented_framework(event, span_data)
         scope_name = span_data.instrumentation_scope.name
         scope_name = scope_name.downcase if scope_name
         return unless scope_name&.include? "opentelemetry::instrumentation"
@@ -121,9 +120,12 @@ module SolarWindsAPM
         
         framework         = normalize_framework_name(framework)
         framework_version = check_framework_version(framework)
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] #{span_data.instrumentation_scope.name} with #{framework} and version #{framework_version}"}
         event.addInfo("Ruby.#{framework}.Version",framework_version) unless framework_version.nil?
       end
 
+      ##
+      # helper function that extract gem library version for func add_instrumented_framework
       def check_framework_version(framework)
         framework_version = nil
         if @version_cache.keys.include? framework
@@ -142,10 +144,12 @@ module SolarWindsAPM
             @version_cache[framework] = framework_version
           end
         end
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] Current framework version cached: #{@version_cache.inspect}"}
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] current framework version cached: #{@version_cache.inspect}"}
         framework_version
       end
 
+      ##
+      # helper function that convert opentelemetry instrumentation name to gem library understandable
       def normalize_framework_name(framework)
         case framework
         when "net::http"
@@ -156,47 +160,48 @@ module SolarWindsAPM
         normalized
       end
 
+      ##
       # Add transaction name from cache to root span then removes from cache
-      def add_info_transaction_name(span_data, evt)
+      def add_info_transaction_name(span_data, event)
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] transaction manager: #{@txn_manager.inspect}."}
         trace_span_id = "#{span_data.hex_trace_id}-#{span_data.hex_span_id}"
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] #{@txn_manager.inspect},\n span_data: #{span_data.inspect}"}
-        txname = @txn_manager.get(trace_span_id).nil?? "" : @txn_manager.get(trace_span_id)
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] txname: #{txname}"}
-        evt.addInfo("TransactionName", txname)
+        txname = @txn_manager.get(trace_span_id) || ''
+        event.addInfo("TransactionName", txname)
         @txn_manager.del(trace_span_id)
       end
 
+      ##
+      # report exception event
       def report_exception_event(span_event)
-        evt = @context.createEvent((span_event.timestamp.to_i / 1000).to_i)
-        evt.addInfo('Label', 'error')
-        evt.addInfo('Spec', 'error')
+        event = @context.createEvent((span_event.timestamp.to_i / 1000).to_i)
+        event.addInfo('Label', 'error')
+        event.addInfo('Spec', 'error')
 
         unless span_event.attributes.nil?
-          evt.addInfo('ErrorClass', span_event.attributes['exception.type'])
-          evt.addInfo('ErrorMsg', span_event.attributes['exception.message'])
-          evt.addInfo('Backtrace', span_event.attributes['exception.stacktrace'])
-          span_event.attributes.each do |key, value|
-            evt.addInfo(key, value) unless ['exception.type', 'exception.message','exception.stacktrace'].include? key
-          end
+          attributes = span_event.attributes.dup
+          attributes.delete('exception.type') if event.addInfo('ErrorClass', attributes['exception.type'])
+          attributes.delete('exception.message') if event.addInfo('ErrorMsg', attributes['exception.message'])
+          attributes.delete('exception.stacktrace') if event.addInfo('Backtrace', attributes['exception.stacktrace'])
+          attributes.each { |key, value| event.addInfo(key, value) }
         end
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] exception event #{evt.metadataString}"}
-        @reporter.send_report(evt, with_system_timestamp: false)
+
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] exception event #{event.metadataString}"}
+        @reporter.send_report(event, with_system_timestamp: false)
       end
 
+      ##
+      # report non-exception/info event
       def report_info_event(span_event)
-        evt = @context.createEvent((span_event.timestamp.to_i / 1000).to_i)
-        evt.addInfo('Label', 'info')
-        span_event.attributes&.each do |key, value|
-          evt.addInfo(key, value)
-        end
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] info event #{evt.metadataString}"}
-        @reporter.send_report(evt, with_system_timestamp: false)
+        event = @context.createEvent((span_event.timestamp.to_i / 1000).to_i)
+        event.addInfo('Label', 'info')
+        span_event.attributes&.each { |key, value| event.addInfo(key, value) }
+        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] info event #{event.metadataString}"}
+        @reporter.send_report(event, with_system_timestamp: false)
       end
 
       def build_meta_data(span_data, parent: false)
         flag = span_data.trace_flags.sampled?? 1 : 0
-        version = "00"
-        xtr = parent == false ? "#{version}-#{span_data.hex_trace_id}-#{span_data.hex_span_id}-0#{flag}" : "#{version}-#{span_data.hex_trace_id}-#{span_data.hex_parent_span_id}-0#{flag}"
+        xtr = parent == false ? "00-#{span_data.hex_trace_id}-#{span_data.hex_span_id}-0#{flag}" : "00-#{span_data.hex_trace_id}-#{span_data.hex_parent_span_id}-0#{flag}"
         @metadata.fromString(xtr)
       end
     end