solarwinds_apm 6.0.0.preV2 → 6.0.0.preV4

data/lib/solarwinds_apm/otel_config.rb

@@ -6,12 +6,12 @@ module SolarWindsAPM
   module OTelConfig
     @@config           = {}
     @@config_map       = {}
-    
+
     @@agent_enabled    = true
 
     def self.disable_agent
       return unless @@agent_enabled  # only show the msg once
-      
+
       @@agent_enabled = false
       SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Agent disabled. No Trace exported."}
     end
@@ -25,36 +25,54 @@ module SolarWindsAPM
     def self.resolve_sampler
 
       resolve_sampler_config
-      @@config[:sampler] = 
+      @@config[:sampler] =
         ::OpenTelemetry::SDK::Trace::Samplers.parent_based(
           root: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new(@@config[:sampler_config]),
           remote_parent_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new(@@config[:sampler_config]),
           remote_parent_not_sampled: SolarWindsAPM::OpenTelemetry::SolarWindsSampler.new(@@config[:sampler_config]))
     end
 
-    def self.resolve_sampler_config      
+    def self.resolve_sampler_config
       sampler_config = {}
-      sampler_config["trigger_trace"] = "enabled" 
+      sampler_config["trigger_trace"] = "enabled"
       sampler_config["trigger_trace"] = nil if ENV["SW_APM_TRIGGER_TRACING_MODE"] == 'disabled'
       @@config[:sampler_config] = sampler_config
     end
 
     #
     # append/add solarwinds_response_propagator into rack instrumentation
-    # 
-    def self.resolve_for_response_propagator
-      response_propagator = SolarWindsAPM::OpenTelemetry::SolarWindsResponsePropagator::TextMapPropagator.new
-      if @@config_map["OpenTelemetry::Instrumentation::Rack"]
-        if @@config_map["OpenTelemetry::Instrumentation::Rack"][:response_propagators].instance_of?(Array)
-          @@config_map["OpenTelemetry::Instrumentation::Rack"][:response_propagators].append(response_propagator)
+    #
+    def self.resolve_response_propagator
+      response_propagator  = SolarWindsAPM::OpenTelemetry::SolarWindsResponsePropagator::TextMapPropagator.new
+      rack_setting         = @@config_map["OpenTelemetry::Instrumentation::Rack"]
+      
+      if rack_setting
+        if rack_setting[:response_propagators].instance_of?(Array)
+          rack_setting[:response_propagators].append(response_propagator)
+        elsif rack_setting[:response_propagators].nil?
+          rack_setting[:response_propagators] = [response_propagator]
         else
-          @@config_map["OpenTelemetry::Instrumentation::Rack"][:response_propagators] = [response_propagator]
+          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Rack response propagator resolve failed. Provided type #{rack_setting[:response_propagators].class}, please provide Array e.g. [#{rack_setting[:response_propagators]}]"}
         end
       else
         @@config_map["OpenTelemetry::Instrumentation::Rack"] = {response_propagators: [response_propagator]}
       end
     end
 
+    def self.obfuscate_helper(instrumentation)
+      if @@config_map[instrumentation] # user provided the option
+        @@config_map[instrumentation][:db_statement] = :obfuscate unless @@config_map[instrumentation][:db_statement] # user provided the db_statement, ignore our default setting 
+      else
+        @@config_map[instrumentation] = {db_statement: :obfuscate}
+      end
+    end
+
+    def self.obfuscate_query
+      obfuscate_helper("OpenTelemetry::Instrumentation::Dalli")
+      obfuscate_helper("OpenTelemetry::Instrumentation::Mysql2")
+      obfuscate_helper("OpenTelemetry::Instrumentation::PG")
+    end
+
     def self.[](key)
       @@config[key.to_sym]
     end
@@ -69,7 +87,7 @@ module SolarWindsAPM
     end
 
     def self.resolve_solarwinds_processor
-      txn_manager = SolarWindsAPM::OpenTelemetry::TxnNameManager.new
+      txn_manager = SolarWindsAPM::TxnNameManager.new
       exporter    = SolarWindsAPM::OpenTelemetry::SolarWindsExporter.new(txn_manager: txn_manager)
       @@config[:span_processor] = SolarWindsAPM::OpenTelemetry::SolarWindsProcessor.new(exporter, txn_manager)
     end
@@ -103,39 +121,40 @@ module SolarWindsAPM
       return unless @@agent_enabled
 
       resolve_sampler
-      
+
       resolve_solarwinds_propagator
       resolve_solarwinds_processor
