solarwinds_apm 6.0.0.preV1 → 6.0.0.preV3

data/lib/solarwinds_apm/support/swomarginalia/swomarginalia.rb

@@ -7,12 +7,13 @@ module SolarWindsAPM
     # This ActiveRecordInstrumentation should only work for activerecord < 7.0 since after rails 7
     # this module won't be prepend to activerecord
     module ActiveRecordInstrumentation
-      def execute(sql, *args)
-        super(annotate_sql(sql), *args)
+      def execute(sql, *args, **options)
+        super(annotate_sql(sql), *args, **options)
       end
 
-      def execute_and_clear(sql, *args, &block)
-        super(annotate_sql(sql), *args, &block)
+      # only for postgresql adapter
+      def execute_and_clear(sql, *args, **options)
+        super(annotate_sql(sql), *args, **options)
       end
 
       def exec_query(sql, *args, **options)
@@ -53,7 +54,7 @@ module SolarWindsAPM
       # We don't want to trace framework caches.
       # Only instrument SQL that directly hits the database.
       def ignore_payload?(name)
-        %w(SCHEMA EXPLAIN CACHE).include?(name.to_s)
+        %w[SCHEMA EXPLAIN CACHE].include?(name.to_s)
       end
     end
 

data/lib/solarwinds_apm/support/transaction_cache.rb

@@ -1,21 +1,46 @@
 module SolarWindsAPM
-  # Simple TransactionCache
-  # TODO: improve cache to have lru mechanism that avoid too many values
+  # LRU TransactionCache with initial limit 1000
   module TransactionCache
+    attr_reader :capacity
+
     def self.initialize
+      @capacity = 1000
       @cache = {}
+      @order = []
     end
 
     def self.get(key)
+      return nil unless @cache.has_key?(key)
+
+      @order.delete(key)
+      @order.push(key)
       @cache[key]
     end
 
     def self.del(key)
       @cache.delete(key)
+      @order.delete(key)
+    end
+
+    def self.clear
+      @cache.clear
+      @order.clear
+    end
+
+    def self.size
+      @cache.size
     end
 
     def self.set(key, value)
+      if @cache.has_key?(key)
+        @cache.delete(key)
+      elsif @order.size >= @capacity
+        evict_key = @order.shift
+        @cache.delete(evict_key)
+      end
+
       @cache[key] = value
+      @order.push(key)
       SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] current TransactionCache #{@cache.inspect}"}
     end
   end

data/lib/solarwinds_apm/support/transaction_settings.rb

@@ -9,14 +9,14 @@ module SolarWindsAPM
     SWO_TRACING_ENABLED      = 1
     SWO_TRACING_DISABLED     = 0
 
-    def initialize(url: '', name: '', kind: '')
-      @url = url
-      @name = name
-      @kind = kind
+    def initialize(url_path: '', name: '', kind: '')
+      @url_path = url_path
+      @name     = name
+      @kind     = kind
     end
 
-    # calculate trace mode to set either 1 or 0 based on url and name+kind
-    # first check if url match, if not match, then match the name+kind
+    # calculate trace mode to set either 1 or 0 based on url_path and name+kind
+    # first check if url_path match, if not match, then match the name+kind
     def calculate_trace_mode
       tracing_mode_enabled? && tracing_enabled? ? SWO_TRACING_ENABLED : SWO_TRACING_DISABLED
     end
@@ -28,16 +28,16 @@ module SolarWindsAPM
     end
 
     def tracing_enabled?
-      span_layer = "#{@name}:#{@kind}"
+      span_layer = "#{@kind}:#{@name}"
 
-      enabled_regexps = SolarWindsAPM::Config[:enabled_regexps]
+      enabled_regexps  = SolarWindsAPM::Config[:enabled_regexps]
       disabled_regexps = SolarWindsAPM::Config[:disabled_regexps]
 
       SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] enabled_regexps: #{enabled_regexps&.inspect}"}
       SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] disabled_regexps: #{disabled_regexps&.inspect}"}
 
-      return false if disabled_regexps.is_a?(Array) && disabled_regexps.any? { |regex| regex.match?(@url) }
-      return true if enabled_regexps.is_a?(Array) && enabled_regexps.any? { |regex| regex.match?(@url) }
+      return false if disabled_regexps.is_a?(Array) && disabled_regexps.any? { |regex| regex.match?(@url_path) }
+      return true if enabled_regexps.is_a?(Array) && enabled_regexps.any? { |regex| regex.match?(@url_path) }
       return false if disabled_regexps.is_a?(Array) && disabled_regexps.any? { |regex| regex.match?(span_layer) }
       return true if enabled_regexps.is_a?(Array) && enabled_regexps.any? { |regex| regex.match?(span_layer) }
 

data/lib/solarwinds_apm/support/txn_name_manager.rb

@@ -1,25 +1,42 @@
 module SolarWindsAPM
