solarwinds_apm 6.0.0.preV4 → 6.0.0.prev6

data/lib/oboe_metal.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 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.
 
 # Disable docs and Camelcase warns since we're implementing
 # an interface here.  See OboeBase for details.

data/lib/rails/generators/solarwinds_apm/install_generator.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 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.
 
 module SolarWindsAPM
   # InstallGenerator

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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 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.
 
 # SolarWindsAPM Configuration for the Ruby Agent aka solarwinds_apm gem
 # https://cloud.solarwinds.com/
@@ -33,7 +36,8 @@ if defined?(SolarWindsAPM::Config)
   # SolarWindsAPM::Config[:hostname_alias] = 'alias_name'
 
   #
-  # Set Proxy for SolarWinds   # This setting will be overridden if SW_APM_PROXY is set as an environment variable.
+  # Set Proxy for SolarWinds
+  # This setting will be overridden if SW_APM_PROXY is set as an environment variable.
   #
   # Please configure http_proxy if a proxy needs to be used to communicate with
   # the SolarWinds APM collector.
@@ -143,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

@@ -1,7 +1,9 @@
-#--
-# Copyright (c) SolarWinds, LLC.
-# All rights reserved.
-#++
+# © 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.
+
 module SolarWindsAPM
   module API
     module CurrentTraceInfo
@@ -49,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
@@ -96,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/custom_metrics.rb

@@ -0,0 +1,93 @@
+# © 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.
+
+module SolarWindsAPM
+  module API
+    module CustomMetrics
+      # Send counts
+      #
+      # Use this method to report the number of times an action occurs. The metric counts reported are summed and flushed every 60 seconds.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def counting(name, tags = {})
+      #       yield # yield to where work is done
+      #       SolarWindsAPM::API.increment_metric(name, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * Boolean
+      #
+      def increment_metric(name, count=1, with_hostname=false, tags_kvs={}) # rubocop:disable Style/OptionalBooleanParameter
+        return true unless SolarWindsAPM.loaded
+
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        SolarWindsAPM::CustomMetrics.increment(name.to_s, count, with_hostname, nil, tags, tags_count) == 0
+      end
+
+      # Send values with counts
+      #
+      # Use this method to report a value for each or multiple counts. The metric values reported are aggregated and flushed every 60 seconds. The dashboard displays the average value per count.
+      #
+      # === Arguments:
+      #
+      # * +name+          (String) Name to be used for the metric. Must be 255 or fewer characters and consist only of A-Za-z0-9.:-*
+      # * +value+         (Numeric) Value to be added to the current sum
+      # * +count+         (Integer, optional, default = 1): Count of actions being reported
+      # * +with_hostname+ (Boolean, optional, default = false): Indicates if the host name should be included as a tag for the metric
+      # * +tags_kvs+      (Hash, optional): List of key/value pairs to describe the metric. The key must be <= 64 characters, the value must be <= 255 characters, allowed characters: A-Za-z0-9.:-_
+      #
+      # === Example:
+      #
+      #   class WorkTracker
+      #     def timing(name, tags = {})
+      #       start = Time.now
+      #       yield # yield to where work is done
+      #       duration = Time.now - start
+      #       SolarWindsAPM::API.summary_metric(name, duration, 1, false, tags)
+      #     end
+      #   end
+      #
+      # === Returns:
+      # * Boolean
+      #
+      def summary_metric(name, value, count=1, with_hostname=false, tags_kvs={}) # rubocop:disable Style/OptionalBooleanParameter
+        return true unless SolarWindsAPM.loaded
+
+        with_hostname = with_hostname ? 1 : 0
+        tags, tags_count = make_tags(tags_kvs)
+        SolarWindsAPM::CustomMetrics.summary(name.to_s, value, count, with_hostname, nil, tags, tags_count) == 0
+      end
+
+      private
+
+      def make_tags(tags_kvs)
+        unless tags_kvs.is_a?(Hash)
+          SolarWindsAPM.logger.warn("[solarwinds_apm/metrics] CustomMetrics received tags_kvs that are not a Hash (found #{tags_kvs.class}), setting tags_kvs = {}")
+          tags_kvs = {}
+        end
+        count = tags_kvs.size
+        tags = SolarWindsAPM::MetricTags.new(count)
+
+        tags_kvs.each_with_index do |(k, v), i|
+          tags.add(i, k.to_s, v.to_s)
+        end
+
+        [tags, count]
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/api/opentelemetry.rb

