solarwinds_apm 6.0.0.preV5 → 6.0.0

data/lib/oboe_metal.rb

@@ -7,9 +7,22 @@
 # Disable docs and Camelcase warns since we're implementing
 # an interface here.  See OboeBase for details.
 module SolarWindsAPM
-  extend SolarWindsAPMBase
   include Oboe_metal
 
+  @loaded   = false
+  @reporter = nil
+
+  class << self
+    attr_accessor :reporter, :loaded
+
+    def sample_rate(rate)
+      return unless SolarWindsAPM.loaded
+
+      # Update liboboe with the new SampleRate value
+      SolarWindsAPM::Context.setDefaultSampleRate(rate.to_i)
+    end
+  end
+
   # Reporter that send span data to SWO
   class Reporter
     class << self
@@ -19,18 +32,14 @@ module SolarWindsAPM
       # Start the SolarWindsAPM Reporter
       #
       def start
-        SolarWindsAPM.loaded = false unless SolarWindsAPM::OboeInitOptions.instance.service_key_ok?
-        return unless SolarWindsAPM.loaded
-
         begin
           options = SolarWindsAPM::OboeInitOptions.instance.array_for_oboe # creates an array with the options in the right order
-
           SolarWindsAPM.reporter = Oboe_metal::Reporter.new(*options)
-
           report_init
+          SolarWindsAPM.loaded = true
         rescue StandardError=> e
           $stderr.puts e.message
-          raise
+          SolarWindsAPM.loaded = false
         end
       end
       alias :restart :start
@@ -53,52 +62,6 @@ module SolarWindsAPM
         SolarWindsAPM.reporter.sendStatus(evt, context, with_system_timestamp)
       end
 
-      ##
-      # clear_all_traces
-      #
-      # Truncates the trace output file to zero
-      #
-      def clear_all_traces
-        File.truncate(SolarWindsAPM::OboeInitOptions.instance.host, 0)
-      end
-
-      ##
-      # obtain_all_traces
-      #
-      # Retrieves all traces written to the trace file
-      #
-      def obtain_all_traces
-        io = File.open(SolarWindsAPM::OboeInitOptions.instance.host, 'r')
-        contents = io.readlines(nil)
-        io.close
-
-        return contents if contents.empty?
-
-        traces = []
-
-        # We use Gem.loaded_spec because older versions of the bson
-        # gem didn't even have a version embedded in the gem.  If the
-        # gem isn't in the bundle, it should rightfully error out
-        # anyways.
-        #
-        if Gem.loaded_specs['bson'] && Gem.loaded_specs['bson'].version.to_s < '4.0'
-          s = StringIO.new(contents[0])
-
-          until s.eof?
-            traces << if ::BSON.respond_to? :read_bson_document
-                        BSON.read_bson_document(s)
-                      else
-                        BSON::Document.from_bson(s)
-                      end
-          end
-        else
-          bbb = ::BSON::ByteBuffer.new(contents[0])
-          traces << Hash.from_bson(bbb) until bbb.length == 0
-        end
-
-        traces
-      end
-
       private
 
       # Internal: Report that instrumentation for the given layer has been
@@ -205,16 +168,12 @@ module SolarWindsAPM
       end
     end
   end
-
-  class << self
-    def sample_rate(rate)
-      return unless SolarWindsAPM.loaded
-
-      # Update liboboe with the new SampleRate value
-      SolarWindsAPM::Context.setDefaultSampleRate(rate.to_i)
-    end
-  end
 end
 
-SolarWindsAPM.loaded = true
-# rubocop:enable Style/Documentation
+# rubocop:enable Style/Documentation
+
+# Setup an alias
+SolarWindsApm = SolarWindsAPM
+SolarwindsApm = SolarWindsAPM
+SolarwindsAPM = SolarWindsAPM
+Solarwindsapm = SolarWindsAPM

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

@@ -147,7 +147,7 @@ if defined?(SolarWindsAPM::Config)
   # Trace options is a custom HTTP header X-Trace-Options that can be set on a request to carry additional information
   # to the agents, one such option being trigger-trace which we’ll call a trigger trace request.
   #