-  module OpenTelemetry
-    # SolarWindsTxnNameManager
-    class TxnNameManager
-      def initialize
-        @cache = {}
-      end
+  # SolarWindsTxnNameManager
+  class TxnNameManager
+    def initialize
+      @cache = {}
+      @root_context_h = {}
+      @mutex = Mutex.new
+    end
 
-      def get(key)
-        @cache[key]
-      end
+    def get(key)
+      @cache[key]
+    end
 
-      def del(key)
-        @cache.delete(key)
-      end
+    def del(key)
+      @cache.delete(key)
+    end
 
-      def set(key, value)
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] current cache #{@cache.inspect}"}
-        @cache[key] = value
+    def set(key, value)
+      @cache[key] = value
+      SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] txn manager current cache #{@cache.inspect}"}
+    end
+
+    alias []= set
+
+    def set_root_context_h(key, value)
+      @mutex.synchronize do
+        @root_context_h[key] = value
       end
+      SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] txn manager current root_context_h #{@root_context_h.inspect}"}
+    end
 
-      alias []= set
+    def get_root_context_h(key)
+      @root_context_h[key]
+    end
+
+    def delete_root_context_h(key)
+      @mutex.synchronize do
+        @root_context_h.delete(key)
+      end
     end
   end
-end
+end

data/lib/solarwinds_apm/support/utils.rb

@@ -0,0 +1,24 @@
+module SolarWindsAPM
+  # Utils
+  class Utils
+    VERSION = '00'.freeze
+
+    def self.trace_state_header(trace_state)
+      return nil if trace_state.nil?
+
+      arr    = []
+      trace_state.to_h.each { |key, value| arr << "#{key}=#{value}" }
+      header = arr.join(",")
+      SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] generated trace_state_header: #{header}"}
+      header
+    end
+
+    # Generates a liboboe W3C compatible trace_context from provided OTel span context.
+    def self.traceparent_from_context(span_context)
+      flag = span_context.trace_flags.sampled?? 1 : 0
+      xtr = "#{VERSION}-#{span_context.hex_trace_id}-#{span_context.hex_span_id}-0#{flag}"
+      SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] generated traceparent: #{xtr} from #{span_context.inspect}"}
+      xtr
+    end
+  end
+end

data/lib/solarwinds_apm/support.rb

@@ -11,7 +11,7 @@ require_relative './support/transaction_cache'
 require_relative './support/transaction_settings'
 require_relative './support/oboe_tracing_mode'
 require_relative './support/txn_name_manager'
-require_relative './support/transformer'
+require_relative './support/utils'
 require_relative './support/x_trace_options'
 
 if SolarWindsAPM::Config[:tag_sql]
@@ -27,9 +27,11 @@ if SolarWindsAPM::Config[:tag_sql]
       #     } 
       #   }
       # ]
+      SolarWindsAPM.logger.info {"In Rails 7, tag tracecontext on a query by including SolarWindsAPM::SWOMarginalia::Comment.traceparent as function in config.active_record.query_log_tags."}
+      SolarWindsAPM.logger.info {"For more information, please check https://api.rubyonrails.org/classes/ActiveRecord/QueryLogs.html"}
       require_relative './support/swomarginalia/comment'
     end
-  else
+  elsif defined?(::ActiveRecord)
     require_relative './support/swomarginalia/load_swomarginalia'
     SolarWindsAPM::SWOMarginalia::LoadSWOMarginalia.insert
   end

data/lib/solarwinds_apm/version.rb

@@ -9,7 +9,7 @@ module SolarWindsAPM
     MAJOR  = 6 # breaking,
     MINOR  = 0 # feature,
     PATCH  = 0 # fix => BFF
-    PRE    = 'preV1' # for pre-releases into packagecloud, set to nil for production releases into rubygems
+    PRE    = 'preV3'.freeze # for pre-releases into packagecloud, set to nil for production releases into rubygems
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

data/lib/solarwinds_apm.rb

@@ -1,10 +1,9 @@
 # Copyright (c) 2016 SolarWinds, LLC.
 # All rights reserved.
 
-begin  
-
-  if ENV.has_key?('SOLARWINDS_APM_ENABLED') && (ENV['SOLARWINDS_APM_ENABLED'] == 'false' || ENV['SOLARWINDS_APM_ENABLED'] == false)
-    SolarWindsAPM.logger.warn 'SOLARWINDS_APM_ENABLED environment variable detected and was set to false; SolarWindsAPM disabled'
+begin
+  if ENV.has_key?('SW_APM_ENABLED') && (ENV['SW_APM_ENABLED'] == 'false' || ENV['SW_APM_ENABLED'] == false)
+    SolarWindsAPM.logger.warn 'SW_APM_ENABLED environment variable detected and was set to false; SolarWindsAPM disabled'
     return
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 6.0.0.preV1
+  version: 6.0.0.preV3
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,50 +11,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-all
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
+        version: 0.33.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.31.0
-- !ruby/object:Gem::Dependency
-  name: ruby2_keywords
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.5
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.33.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -73,16 +59,16 @@ dependencies:
   name: opentelemetry-exporter-otlp
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.24.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.24.2
 description: Automatic tracing and metrics for Ruby applications. Get started at cloud.solarwinds.com
 email: technicalsupport@solarwinds.com
 executables: []