@@ -1,3 +1,9 @@
+# © 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.
+
 module SolarWindsAPM
   module API
     module OpenTelemetry

data/lib/solarwinds_apm/api/tracing.rb

@@ -1,15 +1,31 @@
+# © 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.
+
 module SolarWindsAPM
   module API
     module Tracing
       # Wait for SolarWinds to be ready to send traces.
       #
       # This may be useful in short lived background processes when it is important to capture
-      # information during the whole time the process is running. Usually SolarWinds doesn't block an
-      # application while it is starting up.
+      # 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
+      #   2: not ready yet, try later
+      #   3: limit exceeded
+      #   4: invalid API key
+      #   5: connection error
       #
       # === Argument:
       #
       # * +wait_milliseconds+ - (int, default 3000) the maximum time to wait in milliseconds
+      # * +integer_response+  - (boolean, default false) determine whether return status code of reporter or not
       #
       # === Example:
       #
@@ -17,13 +33,24 @@ module SolarWindsAPM
       #     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
+      # * Boolean (if integer_response: false)
+      # * Integer (if integer_response: true)
       #
-      def solarwinds_ready?(wait_milliseconds=3000)
+      def solarwinds_ready?(wait_milliseconds=3000, integer_response: false)
         return false unless SolarWindsAPM.loaded
 
-        SolarWindsAPM::Context.isReady(wait_milliseconds) == 1
+        is_ready = SolarWindsAPM::Context.isReady(wait_milliseconds)
+
+        return is_ready if integer_response
+
+        is_ready == 1
       end
     end
   end

data/lib/solarwinds_apm/api/transaction_name.rb

@@ -1,3 +1,9 @@
+# © 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.
+
 module SolarWindsAPM
   module API
     module TransactionName
@@ -30,26 +36,36 @@ module SolarWindsAPM
       # * Boolean
       #
       def set_transaction_name(custom_name=nil)
-        
         status = true
-        if custom_name.nil? || custom_name.empty? 
+        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."}
+        elsif custom_name.nil? || custom_name.empty?
+          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: custom_name is either nil or empty string."}
           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."}
+          SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: Solarwinds processor is missing."}
           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('-')
-
-          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
+          solarwinds_processor = SolarWindsAPM::OTelConfig.class_variable_get(:@@config)[:span_processor]
+          current_span         = ::OpenTelemetry::Trace.current_span
 
-          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}"}
+          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."}
+              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}"}
+            end
+          else
+            SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Set transaction name failed: invalid span context."}
+            status = false
+          end
         end
         status
       end

data/lib/solarwinds_apm/api.rb

@@ -1,10 +1,14 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 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'
 
 module SolarWindsAPM
   module API
@@ -12,5 +16,6 @@ module SolarWindsAPM
     extend SolarWindsAPM::API::CurrentTraceInfo
     extend SolarWindsAPM::API::Tracing
     extend SolarWindsAPM::API::OpenTelemetry
+    extend SolarWindsAPM::API::CustomMetrics
   end
 end

data/lib/solarwinds_apm/base.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 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.
@@ -8,18 +11,6 @@ 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
 
 module SolarWindsAPM

data/lib/solarwinds_apm/config.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 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.
 
 module SolarWindsAPM
   ##
@@ -9,6 +12,15 @@ 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
+
     @@config = {}
     @@instrumentation = [:action_controller, :action_controller_api, :action_view,
                          :active_record, :bunnyclient, :bunnyconsumer, :curb,
@@ -41,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'))
@@ -65,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 = LOGGER_LEVEL_MAPPING[log_level] || ::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
 
     ##
@@ -90,8 +132,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] = {}
@@ -120,6 +163,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
@@ -148,17 +192,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

@@ -1,3 +1,9 @@
+# © 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.
+
 module SolarWindsAPM
   # Constants
   module Constants

data/lib/solarwinds_apm/logger.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2016 SolarWinds, LLC.
-# All rights reserved.
+# © 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 'logger'
 

data/lib/solarwinds_apm/noop/context.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 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::Context

data/lib/solarwinds_apm/noop/metadata.rb

@@ -1,5 +1,8 @@
-# Copyright (c) 2019 SolarWinds, LLC.
-# All rights reserved.
+# © 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::Metadata