solarwinds_apm 6.0.0.prev6 → 6.0.1

data/lib/solarwinds_apm/api/tracing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 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
@@ -13,7 +15,7 @@ module SolarWindsAPM
       # information during the whole time the process is running. It returns boolean if <tt>integer_response</tt> is false,
       # and it will return integer if setting <tt>integer_response</tt> as true.
       # Usually SolarWinds doesn't block an application while it is starting up.
-      # 
+      #
       # For status code reference:
       #   0: unknown error
       #   1: is ready
@@ -32,18 +34,18 @@ module SolarWindsAPM
       #   unless SolarWindsAPM::API.solarwinds_ready?(10_000)
       #     Logger.info "SolarWindsAPM not ready after 10 seconds, no metrics will be sent"
       #   end
-      # 
+      #
       #   # with status code print out
       #   status = SolarWindsAPM::API.solarwinds_ready?(10_000, integer_response: true)
       #   unless status == 1
       #     Logger.info "SolarWindsAPM not ready after 10 seconds, no metrics will be sent. Error code "#{status}"
       #   end
-      # 
+      #
       # === Returns:
       # * Boolean (if integer_response: false)
       # * Integer (if integer_response: true)
       #
-      def solarwinds_ready?(wait_milliseconds=3000, integer_response: false)
+      def solarwinds_ready?(wait_milliseconds = 3000, integer_response: false)
         return false unless SolarWindsAPM.loaded
 
         is_ready = SolarWindsAPM::Context.isReady(wait_milliseconds)
@@ -54,4 +56,4 @@ module SolarWindsAPM
       end
     end
   end
-end
+end

data/lib/solarwinds_apm/api/transaction_name.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 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
@@ -35,35 +37,43 @@ module SolarWindsAPM
       # === Returns:
       # * Boolean
       #
-      def set_transaction_name(custom_name=nil)
+      def set_transaction_name(custom_name = nil)
         status = true
         if ENV.fetch('SW_APM_ENABLED', 'true') == 'false' ||
            SolarWindsAPM::Context.toString == '99-00000000000000000000000000000000-0000000000000000-00'
           # library disabled or noop, just log and skip work.
           # TODO: can we have a single indicator that the API is in noop mode?
-          SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] SolarWindsAPM is in disabled or noop mode."}
+          SolarWindsAPM.logger.debug { "[#{name}/#{__method__}] SolarWindsAPM is in disabled or noop mode." }
         elsif custom_name.nil? || custom_name.empty?
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: custom_name is either nil or empty string."}
+          SolarWindsAPM.logger.warn do
+            "[#{name}/#{__method__}] Set transaction name failed: custom_name is either nil or empty string."
+          end
           status = false
-        elsif SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor].nil?
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: Solarwinds processor is missing."}
+        elsif SolarWindsAPM::OTelConfig[:metrics_processor].nil?
+          SolarWindsAPM.logger.warn do
+            "[#{name}/#{__method__}] Set transaction name failed: Solarwinds processor is missing."
+          end
           status = false
         else
-          solarwinds_processor = SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor]
-          current_span         = ::OpenTelemetry::Trace.current_span
+          solarwinds_processor = SolarWindsAPM::OTelConfig[:metrics_processor]
+          current_span = ::OpenTelemetry::Trace.current_span
 
           if current_span.context.valid?
             current_trace_id = current_span.context.hex_trace_id
             entry_span_id, trace_flags = solarwinds_processor.txn_manager.get_root_context_h(current_trace_id)&.split('-')
             if entry_span_id.to_s.empty? || trace_flags.to_s.empty?
-              SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: record not found in the transaction manager."}
+              SolarWindsAPM.logger.warn do
+                "[#{name}/#{__method__}] Set transaction name failed: record not found in the transaction manager."
+              end
               status = false
             else