-  SolarWindsAPM::Config[:trigger_tracing_mode] = 'enabled'
+  SolarWindsAPM::Config[:trigger_tracing_mode] = :enabled
 
   #
   # Argument logging

data/lib/solarwinds_apm/api/current_trace_info.rb

@@ -51,7 +51,7 @@ module SolarWindsAPM
       class TraceInfo
         attr_reader :tracestring, :trace_id, :span_id, :trace_flags, :do_log
 
-        REGEXP = /^(?<tracestring>(?<version>[a-f0-9]{2})-(?<trace_id>[a-f0-9]{32})-(?<span_id>[a-f0-9]{16})-(?<flags>[a-f0-9]{2}))$/
+        REGEXP = /^(?<tracestring>(?<version>[a-f0-9]{2})-(?<trace_id>[a-f0-9]{32})-(?<span_id>[a-f0-9]{16})-(?<flags>[a-f0-9]{2}))$/.freeze # rubocop:disable Style/RedundantFreeze
         private_constant :REGEXP
 
         def initialize
@@ -98,8 +98,7 @@ module SolarWindsAPM
         # * Hash
         #
         def hash_for_log
-          @hash_for_log = {}
-          @hash_for_log = {trace_id: @trace_id, span_id: @span_id, trace_flags: @trace_flags, service_name: @service_name} if @do_log
+          @hash_for_log = @do_log ? {'trace_id' => @trace_id, 'span_id' => @span_id, 'trace_flags' => @trace_flags, 'resource.service.name' => @service_name} : {}
         end
 
         private

data/lib/solarwinds_apm/api/opentelemetry.rb

@@ -28,7 +28,7 @@ module SolarWindsAPM
       #   end
       # 
       # === Returns:
-      # * Objective
+      # * value returned by block
       #
       def in_span(name, attributes: nil, links: nil, start_timestamp: nil, kind: nil, &block)
         if block.nil?
@@ -42,4 +42,4 @@ module SolarWindsAPM
       end
     end
   end
-end
+end

data/lib/solarwinds_apm/api/tracing.rb

@@ -54,4 +54,4 @@ module SolarWindsAPM
       end
     end
   end
-end
+end

data/lib/solarwinds_apm/api.rb

@@ -18,4 +18,4 @@ module SolarWindsAPM
     extend SolarWindsAPM::API::OpenTelemetry
     extend SolarWindsAPM::API::CustomMetrics
   end
-end
+end

data/lib/solarwinds_apm/config.rb

@@ -12,6 +12,15 @@ module SolarWindsAPM
   # Use SolarWindsAPM::Config.show to view the entire nested hash.
   #
   module Config