-      resolve_for_response_propagator
+      resolve_response_propagator
+
+      obfuscate_query
 
       print_config if SolarWindsAPM.logger.level.zero?
 
-      ENV['OTEL_TRACES_EXPORTER'] = 'none' if ENV['OTEL_TRACES_EXPORTER'].nil?
-      ::OpenTelemetry::SDK.configure do |c|
-        c.use_all(@@config_map)
-      end
-      
+      ENV['OTEL_TRACES_EXPORTER'] = 'none' if ENV['OTEL_TRACES_EXPORTER'].to_s.empty?
+
+      ::OpenTelemetry::SDK.configure { |c| c.use_all(@@config_map) }
+
       validate_propagator(::OpenTelemetry.propagation.instance_variable_get(:@propagators))
 
       return unless @@agent_enabled
 
       # append our propagators
-      ::OpenTelemetry.propagation.instance_variable_get(:@propagators).append(@@config[:propagators]) 
-      
-      # append our processors (with our exporter)      
+      ::OpenTelemetry.propagation.instance_variable_get(:@propagators).append(@@config[:propagators])
+
+      # append our processors (with our exporter)
       ::OpenTelemetry.tracer_provider.add_span_processor(@@config[:span_processor])
-      
+
       # configure sampler afterwards
       ::OpenTelemetry.tracer_provider.sampler = @@config[:sampler]
       nil
     end
 
-    # 
+    #
     # Allow initialize after set new value to SolarWindsAPM::Config[:key]=value
-    # 
+    #
     # Usage:
-    # 
-    # Default using the use_all to load all instrumentation 
+    #
+    # Default using the use_all to load all instrumentation
     # But with specific instrumentation disabled, use {:enabled: false} in config
     # SolarWindsAPM::OTelConfig.initialize_with_config do |config|
     #   config["OpenTelemetry::Instrumentation::Rack"]  = {"a" => "b"}

data/lib/solarwinds_apm/support/lumberjack_formatter.rb

@@ -1,6 +1,21 @@
-# Copyright (c) 2019 SolarWinds, LLC.
+# Copyright (c) 2023 SolarWinds, LLC.
 # All rights reserved.
 
 require_relative 'logger_formatter'
 
-Lumberjack::Formatter.prepend(SolarWindsAPM::Logger::Formatter) if SolarWindsAPM.loaded && defined?(Lumberjack::Formatter)
+module SolarWindsAPM
+  module Lumberjack
+    module LogEntry
+      include SolarWindsAPM::Logger::Formatter # provides #insert_trace_id
+
+      def initialize(time, severity, message, progname, pid, tags)
+        super if SolarWindsAPM::Config[:log_traceId] == :never
+
+        message = insert_trace_id(message)
+        super
+      end
+    end
+  end
+end
+
+Lumberjack::LogEntry.prepend(SolarWindsAPM::Lumberjack::LogEntry) if SolarWindsAPM.loaded && defined?(Lumberjack::LogEntry)

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)

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

@@ -28,9 +28,9 @@ 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}"}

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]
@@ -31,10 +31,8 @@ if SolarWindsAPM::Config[:tag_sql]
       SolarWindsAPM.logger.info {"For more information, please check https://api.rubyonrails.org/classes/ActiveRecord/QueryLogs.html"}
       require_relative './support/swomarginalia/comment'
     end
-  elsif defined?(::ActiveRecord) && ::ActiveRecord.version.to_s < '7'
+  elsif defined?(::ActiveRecord)
     require_relative './support/swomarginalia/load_swomarginalia'
     SolarWindsAPM::SWOMarginalia::LoadSWOMarginalia.insert
-  else
-    SolarWindsAPM.logger.info {"tag_sql currently is not supported in non-rails app that use active_record > 7"}
   end
 end

data/lib/solarwinds_apm/version.rb

@@ -9,7 +9,7 @@ module SolarWindsAPM
     MAJOR  = 6 # breaking,
     MINOR  = 0 # feature,
     PATCH  = 0 # fix => BFF
-    PRE    = 'preV2'.freeze # for pre-releases into packagecloud, set to nil for production releases into rubygems
+    PRE    = 'preV4'.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

@@ -2,8 +2,8 @@
 # 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'
+  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.preV2
+  version: 6.0.0.preV4
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,34 +11,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-08 00:00:00.000000000 Z
+date: 2023-09-14 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
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-all
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.31.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.31.0
 - !ruby/object:Gem::Dependency
@@ -59,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: []
@@ -92,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
@@ -130,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
@@ -152,7 +152,7 @@ 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:
   - - ">"

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/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