-              solarwinds_processor.txn_manager.set("#{current_trace_id}-#{entry_span_id}",custom_name)
-              SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Cached custom transaction name for #{current_trace_id}-#{entry_span_id} as #{custom_name}"}
+              solarwinds_processor.txn_manager.set("#{current_trace_id}-#{entry_span_id}", custom_name)
+              SolarWindsAPM.logger.debug do
+                "[#{name}/#{__method__}] Cached custom transaction name for #{current_trace_id}-#{entry_span_id} as #{custom_name}"
+              end
             end
           else
-            SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: invalid span context."}
+            SolarWindsAPM.logger.warn { "[#{name}/#{__method__}] Set transaction name failed: invalid span context." }
             status = false
           end
         end

data/lib/solarwinds_apm/api.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 # © 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.
 
-require_relative './api/transaction_name'
-require_relative './api/current_trace_info'
-require_relative './api/tracing'
-require_relative './api/opentelemetry'
-require_relative './api/custom_metrics'
+require_relative 'api/transaction_name'
+require_relative 'api/current_trace_info'
+require_relative 'api/tracing'
+require_relative 'api/opentelemetry'
+require_relative 'api/custom_metrics'
 
 module SolarWindsAPM
   module API
@@ -18,4 +20,4 @@ module SolarWindsAPM
     extend SolarWindsAPM::API::OpenTelemetry
     extend SolarWindsAPM::API::CustomMetrics
   end
-end
+end

data/lib/solarwinds_apm/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 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
@@ -12,24 +14,24 @@ module SolarWindsAPM
   # Use SolarWindsAPM::Config.show to view the entire nested hash.
   #
   module Config
-    LOGGER_LEVEL_MAPPING = {-1 => ::Logger::FATAL,
-                             0 => ::Logger::FATAL,
-                             1 => ::Logger::ERROR,
-                             2 => ::Logger::WARN,
-                             3 => ::Logger::INFO,
-                             4 => ::Logger::DEBUG,
-                             5 => ::Logger::DEBUG,
-                             6 => ::Logger::DEBUG}.freeze
+    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,
-                         :dalli, :delayed_jobclient, :delayed_jobworker,
-                         :excon, :faraday, :graphql, :grpc_client, :grpc_server, :grape,
-                         :httpclient, :nethttp, :memcached, :mongo, :moped, :padrino, :rack, :redis,
-                         :resqueclient, :resqueworker, :rest_client,
-                         :sequel, :sidekiqclient, :sidekiqworker, :sinatra, :typhoeus,
-                         :curb, :excon, :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
+    @@instrumentation = %i[action_controller action_controller_api action_view
+                           active_record bunnyclient bunnyconsumer curb
+                           dalli delayed_jobclient delayed_jobworker
+                           excon faraday graphql grpc_client grpc_server grape
+                           httpclient nethttp memcached mongo moped padrino rack redis
+                           resqueclient resqueworker rest_client
+                           sequel sidekiqclient sidekiqworker sinatra typhoeus
+                           curb excon faraday httpclient nethttp rest_client typhoeus]
 
     ##
     # load_config_file
@@ -53,26 +55,32 @@ module SolarWindsAPM
       config_files << config_file if File.exist?(config_file)
 
       # Check for file set by env variable
-      config_files << config_file_from_env if ENV.has_key?('SW_APM_CONFIG_RUBY')
+      config_files << config_file_from_env if ENV.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
+      SolarWindsAPM.logger.debug { "[#{name}/#{__method__}] Available config_files: #{config_files.join(', ')}" }
+      if config_files.size > 1
+        SolarWindsAPM.logger.warn do
+          "[#{name}/#{__method__}] Multiple configuration files configured, using the first one listed: #{config_files.join(', ')}"
+        end
+      end
+      load(config_files[0]) if config_files.size.positive?
 
-      set_log_level        # sets SolarWindsAPM::Config[:debug_level], SolarWindsAPM.logger.level
+      set_log_level # sets SolarWindsAPM::Config[:debug_level], SolarWindsAPM.logger.level
     end
 
     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'))