+    SW_LOG_LEVEL_MAPPING = {-1 => {:stdlib => ::Logger::FATAL, :otel => 'fatal'},
+                             0 => {:stdlib => ::Logger::FATAL, :otel => 'fatal'},
+                             1 => {:stdlib => ::Logger::ERROR, :otel => 'error'},
+                             2 => {:stdlib => ::Logger::WARN, :otel => 'warn'},
+                             3 => {:stdlib => ::Logger::INFO, :otel => 'info'},
+                             4 => {:stdlib => ::Logger::DEBUG, :otel => 'debug'},
+                             5 => {:stdlib => ::Logger::DEBUG, :otel => 'debug'},
+                             6 => {:stdlib => ::Logger::DEBUG, :otel => 'debug'}}.freeze
+
     @@config = {}
     @@instrumentation = [:action_controller, :action_controller_api, :action_view,
                          :active_record, :bunnyclient, :bunnyconsumer, :curb,
@@ -44,19 +53,20 @@ module SolarWindsAPM
       config_files << config_file if File.exist?(config_file)
 
       # Check for file set by env variable
-      config_files << config_from_env if ENV.has_key?('SW_APM_CONFIG_RUBY')
+      config_files << config_file_from_env if ENV.has_key?('SW_APM_CONFIG_RUBY')
 
       # Check for default config file
       config_file = File.join(Dir.pwd, 'solarwinds_apm_config.rb')
       config_files << config_file if File.exist?(config_file)
 
+      SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Available config_files: #{config_files.join(', ')}" }
       SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Multiple configuration files configured, using the first one listed: #{config_files.join(', ')}"} if config_files.size > 1
       load(config_files[0]) if config_files.size > 0
 
       set_log_level        # sets SolarWindsAPM::Config[:debug_level], SolarWindsAPM.logger.level
     end
 
-    def self.config_from_env
+    def self.config_file_from_env
       if File.exist?(ENV['SW_APM_CONFIG_RUBY']) && !File.directory?(ENV['SW_APM_CONFIG_RUBY'])
         config_file = ENV['SW_APM_CONFIG_RUBY']
       elsif File.exist?(File.join(ENV['SW_APM_CONFIG_RUBY'], 'solarwinds_apm_config.rb'))
@@ -68,11 +78,40 @@ module SolarWindsAPM
     end
 
     def self.set_log_level
-      SolarWindsAPM::Config[:debug_level] = 3 unless (-1..6).include?(SolarWindsAPM::Config[:debug_level])
+      log_level = (ENV['SW_APM_DEBUG_LEVEL'] || SolarWindsAPM::Config[:debug_level] || 3).to_i
+
+      SolarWindsAPM.logger = ::Logger.new(nil) if log_level == -1
+
+      SolarWindsAPM.logger.level = SW_LOG_LEVEL_MAPPING.dig(log_level, :stdlib) || ::Logger::INFO # default log level info
+    end
+
+    def self.enable_disable_config(env_var, key, value, default, bool: false)
+      env_value = ENV[env_var.to_s]&.downcase
+      valid_env_values = bool ? %w[true false] : %w[enabled disabled]
+
+      if env_var && valid_env_values.include?(env_value)
+        value = bool ? true?(env_value) : env_value.to_sym
+      elsif env_var && !env_value.to_s.empty?
+        SolarWindsAPM.logger.warn("[#{name}/#{__method__}] #{env_var} must be #{valid_env_values.join('/')} (current setting is #{ENV[env_var]}). Using default value: #{default}.")
+        return @@config[key.to_sym] = default
+      end
+
+      return @@config[key.to_sym] = value unless (bool && !boolean?(value)) || (!bool && !symbol?(value))
 
-      # let's find and use the equivalent debug level for ruby
-      debug_level = (ENV['SW_APM_DEBUG_LEVEL'] || SolarWindsAPM::Config[:debug_level] || 3).to_i
-      SolarWindsAPM.logger.level = debug_level < 0 ? 6 : [4 - debug_level, 0].max
+      SolarWindsAPM.logger.warn("[#{name}/#{__method__}] :#{key} must be a #{valid_env_values.join('/')}. Using default value: #{default}.")
+      @@config[key.to_sym] = default
+    end
+
+    def self.true?(obj)
+      obj.to_s.casecmp("true").zero?
+    end
+
+    def self.boolean?(obj)
+      [true, false].include?(obj)
+    end
+
+    def self.symbol?(obj)
+      [:enabled, :disabled].include?(obj)
     end
 
     ##
@@ -82,10 +121,11 @@ module SolarWindsAPM
     # to create an output similar to the content of the config file
     #
     def self.print_config
-      SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] General configurations list blow:"}
+      SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] General configurations list blow:"}
       @@config.each do |k,v|
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Config Key/Value: #{k}, #{v.inspect}"}
+        SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Config Key/Value: #{k}, #{v.inspect}"} unless @@instrumentation.include?(k)
       end
+      nil
     end
 
     ##
@@ -93,8 +133,9 @@ module SolarWindsAPM
     #
     # Initializer method to set everything up with a default configuration.
     # The defaults are read from the template configuration file.
+    # This will be called when require 'solarwinds_apm/config' happen
     #
-    def self.initialize(_data={})
+    def self.initialize
       # for config file backward compatibility
       @@instrumentation.each {|inst| @@config[inst] = {}}
       @@config[:transaction_name] = {}
@@ -123,6 +164,7 @@ module SolarWindsAPM
     #
     # Config variable assignment method.  Here we validate and store the
     # assigned value(s) and trigger any secondary action needed.
+    # ENV always have higher precedence 
     #
     def self.[]=(key, value)
       key = key.to_sym