@@ -106,13 +92,13 @@ files:
 - ext/oboe_metal/src/oboe_api.h
 - ext/oboe_metal/src/oboe_debug.h
 - ext/oboe_metal/src/oboe_swig_wrap.cc
-- lib/oboe.rb
 - lib/oboe_metal.rb
 - lib/rails/generators/solarwinds_apm/install_generator.rb
 - lib/rails/generators/solarwinds_apm/templates/solarwinds_apm_initializer.rb
 - lib/solarwinds_apm.rb
 - lib/solarwinds_apm/api.rb
 - lib/solarwinds_apm/api/current_trace_info.rb
+- lib/solarwinds_apm/api/opentelemetry.rb
 - lib/solarwinds_apm/api/tracing.rb
 - lib/solarwinds_apm/api/transaction_name.rb
 - lib/solarwinds_apm/base.rb
@@ -123,7 +109,6 @@ files:
 - lib/solarwinds_apm/noop/README.md
 - lib/solarwinds_apm/noop/context.rb
 - lib/solarwinds_apm/noop/metadata.rb
-- lib/solarwinds_apm/noop/profiling.rb
 - lib/solarwinds_apm/oboe_init_options.rb
 - lib/solarwinds_apm/opentelemetry.rb
 - lib/solarwinds_apm/opentelemetry/solarwinds_exporter.rb
@@ -145,8 +130,8 @@ files:
 - lib/solarwinds_apm/support/swomarginalia/swomarginalia.rb
 - lib/solarwinds_apm/support/transaction_cache.rb
 - lib/solarwinds_apm/support/transaction_settings.rb
-- lib/solarwinds_apm/support/transformer.rb
 - lib/solarwinds_apm/support/txn_name_manager.rb
+- lib/solarwinds_apm/support/utils.rb
 - lib/solarwinds_apm/support/x_trace_options.rb
 - lib/solarwinds_apm/support_report.rb
 - lib/solarwinds_apm/thread_local.rb
@@ -167,14 +152,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: SolarWindsAPM performance instrumentation gem for Ruby

data/lib/oboe.rb

@@ -1,7 +0,0 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
-
-# This module is provided for backward compatibility.
-# It simply redirects to the solarwinds_apm module which will
-# also load backward compatibility support.
-require 'solarwinds_apm'

data/lib/solarwinds_apm/noop/profiling.rb

@@ -1,17 +0,0 @@
-module SolarWindsAPM
-  # override the Ruby method, so that no code related to profiling gets executed
-  class Profiling
-    def self.run
-      yield
-    end
-  end
-
-  # these put the c-functions into "noop"
-  module CProfiler
-    def self.interval_setup(_); end
-
-    def self.tid
-      0
-    end
-  end
-end

data/lib/solarwinds_apm/support/transformer.rb

@@ -1,56 +0,0 @@
-module SolarWindsAPM
-  module OpenTelemetry
-    # Transformer
-    class Transformer
-      VERSION = '00'.freeze
-
-      def self.sw_from_context(span_context)
-        flag = span_context.trace_flags.sampled?? 1 : 0
-        "#{span_context.hex_span_id}-0#{flag}"
-      end
-
-      def self.trace_state_header(trace_state)
-        arr = []
-        trace_state.to_h.each do |key, value|
-          arr << "#{key}=#{value}"
-        end
-        arr.join(",")
-      end
-
-      # Generates a liboboe W3C compatible trace_context from provided OTel span context.
-      def self.traceparent_from_context(span_context)
-        flag = span_context.trace_flags.sampled?? 1 : 0
-        xtr = "#{VERSION}-#{span_context.hex_trace_id}-#{span_context.hex_span_id}-0#{flag}"
-        SolarWindsAPM.logger.debug("Generated traceparent #{xtr} from #{span_context.inspect}")
-        xtr
-      end
-
-      # Formats tracestate sw value from span_id and liboboe decision as 16-byte span_id with 8-bit trace_flags
-      # e.g. 1a2b3c4d5e6f7g8h-01
-      def self.sw_from_span_and_decision(span_id, decision)
-        [span_id, decision].join("-")
-      end
-
-      # trace_flags [Integer]
-      def self.trace_flags_from_int(trace_flags)
-        "0#{trace_flags}"
-      end
-
-      def self.trace_flags_from_boolean(trace_flags)
-        trace_flags == true ? "01" : "00"
-      end
-
-      def self.sampled?(decision)
-        decision == ::OpenTelemetry::SDK::Trace::Samplers::Decision::RECORD_AND_SAMPLE
-      end
-
-      def self.span_id_from_sw(sw_value)
-        sw_value.split("-")[0]
-      end
-
-      def self.create_key(name_)
-        ::OpenTelemetry::Context.create_key(name_)
-      end
-    end
-  end
-end