-        config_file = File.join(ENV['SW_APM_CONFIG_RUBY'], 'solarwinds_apm_config.rb')
+      if File.exist?(ENV.fetch('SW_APM_CONFIG_RUBY', nil)) && !File.directory?(ENV.fetch('SW_APM_CONFIG_RUBY', nil))
+        config_file = ENV.fetch('SW_APM_CONFIG_RUBY', nil)
+      elsif File.exist?(File.join(ENV.fetch('SW_APM_CONFIG_RUBY', nil), 'solarwinds_apm_config.rb'))
+        config_file = File.join(ENV.fetch('SW_APM_CONFIG_RUBY', nil), 'solarwinds_apm_config.rb')
       else
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Could not find the configuration file set by the SW_APM_CONFIG_RUBY environment variable:  #{ENV['SW_APM_CONFIG_RUBY']}"}
+        SolarWindsAPM.logger.warn do
+          "[#{name}/#{__method__}] Could not find the configuration file set by the SW_APM_CONFIG_RUBY environment variable:  #{ENV.fetch('SW_APM_CONFIG_RUBY', nil)}"
+        end
       end
       config_file
     end
@@ -82,7 +90,7 @@ module SolarWindsAPM
 
       SolarWindsAPM.logger = ::Logger.new(nil) if log_level == -1
 
-      SolarWindsAPM.logger.level = LOGGER_LEVEL_MAPPING[log_level] || ::Logger::INFO # default log level info
+      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)
@@ -92,7 +100,7 @@ module SolarWindsAPM
       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}.")
+        SolarWindsAPM.logger.warn("[#{name}/#{__method__}] #{env_var} must be #{valid_env_values.join('/')} (current setting is #{ENV.fetch(env_var, nil)}). Using default value: #{default}.")
         return @@config[key.to_sym] = default
       end
 
@@ -103,7 +111,7 @@ module SolarWindsAPM
     end
 
     def self.true?(obj)
-      obj.to_s.casecmp("true").zero?
+      obj.to_s.casecmp('true').zero?
     end
 
     def self.boolean?(obj)
@@ -111,7 +119,7 @@ module SolarWindsAPM
     end
 
     def self.symbol?(obj)
-      [:enabled, :disabled].include?(obj)
+      %i[enabled disabled].include?(obj)
     end
 
     ##
@@ -121,10 +129,15 @@ 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:"}
-      @@config.each do |k,v|
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Config Key/Value: #{k}, #{v.inspect}"}
+      SolarWindsAPM.logger.debug { "[#{name}/#{__method__}] General configurations list blow:" }
+      @@config.each do |k, v|
+        next if @@instrumentation.include?(k)
+
+        SolarWindsAPM.logger.debug do
+          "[#{name}/#{__method__}] Config Key/Value: #{k}, #{v.inspect}"
+        end
       end
+      nil
     end
 
     ##
@@ -136,12 +149,18 @@ module SolarWindsAPM
     #
     def self.initialize
       # for config file backward compatibility
-      @@instrumentation.each {|inst| @@config[inst] = {}}
+      @@instrumentation.each { |inst| @@config[inst] = {} }
       @@config[:transaction_name] = {}
 
       # Always load the template, it has all the keys and defaults defined,
       # no guarantee of completeness in the user's config file
-      load(File.join(File.dirname(File.dirname(__FILE__)), 'rails/generators/solarwinds_apm/templates/solarwinds_apm_initializer.rb'))
+
+      load(File.join(File.dirname(File.dirname(__FILE__)),
+                     'rails/generators/solarwinds_apm/templates/solarwinds_apm_initializer.rb'))
+
+      load_config_file
+
+      print_config if SolarWindsAPM.logger.level.zero?
     end
 
     def self.update!(data)
@@ -163,7 +182,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 
+    # ENV always have higher precedence
     #
     def self.[]=(key, value)
       key = key.to_sym