@@ -151,17 +193,14 @@ module SolarWindsAPM
       when :transaction_settings
         compile_settings(value)
 
+      when :trigger_tracing_mode
+        enable_disable_config('SW_APM_TRIGGER_TRACING_MODE', key, value, :enabled)
+
       when :tracing_mode
-        # ALL TRACING COMMUNICATION TO OBOE IS NOW HANDLED BY TransactionSettings
-        # Make sure that the mode is stored as a symbol
-        @@config[key.to_sym] = value.to_sym
+        enable_disable_config(nil, key, value, :enabled)
 
       when :tag_sql
-        if ENV.has_key?('SW_APM_TAG_SQL')
-          @@config[key.to_sym] = (ENV['SW_APM_TAG_SQL'] == 'true')
-        else
-          @@config[key.to_sym] = value
-        end
+        enable_disable_config('SW_APM_TAG_SQL', key, value, false, bool: true)
 
       else
         @@config[key.to_sym] = value

data/lib/solarwinds_apm/constants.rb

@@ -7,11 +7,10 @@
 module SolarWindsAPM
   # Constants
   module Constants
-    HTTP_METHOD      = "http.method".freeze
-    HTTP_ROUTE       = "http.route".freeze
-    HTTP_STATUS_CODE = "http.status_code".freeze
-    HTTP_URL         = "http.url".freeze
-
+    HTTP_METHOD                      = "http.method".freeze
+    HTTP_ROUTE                       = "http.route".freeze
+    HTTP_STATUS_CODE                 = "http.status_code".freeze
+    HTTP_URL                         = "http.url".freeze
     INTL_SWO_AO_COLLECTOR            = "collector.appoptics.com".freeze
     INTL_SWO_AO_STG_COLLECTOR        = "collector-stg.appoptics.com".freeze
     INTL_SWO_COMMA                   = ",".freeze
@@ -30,7 +29,6 @@ module SolarWindsAPM
     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
-end
+end

data/lib/solarwinds_apm/noop/README.md

@@ -6,4 +6,4 @@ we load these classes when in noop mode and they expose noop behavior.
 
 so far only one class is needed:
 
-- SolarWindsAPM::Context  and its toString() method from oboe
+- SolarWindsAPM::Context  and its toString() method from oboe

data/lib/solarwinds_apm/noop/api.rb

@@ -0,0 +1,83 @@
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+####
+# noop version of SolarWindsAPM::API
+#
+module SolarWindsAPM
+  # API
+  module API 
+  end
+end
+
+module NoopAPI
+  # Tracing
+  module Tracing
+    # (wait_milliseconds=3000, integer_response: false)
+    def solarwinds_ready?(*_args, **options)
+      options && options[:integer_response] ? 0 : false
+    end
+  end
+
+  # CurrentTraceInfo
+  module CurrentTraceInfo
+    def current_trace_info
+      TraceInfo.new
+    end
+
+    class TraceInfo
+      attr_reader :tracestring, :trace_id, :span_id, :trace_flags, :do_log
+
+      def initialize
+        @trace_id = '00000000000000000000000000000000'
+        @span_id = '0000000000000000'
+        @trace_flags = '00'
+        @tracestring = '00-00000000000000000000000000000000-0000000000000000-00'
+        @service_name = ''
+        @do_log = :never
+      end
+
+      def for_log
+        ''
+      end
+
+      def hash_for_log
+        {}
+      end
+    end
+  end
+
+  # CustomMetrics
+  module CustomMetrics
+    def increment_metric(*)
+      false
+    end
+
+    def summary_metric(*)
+      false
+    end
+  end
+
+  # OpenTelemetry
+  module OpenTelemetry
+    def in_span(*)
+      yield if block_given?
+    end
+  end
+
+  # TransactionName
+  module TransactionName
+    def set_transaction_name(*)
+      true
+    end
+  end
+end
+
+SolarWindsAPM::API.extend(NoopAPI::Tracing)
+SolarWindsAPM::API.extend(NoopAPI::CurrentTraceInfo)
+SolarWindsAPM::API.extend(NoopAPI::CustomMetrics)
+SolarWindsAPM::API.extend(NoopAPI::OpenTelemetry)
+SolarWindsAPM::API.extend(NoopAPI::TransactionName)