@@ -171,18 +190,24 @@ module SolarWindsAPM
 
       case key
       when :sampling_rate
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] sampling_rate is not a supported setting for SolarWindsAPM::Config. Please use :sample_rate."}
+        SolarWindsAPM.logger.warn do
+          "[#{name}/#{__method__}] sampling_rate is not a supported setting for SolarWindsAPM::Config. Please use :sample_rate."
+        end
 
       when :sample_rate
         unless value.is_a?(Integer) || value.is_a?(Float)
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] :sample_rate must be a number between 0 and 1000000 (1m) (provided: #{value}), corrected to 0"}
+          SolarWindsAPM.logger.warn do
+            "[#{name}/#{__method__}] :sample_rate must be a number between 0 and 1000000 (1m) (provided: #{value}), corrected to 0"
+          end
           value = 0
         end
 
         # Validate :sample_rate value
         unless value.between?(0, 1e6)
-          new_value = value < 0 ? 0 : 1_000_000
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] :sample_rate must be between 0 and 1000000 (1m) (provided: #{value}), corrected to #{new_value}"}
+          new_value = value.negative? ? 0 : 1_000_000
+          SolarWindsAPM.logger.warn do
+            "[#{name}/#{__method__}] :sample_rate must be between 0 and 1000000 (1m) (provided: #{value}), corrected to #{new_value}"
+          end
         end
 
         # Assure value is an integer
@@ -216,7 +241,7 @@ module SolarWindsAPM
       end
 
       # `tracing: disabled` is the default
-      disabled = settings.select { |v| !v.has_key?(:tracing) || v[:tracing] == :disabled }
+      disabled = settings.select { |v| !v.key?(:tracing) || v[:tracing] == :disabled }
       enabled  = settings.select { |v| v[:tracing] == :enabled }
 
       SolarWindsAPM::Config[:enabled_regexps] = compile_regexp(enabled)
@@ -233,18 +258,18 @@ module SolarWindsAPM
 
     def self.compile_settings_regexp(value)
       regexps = value.select do |v|
-        v.has_key?(:regexp) &&
+        v.key?(:regexp) &&
           !(v[:regexp].is_a?(String) && v[:regexp].empty?) &&
           !(v[:regexp].is_a?(Regexp) && v[:regexp].inspect == '//')
       end
 
       regexps.map! do |v|
-        begin
-          v[:regexp].is_a?(String) ? Regexp.new(v[:regexp], v[:opts]) : Regexp.new(v[:regexp])
-        rescue StandardError => e
-          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Problem compiling transaction_settings item #{v}, will ignore. Error: #{e.message}"}
-          nil
+        v[:regexp].is_a?(String) ? Regexp.new(v[:regexp], v[:opts]) : Regexp.new(v[:regexp])
+      rescue StandardError => e
+        SolarWindsAPM.logger.warn do
+          "[#{name}/#{__method__}] Problem compiling transaction_settings item #{v}, will ignore. Error: #{e.message}"
         end
+        nil
       end
       regexps.keep_if { |v| !v.nil? }
       regexps.empty? ? nil : regexps

data/lib/solarwinds_apm/constants.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 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
@@ -7,30 +9,28 @@
 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
-
-    INTL_SWO_AO_COLLECTOR            = "collector.appoptics.com".freeze
-    INTL_SWO_AO_STG_COLLECTOR        = "collector-stg.appoptics.com".freeze
-    INTL_SWO_COMMA                   = ",".freeze
-    INTL_SWO_COMMA_W3C_SANITIZED     = "....".freeze
-    INTL_SWO_EQUALS                  = "=".freeze
-    INTL_SWO_EQUALS_W3C_SANITIZED    = "####".freeze
-    INTL_SWO_TRACESTATE_KEY          = "sw".freeze
-    INTL_SWO_X_OPTIONS_KEY           = "sw_xtraceoptions".freeze
-    INTL_SWO_SIGNATURE_KEY           = "sw_signature".freeze
-    INTL_SWO_DEFAULT_TRACES_EXPORTER = "solarwinds_exporter".freeze
-    INTL_SWO_TRACECONTEXT_PROPAGATOR = "tracecontext".freeze
-    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_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
+    HTTP_METHOD                      = 'http.method'
+    HTTP_ROUTE                       = 'http.route'
+    HTTP_STATUS_CODE                 = 'http.status_code'
+    HTTP_URL                         = 'http.url'
+    INTL_SWO_AO_COLLECTOR            = 'collector.appoptics.com'
+    INTL_SWO_AO_STG_COLLECTOR        = 'collector-stg.appoptics.com'
+    INTL_SWO_COMMA                   = ','
+    INTL_SWO_COMMA_W3C_SANITIZED     = '....'
+    INTL_SWO_EQUALS                  = '='
+    INTL_SWO_EQUALS_W3C_SANITIZED    = '####'
+    INTL_SWO_TRACESTATE_KEY          = 'sw'
+    INTL_SWO_X_OPTIONS_KEY           = 'sw_xtraceoptions'
+    INTL_SWO_SIGNATURE_KEY           = 'sw_signature'
+    INTL_SWO_DEFAULT_TRACES_EXPORTER = 'solarwinds_exporter'
+    INTL_SWO_TRACECONTEXT_PROPAGATOR = 'tracecontext'
+    INTL_SWO_PROPAGATOR              = 'solarwinds_propagator'
+    INTL_SWO_DEFAULT_PROPAGATORS     = [INTL_SWO_TRACECONTEXT_PROPAGATOR, 'baggage', INTL_SWO_PROPAGATOR].freeze
+    INTL_SWO_SUPPORT_EMAIL           = 'SWO-support@solarwinds.com'
+    INTL_SWO_OTEL_SCOPE_NAME         = 'otel.scope.name'
+    INTL_SWO_OTEL_SCOPE_VERSION      = 'otel.scope.version'
+    INTL_SWO_OTEL_STATUS             = 'otel.status'
+    INTL_SWO_OTEL_STATUS_DESCRIPTION = 'otel.status_description'
+    INTERNAL_TRIGGERED_TRACE         = 'TriggeredTrace'
   end
-end
+end

data/lib/solarwinds_apm/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 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

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,85 @@
+# frozen_string_literal: true
+
+# © 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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 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
@@ -7,9 +9,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 +23,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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # © 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
@@ -7,8 +9,7 @@
 ####
 # noop version of SolarWindsAPM::Metadata
 #
-#
-module SolarWindsAPM
+module Oboe_metal # rubocop:disable Naming/ClassAndModuleCamelCase
   # Metadata
   class Metadata
     ##
@@ -20,6 +21,10 @@ module SolarWindsAPM
       Metadata.new
     end
 
+    def self.fromString(*)
+      Metadata.new
+    end
+
     def isValid
       false
     end

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

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 # © 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.
 
-##
-# This module is the base module for SolarWindsAPM reporting.
+####
+# noop version of SolarWindsAPM::Span
 #
-module SolarWindsAPMBase
-  extend SolarWindsAPM::ThreadLocal
-
-  attr_accessor :reporter, :loaded
-end
+module Oboe_metal # rubocop:disable Naming/ClassAndModuleCamelCase
+  # Span
+  class Span
+    ##
+    # noop version of :createHttpSpan
+    #
+    def self.createHttpSpan(*); end
 
-module SolarWindsAPM
-  extend SolarWindsAPMBase
+    ##
+    # noop version of :createSpan
+    #
+    def self.createSpan(*); end
+  end
 end
-
-# Setup an alias
-SolarWindsApm = SolarWindsAPM
-SolarwindsApm = SolarWindsAPM
-SolarwindsAPM = SolarWindsAPM
-Solarwindsapm = SolarWindsAPM