data/lib/solarwinds_apm/noop/context.rb

@@ -7,9 +7,12 @@
 ####
 # noop version of SolarWindsAPM::Context
 #
-module SolarWindsAPM
+# module SolarWindsAPM
+# end
+
+module Oboe_metal # rubocop:disable Naming/ClassAndModuleCamelCase
   # Context for noop
-  module Context
+  class Context
     ##
     # noop version of :toString
     # toString would return the current trace context as string
@@ -18,6 +21,14 @@ module SolarWindsAPM
       '99-00000000000000000000000000000000-0000000000000000-00'
     end
 
+    def self.isReady(*)
+      false
+    end
+
+    def self.getDecisions(*)
+      [-1, -1, -1, 0, 0.0, 0.0, -1, -1, '', '', 4]
+    end
+
     ##
     # noop version of :clear
     #

data/lib/solarwinds_apm/noop/metadata.rb

@@ -7,8 +7,7 @@
 ####
 # noop version of SolarWindsAPM::Metadata
 #
-#
-module SolarWindsAPM
+module Oboe_metal # rubocop:disable Naming/ClassAndModuleCamelCase
   # Metadata
   class Metadata
     ##
@@ -20,6 +19,10 @@ module SolarWindsAPM
       Metadata.new
     end
 
+    def self.fromString(*)
+      Metadata.new
+    end
+
     def isValid
       false
     end

data/lib/solarwinds_apm/{thread_local.rb → noop/span.rb}

@@ -4,26 +4,20 @@
 #
 # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
-module SolarWindsAPM
-  ##
-  # Provides thread local storage for SolarWindsAPM.
-  #
-  # Example usage:
-  # module SolarWindsAPMBase
-  #   extend SolarWindsAPM::ThreadLocal
-  #   thread_local :layer_op
-  # end
-  module ThreadLocal
-    def thread_local(name)
-      key = "__#{self}_#{name}__".intern
-
-      define_method(name) do
-        Thread.current[key]
-      end
+####
+# noop version of SolarWindsAPM::Span
+#
+module Oboe_metal # rubocop:disable Naming/ClassAndModuleCamelCase
+  # Span
+  class Span
+    ##
+    # noop version of :createHttpSpan
+    #
+    def self.createHttpSpan(*); end
 
-      define_method("#{name}=") do |value|
-        Thread.current[key] = value
-      end
-    end
+    ##
+    # noop version of :createSpan
+    #
+    def self.createSpan(*); end
   end
 end

data/lib/solarwinds_apm/{base.rb → noop.rb}

@@ -4,33 +4,28 @@
 #
 # Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
-##
-# This module is the base module for SolarWindsAPM reporting.
-#
-module SolarWindsAPMBase
-  extend SolarWindsAPM::ThreadLocal
-
-  attr_accessor :reporter, :loaded
-
-  ##
-  # Determines if we are running under a forking webserver
-  #
-  def forking_webserver?
-    if (defined?(::Unicorn) && ($PROGRAM_NAME =~ /unicorn/i)) ||
-       (defined?(::Puma) && ($PROGRAM_NAME =~ /puma/i))
-      true
-    else
-      false
-    end
-  end
-end
+require_relative './noop/context'
+require_relative './noop/metadata'
+require_relative './noop/span'
+require_relative './noop/api'
 
 module SolarWindsAPM
-  extend SolarWindsAPMBase
-end
+  include Oboe_metal
+  # Reporter noop
+  class Reporter
+    ##
+    # noop version of :send_report
+    #
+    def self.send_report(event, with_system_timestamp: false); end
+
+    ##
+    # noop version of :send_status
+    #
+    def self.send_status(event, context=nil, with_system_timestamp: false); end
 
-# Setup an alias
-SolarWindsApm = SolarWindsAPM
-SolarwindsApm = SolarWindsAPM
-SolarwindsAPM = SolarWindsAPM
-Solarwindsapm = SolarWindsAPM
+    ##
+    # noop version of :start
+    #
+    def self.start; end
+  end
+end