solarwinds_apm 6.0.0.prev6 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 512ec5ee7d54316580c83a629faccc98c8c435151f0dade34d102597ad700a9f
-  data.tar.gz: 7a6f84e7c04493d368a157ed098ae2ea67898c40d2eba23e6a2467d6de6faf18
+  metadata.gz: 5dfd38bd4d4e3d70c56b86ffd34d9fe830e0944eb3fd02a82bff26da07900056
+  data.tar.gz: 1ec9662543689c97af6509f2db2bde6e62bd9274fd2b792925d4ebf9fd46c4fb
 SHA512:
-  metadata.gz: 5fbd2c89241e02a6ab3e54bc430f92f98a5ac13ebf9f3cad135b045aea679a9f170ff0cbf5c3f6cf162f3fd90fdb2d6200e692be4259527cf06eea05904b91b4
-  data.tar.gz: e49ec590eb79e9d4c436f8341bffe16cb8d6fe07e77cb2939159da6b0b33222aed3d4d9bb8610cef55a59b572543c5d74eef2bef9179b2a5a65df258b2a0e8ca
+  metadata.gz: c90b9be36843bf092833fafc3fc16e6f97cf293787fd9551375b39a67c8f057b737c11145764eb47590b060bc22a60c367911bf8e31b3b5718452ad8b0e50234
+  data.tar.gz: 29e352eb73da5c09fc0caf35e73e65facb842d7becab500e0183071ec4aaa563daf0ae2bd483972f0ef2e5b51a780821b0075b432d2a86892e82eedc8c4f71ad

data/ext/oboe_metal/extconf.rb

@@ -42,7 +42,7 @@ system_arch.delete!("\n")
 case system_arch
 when 'x86_64'
   swo_arch = 'x86_64'
-when 'aarch64'
+when 'aarch64' || 'arm64'
   swo_arch = 'aarch64'
 end
 

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/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,14 +12,14 @@ 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,
@@ -82,7 +82,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)
@@ -121,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
 
     ##

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/{base.rb → noop/span.rb}

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

data/lib/solarwinds_apm/noop.rb

@@ -0,0 +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.
+
+require_relative './noop/context'
+require_relative './noop/metadata'
+require_relative './noop/span'
+require_relative './noop/api'
+
+module SolarWindsAPM
+  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
+
+    ##
+    # noop version of :start
+    #
+    def self.start; end
+  end
+end

data/lib/solarwinds_apm/oboe_init_options.rb

@@ -7,6 +7,8 @@
 require 'singleton'
 require 'uri'
 
+require_relative './support/service_key_checker'
+
 module SolarWindsAPM
   # OboeInitOptions
   class OboeInitOptions
@@ -125,81 +127,10 @@ module SolarWindsAPM
     end
 
     def read_and_validate_service_key
-      return '' unless @reporter == 'ssl'
-
-      service_key = ENV['SW_APM_SERVICE_KEY'] || SolarWindsAPM::Config[:service_key]
-      if service_key.nil? || service_key == ''
-        SolarWindsAPM.logger.error {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY not configured."}
-        return ''
-      end
-
-      match = service_key.match(/([^:]+)(:{0,1})(.*)/)
-      token = match[1]
-      service_name = match[3]
-
-      return '' unless validate_token(token)   # return if token is not even valid
-
-      if service_name.empty?
-        ENV.delete('OTEL_SERVICE_NAME')
-        SolarWindsAPM.logger.warn {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY format problem. Service Name is missing."}
-        return ''
-      end
-
-      # check OTEL_RESOURCE_ATTRIBUTES
-      otel_resource_service_name = nil
-      ENV['OTEL_RESOURCE_ATTRIBUTES']&.split(',')&.each do |pair|
-        key, value = pair.split('=')
-        if key == 'service.name'
-          otel_resource_service_name = value
-          break
-        end
-      end
-
-      SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] provided otel_resource_service_name #{otel_resource_service_name}"} if otel_resource_service_name
-      service_name = otel_resource_service_name if otel_resource_service_name && validate_transform_service_name(otel_resource_service_name)
-
-      # check OTEL_SERVICE_NAME
-      otel_service_name = ENV['OTEL_SERVICE_NAME']
-      if otel_service_name && validate_transform_service_name(otel_service_name)
-        service_name = otel_service_name
-        SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] provided otel_service_name #{otel_service_name}"}
-      elsif ENV['OTEL_SERVICE_NAME'].nil?
-        ENV['OTEL_SERVICE_NAME'] = service_name
-      end
-
-      return '' unless validate_transform_service_name(service_name)
-
-      "#{token}:#{service_name}"
-    end
-
-    # In case of java-collector, please provide a dummy service key
-    def validate_token(token)
-      unless /^[0-9a-zA-Z_-]{71}$/.match?(token)
-        masked = "#{token[0..3]}...#{token[-4..]}"
-        SolarWindsAPM.logger.error {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY problem. API Token in wrong format. Masked token: #{masked}"}
-        return false
-      end
-
-      true
-    end
-
-    def validate_transform_service_name(service_name)
-      if service_name.empty?
-        SolarWindsAPM.logger.error {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY problem. Service Name is missing"}
-        return false
-      end
-
-      name_ = service_name.dup
-      name_.downcase!
-      name_.gsub!(/[^a-z0-9.:_-]/, '')
-      name_ = name_[0..254]
-
-      if name_ != service_name
-        SolarWindsAPM.logger.warn {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY problem. Service Name transformed from #{service_name} to #{name_}"}
-        service_name = name_
-      end
-      @service_name = service_name # instance variable used in testing
-      true
+      service_key_checker = SolarWindsAPM::ServiceKeyChecker.new(@reporter)
+      service_key = service_key_checker.read_and_validate_service_key
+      @service_name = service_key.split(':',2).last # instance variable used in testing
+      service_key
     end
 
     def read_and_validate_ec2_md_timeout

data/lib/solarwinds_apm/opentelemetry/solarwinds_processor.rb

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

data/lib/solarwinds_apm/opentelemetry/solarwinds_sampler.rb

@@ -102,7 +102,7 @@ module SolarWindsAPM
         end
 
         sw_member_value    = parent_span_context.tracestate[SolarWindsAPM::Constants::INTL_SWO_TRACESTATE_KEY]
-        trigger_trace_mode = OboeTracingMode.get_oboe_trigger_trace_mode(@config["trigger_trace"])
+        trigger_trace_mode = SolarWindsAPM::OboeTracingMode.get_oboe_trigger_trace_mode(@config["trigger_trace"])
         sample_rate        = UNSET
         options            = xtraceoptions&.options
         trigger_trace      = xtraceoptions&.intify_trigger_trace || 0
@@ -291,4 +291,4 @@ module SolarWindsAPM
       end
     end
   end
-end
+end

data/lib/solarwinds_apm/opentelemetry.rb

@@ -11,4 +11,4 @@ require_relative './opentelemetry/solarwinds_propagator'
 require_relative './opentelemetry/solarwinds_processor'
 require_relative './opentelemetry/solarwinds_sampler'
 require_relative './opentelemetry/solarwinds_exporter'
-require_relative './opentelemetry/solarwinds_response_propagator'
+require_relative './opentelemetry/solarwinds_response_propagator'

data/lib/solarwinds_apm/otel_config.rb

@@ -22,12 +22,6 @@ module SolarWindsAPM
       SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] Agent disabled. No Trace exported."}
     end
 
-    def self.validate_service_key
-      return unless (ENV['SW_APM_REPORTER'] || 'ssl') == 'ssl'
-
-      disable_agent unless ENV['SW_APM_SERVICE_KEY'] || SolarWindsAPM::Config[:service_key]
-    end
-
     def self.resolve_sampler
       sampler_config = {"trigger_trace" => SolarWindsAPM::Config[:trigger_tracing_mode]}
       @@config[:sampler] =
@@ -62,12 +56,13 @@ module SolarWindsAPM
     end
 
     def self.print_config
-      @@config.each do |config, value|
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] config:     #{config} = #{value}"}
+      @@config.each do |k,v|
+        SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Config Key/Value: #{k}, #{v.class}"}
       end
-      @@config_map.each do |config, value|
-        SolarWindsAPM.logger.warn {"[#{name}/#{__method__}] config_map: #{config} = #{value}"}
+      @@config_map.each do |k,v|
+        SolarWindsAPM.logger.debug {"[#{name}/#{__method__}] Config Key/Value: #{k}, #{v}"}
       end
+      nil
     end
 
     def self.resolve_solarwinds_processor
@@ -100,29 +95,22 @@ module SolarWindsAPM
         return
       end
 
-      validate_service_key
-
-      return unless @@agent_enabled
-
       resolve_sampler
-
       resolve_solarwinds_propagator
       resolve_solarwinds_processor
       resolve_response_propagator
 
       print_config if SolarWindsAPM.logger.level.zero?
 
+      # resolve OTEL environmental variables
       ENV['OTEL_TRACES_EXPORTER'] = 'none' if ENV['OTEL_TRACES_EXPORTER'].to_s.empty?
-
       if ENV['OTEL_LOG_LEVEL'].to_s.empty?
-        ::OpenTelemetry::SDK.configure do |c|
-          c.logger = ::Logger.new($stdout, level: ::SolarWindsAPM.logger.level) # sync solarwinds_apm logger to otel log
-          c.use_all(@@config_map)
-        end
-      else
-        ::OpenTelemetry::SDK.configure { |c| c.use_all(@@config_map) }
+        log_level = (ENV['SW_APM_DEBUG_LEVEL'] || SolarWindsAPM::Config[:debug_level] || 3).to_i
+        ENV['OTEL_LOG_LEVEL'] = SolarWindsAPM::Config::SW_LOG_LEVEL_MAPPING.dig(log_level, :otel)
       end
 
+      ::OpenTelemetry::SDK.configure { |c| c.use_all(@@config_map) }
+
       validate_propagator(::OpenTelemetry.propagation.instance_variable_get(:@propagators))
 
       return unless @@agent_enabled

data/lib/solarwinds_apm/patch/dummy_patch.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module SolarWindsAPM
+  module Patch
+    module DummyPatch
+    end
+  end
+end

data/lib/solarwinds_apm/{thread_local.rb → patch.rb}

@@ -4,26 +4,8 @@
 #
 # 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
+# This file is for loading any customized patch for upstream
 
-      define_method(name) do
-        Thread.current[key]
-      end
-
-      define_method("#{name}=") do |value|
-        Thread.current[key] = value
-      end
-    end
-  end
-end
+# e.g.
+# require_relative './patch/dummy_patch'
+# OpenTelemetry::Instrumentation::Registry.prepend(SolarWindsAPM::Patch::DummyPatch) if defined? OpenTelemetry::Instrumentation::Registry && OpenTelemetry::Instrumentation::Registry::VERSION <= '0.3.0'

data/lib/solarwinds_apm/support/oboe_tracing_mode.rb

@@ -5,29 +5,27 @@
 # 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 OpenTelemetry
-    # OboeTracingMode
-    # Used in solarwinds_sampler
-    class OboeTracingMode
-      OBOE_SETTINGS_UNSET = -1
-      OBOE_TRACE_DISABLED = 0
-      OBOE_TRACE_ENABLED = 1
-      OBOE_TRIGGER_DISABLED = 0
-      OBOE_TRIGGER_ENABLED = 1
+  # OboeTracingMode
+  # Used in solarwinds_sampler
+  class OboeTracingMode
+    OBOE_SETTINGS_UNSET = -1
+    OBOE_TRACE_DISABLED = 0
+    OBOE_TRACE_ENABLED = 1
+    OBOE_TRIGGER_DISABLED = 0
+    OBOE_TRIGGER_ENABLED = 1
 
-      def self.get_oboe_trace_mode(tracing_mode)
-        mode = OBOE_SETTINGS_UNSET
-        mode = OBOE_TRACE_ENABLED if tracing_mode == :enabled
-        mode = OBOE_TRACE_DISABLED if tracing_mode == :disabled
-        mode
-      end
+    def self.get_oboe_trace_mode(tracing_mode)
+      mode = OBOE_SETTINGS_UNSET
+      mode = OBOE_TRACE_ENABLED if tracing_mode == :enabled
+      mode = OBOE_TRACE_DISABLED if tracing_mode == :disabled
+      mode
+    end
 
-      def self.get_oboe_trigger_trace_mode(trigger_trace_mode)
-        mode = OBOE_SETTINGS_UNSET
-        mode = OBOE_TRIGGER_ENABLED if trigger_trace_mode == :enabled
-        mode = OBOE_TRIGGER_DISABLED if trigger_trace_mode == :disabled
-        mode
-      end
+    def self.get_oboe_trigger_trace_mode(trigger_trace_mode)
+      mode = OBOE_SETTINGS_UNSET
+      mode = OBOE_TRIGGER_ENABLED if trigger_trace_mode == :enabled
+      mode = OBOE_TRIGGER_DISABLED if trigger_trace_mode == :disabled
+      mode
     end
   end
-end
+end

data/lib/solarwinds_apm/support/service_key_checker.rb

@@ -0,0 +1,94 @@
+# © 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
+  # ServiceKeyChecker
+  # It is a service that validate the service_key
+  class ServiceKeyChecker
+    def initialize(reporter)
+      @reporter = reporter
+    end
+
+    def read_and_validate_service_key
+      return '' unless @reporter == 'ssl'
+
+      service_key = fetch_service_key
+      if service_key.empty?
+        SolarWindsAPM.logger.error {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY not configured."}
+        return ''
+      end
+
+      token, _, service_name = parse_service_key(service_key)
+      if token.empty? || !validate_token(token)
+        SolarWindsAPM.logger.error {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY problem. API Token in wrong format. Masked token: #{token[0..3]}...#{token[-4..]}"}
+        return ''
+      end
+
+      # if no service_name from service_key, then the SW_APM_SERVICE_KEY is not right format, return
+      if service_name.empty?
+        ENV.delete('OTEL_SERVICE_NAME')
+        SolarWindsAPM.logger.warn {"[#{self.class}/#{__method__}] SW_APM_SERVICE_KEY format problem. Service Name is missing."}
+        return ''
+      end
+
+      service_name = transform_service_name(service_name)
+
+      # check if otel_resource_service or otel_service_name has service name to override the original service name
+      otel_resource_service_name = fetch_otel_resource_service_name
+      service_name = transform_service_name(otel_resource_service_name) unless otel_resource_service_name.empty?
+
+      otel_service_name = fetch_otel_service_name
+      if otel_service_name.empty?
+        ENV['OTEL_SERVICE_NAME'] = service_name
+      else
+        service_name = transform_service_name(otel_service_name)
+      end
+
+      "#{token}:#{service_name}"
+    end
+
+    private
+
+    # since oboe_init_options init afte config, so [:service_key] will be present at this point
+    def fetch_service_key
+      ENV['SW_APM_SERVICE_KEY'] || SolarWindsAPM::Config[:service_key] || ''
+    end
+
+    def parse_service_key(service_key)
+      match = service_key.match(/([^:]+)(:{0,1})(.*)/)
+      return ['', '', ''] if match.nil?
+
+      [match[1], match[2], match[3]]
+    end
+
+    # precedence: OTEL_SERVICE_NAME > OTEL_RESOURCE_ATTRIBUTES > service_key
+    def fetch_otel_service_name
+      ENV['OTEL_SERVICE_NAME'] || ''
+    end
+
+    def fetch_otel_resource_service_name
+      ENV['OTEL_RESOURCE_ATTRIBUTES']&.split(',')&.find do |pair|
+        key, value = pair.split('=')
+        break value if key == 'service.name'
+      end || ''
+    end
+
+    # In case of java-collector, please provide a dummy service key
+    def validate_token(token)
+      /^[0-9a-zA-Z_-]{71}$/.match?(token)
+    end
+
+    def transform_service_name(service_name)
+      name_ = service_name.dup
+      name_.downcase!
+      name_.gsub!(/[^a-z0-9.:_-]/, '')
+      name_ = name_[0..254]
+      SolarWindsAPM.logger.warn {"[#{self.class}/#{__method__}] Service Name transformed from #{service_name} to #{name_}"} if name_ != service_name
+
+      name_
+    end
+  end
+end

data/lib/solarwinds_apm/{support_report.rb → support/support_report.rb}

@@ -7,12 +7,11 @@
 require 'rbconfig'
 require 'logger'
 
+##
+# This module is used to debug problematic setups and/or environments.
+# Depending on the environment, output may be to stdout or the framework
+# log file (e.g. log/production.log)
 module SolarWindsAPM
-  ##
-  # This module is used to debug problematic setups and/or environments.
-  # Depending on the environment, output may be to stdout or the framework
-  # log file (e.g. log/production.log)
-
   ##
   # yesno
   #
@@ -71,6 +70,12 @@ module SolarWindsAPM
     SolarWindsAPM.logger.warn '********************************************************'
     SolarWindsAPM.logger.warn '* SolarWindsAPM::Config Values'
     SolarWindsAPM.logger.warn '********************************************************'
+    SolarWindsAPM.logger.warn SolarWindsAPM::Config.print_config.to_s
+    
+    SolarWindsAPM.logger.warn '********************************************************'
+    SolarWindsAPM.logger.warn '* SolarWindsAPM::OTelConfig Values'
+    SolarWindsAPM.logger.warn '********************************************************'
+    SolarWindsAPM.logger.warn SolarWindsAPM::OTelConfig.print_config.to_s
 
     SolarWindsAPM.logger.warn '********************************************************'
     SolarWindsAPM.logger.warn '* OS, Platform + Env'
@@ -78,9 +83,7 @@ module SolarWindsAPM
     SolarWindsAPM.logger.warn "host_os:  #{RbConfig::CONFIG['host_os']}"
     SolarWindsAPM.logger.warn "sitearch: #{RbConfig::CONFIG['sitearch']}"
     SolarWindsAPM.logger.warn "arch:     #{RbConfig::CONFIG['arch']}"
-    SolarWindsAPM.logger.warn RUBY_PLATFORM
-    SolarWindsAPM.logger.warn "RACK_ENV: #{ENV['RACK_ENV']}"
-    SolarWindsAPM.logger.warn "RAILS_ENV: #{ENV['RAILS_ENV']}" if using_rails
+    SolarWindsAPM.logger.warn "Platform: #{RUBY_PLATFORM}"
 
     SolarWindsAPM.logger.warn '********************************************************'
     SolarWindsAPM.logger.warn '* END SolarWindsAPM Support Report'

data/lib/solarwinds_apm/support.rb

@@ -15,6 +15,7 @@ require_relative './support/oboe_tracing_mode'
 require_relative './support/txn_name_manager'
 require_relative './support/utils'
 require_relative './support/x_trace_options'
+require_relative './support/support_report'
 
 if SolarWindsAPM::Config[:tag_sql]
   if defined?(::Rails)

data/lib/solarwinds_apm/version.rb

@@ -12,7 +12,7 @@ module SolarWindsAPM
     MAJOR  = 6 # breaking,
     MINOR  = 0 # feature,
     PATCH  = 0 # fix => BFF
-    PRE    = 'prev6'.freeze
+    PRE    = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

data/lib/solarwinds_apm.rb

@@ -5,69 +5,89 @@
 # 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.
 
 begin
+  require 'solarwinds_apm/logger'
+  require 'solarwinds_apm/version'
+  require 'solarwinds_apm/noop'
+  require 'opentelemetry-api'
   if ENV.fetch('SW_APM_ENABLED', 'true') == 'false'
-    SolarWindsAPM.logger.warn 'SW_APM_ENABLED environment variable detected and was set to false; SolarWindsAPM disabled'
+    SolarWindsAPM.logger.info '==================================================================='
+    SolarWindsAPM.logger.info 'SW_APM_ENABLED environment variable detected and was set to false. SolarWindsAPM disabled'
+    SolarWindsAPM.logger.info '==================================================================='
     return
   end
 
-  require 'solarwinds_apm/version'
-  require 'solarwinds_apm/thread_local'
-  require 'solarwinds_apm/support_report'
-  require 'solarwinds_apm/constants'
-  require 'solarwinds_apm/api'
-  require 'solarwinds_apm/base'
-  require 'solarwinds_apm/logger'
-  require 'solarwinds_apm/config'
-
-  SolarWindsAPM::Config.load_config_file
-  SolarWindsAPM.loaded = false
   begin
     if /linux/.match?(RUBY_PLATFORM)
-      require_relative './libsolarwinds_apm.so'
-      require 'solarwinds_apm/oboe_init_options'
-      require_relative './oboe_metal'  # initialize Reporter; sets SolarWindsAPM.loaded = true if successful
+      require 'solarwinds_apm/config'
+      SolarWindsAPM::Config.load_config_file
+
+      require 'solarwinds_apm/oboe_init_options'      # setup oboe reporter options
+      unless SolarWindsAPM::OboeInitOptions.instance.service_key_ok?
+        SolarWindsAPM.logger.warn '=============================================================='
+        SolarWindsAPM.logger.warn 'SW_APM_SERVICE_KEY Error. SolarWinds APM disabled'
+        SolarWindsAPM.logger.warn 'Please check previous log messages for more details.'
+        SolarWindsAPM.logger.warn '=============================================================='
+        return
+      end
+
+      require_relative './libsolarwinds_apm.so'       # load c-lib oboe
+      require_relative './oboe_metal'                 # initialize reporter: SolarWindsAPM.loaded = true
+
+      require 'opentelemetry/sdk/version'                 # load otel sdk version
+      require 'opentelemetry/instrumentation/all/version' # load otel instrumentation
+
+      SolarWindsAPM.logger.info '==================================================================='
+      SolarWindsAPM.logger.info "Ruby #{RUBY_VERSION} on platform #{RUBY_PLATFORM}."
+      SolarWindsAPM.logger.info "Current solarwinds_apm version: #{SolarWindsAPM::Version::STRING}."
+      SolarWindsAPM.logger.info "OpenTelemetry version: #{OpenTelemetry::SDK::VERSION}."
+      SolarWindsAPM.logger.info "OpenTelemetry instrumentation version: #{OpenTelemetry::Instrumentation::All::VERSION}."
+      SolarWindsAPM.logger.info '==================================================================='
+
+      SolarWindsAPM::Reporter.start                 # start the reporter, any issue will be logged
+
+      if SolarWindsAPM.loaded
+        require 'solarwinds_apm/constants'
+        require 'solarwinds_apm/api'
+        require 'solarwinds_apm/support'
+        require 'solarwinds_apm/opentelemetry'
+        require 'solarwinds_apm/patch'
+        require 'solarwinds_apm/otel_config'
+        
+        if ENV['SW_APM_AUTO_CONFIGURE'] != 'false'
+          SolarWindsAPM::OTelConfig.initialize
+        elsif ENV['SW_APM_AUTO_CONFIGURE'] == 'false'
+          SolarWindsAPM.logger.warn '=============================================================='
+          SolarWindsAPM.logger.warn 'SW_APM_AUTO_CONFIGURE set to false.'
+          SolarWindsAPM.logger.warn 'You need to initialize Ruby library in application with'
+          SolarWindsAPM.logger.warn 'SolarWindsAPM::OTelConfig.initialize_with_config do |config|'
+          SolarWindsAPM.logger.warn '  # ... your configuration code'
+          SolarWindsAPM.logger.warn 'end'
+          SolarWindsAPM.logger.warn 'See: https://github.com/solarwinds/apm-ruby/blob/main/CONFIGURATION.md#in-code-configuration'
+          SolarWindsAPM.logger.warn "\e[1mPlease discard this message if application have already taken this action.\e[0m"
+          SolarWindsAPM.logger.warn '=============================================================='
+        end
+      else
+        SolarWindsAPM.logger.warn '=============================================================='
+        SolarWindsAPM.logger.warn 'SolarWindsAPM not loaded. SolarWinds APM disabled'
+        SolarWindsAPM.logger.warn 'Please check previous log messages.'
+        SolarWindsAPM.logger.warn '=============================================================='
+      end
     else
       SolarWindsAPM.logger.warn '==================================================================='
-      SolarWindsAPM.logger.warn "SolarWindsAPM warning: Platform #{RUBY_PLATFORM} not yet supported."
+      SolarWindsAPM.logger.warn "SolarWindsAPM warning: Platform #{RUBY_PLATFORM} not yet supported on current solarwinds_apm #{SolarWindsAPM::Version::STRING}"
       SolarWindsAPM.logger.warn 'see: https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent'
-      SolarWindsAPM.logger.warn 'Tracing disabled.'
+      SolarWindsAPM.logger.warn 'SolarWinds APM disabled.'
       SolarWindsAPM.logger.warn 'Contact technicalsupport@solarwinds.com if this is unexpected.'
       SolarWindsAPM.logger.warn '==================================================================='
     end
   rescue LoadError => e
-    unless ENV['RAILS_GROUP'] == 'assets' || ENV['SW_APM_NO_LIBRARIES_WARNING']
-      SolarWindsAPM.logger.error '=============================================================='
-      SolarWindsAPM.logger.error 'Missing SolarWindsAPM libraries.  Tracing disabled.'
-      SolarWindsAPM.logger.error "Error: #{e.message}"
-      SolarWindsAPM.logger.error 'See: https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent'
-      SolarWindsAPM.logger.error '=============================================================='
-    end
-  end
-
-  if SolarWindsAPM.loaded
-    require 'solarwinds_apm/support'
-    require 'solarwinds_apm/opentelemetry'
-    require 'solarwinds_apm/otel_config'
-    if ENV['SW_APM_AUTO_CONFIGURE'] == 'false'
-      SolarWindsAPM.logger.warn "SolarWindsAPM warning: Ruby library is not initilaized.
-                                  You may need to initialize Ruby library in application like the following:
-                                  SolarWindsAPM::OTelConfig.initialize_with_config do |config|
-                                    ...
-                                  end"
-    else
-      SolarWindsAPM::OTelConfig.initialize
-    end
-
-    SolarWindsAPM::Reporter.start
-  else
-    SolarWindsAPM.logger.warn '=============================================================='
-    SolarWindsAPM.logger.warn 'SolarWindsAPM not loaded. Tracing disabled.'
-    SolarWindsAPM.logger.warn 'There may be a problem with the service key or other settings.'
-    SolarWindsAPM.logger.warn 'Please check previous log messages.'
-    SolarWindsAPM.logger.warn '=============================================================='
-    require 'solarwinds_apm/noop/context'
-    require 'solarwinds_apm/noop/metadata'
+    SolarWindsAPM.logger.error '=============================================================='
+    SolarWindsAPM.logger.error 'Error occurs while loading solarwinds_apm. SolarWinds APM disabled.'
+    SolarWindsAPM.logger.error "Error: #{e.message}"
+    SolarWindsAPM.logger.error 'See: https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent'
+    SolarWindsAPM.logger.error '=============================================================='
   end
+  
 rescue StandardError => e
   $stderr.puts "[solarwinds_apm/error] Problem loading: #{e.inspect}"
   $stderr.puts e.backtrace

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 6.0.0.prev6
+  version: 6.0.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-30 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-sdk
@@ -102,14 +102,16 @@ files:
 - lib/solarwinds_apm/api/opentelemetry.rb
 - lib/solarwinds_apm/api/tracing.rb
 - lib/solarwinds_apm/api/transaction_name.rb
-- lib/solarwinds_apm/base.rb
 - lib/solarwinds_apm/cert/star.appoptics.com.issuer.crt
 - lib/solarwinds_apm/config.rb
 - lib/solarwinds_apm/constants.rb
 - lib/solarwinds_apm/logger.rb
+- lib/solarwinds_apm/noop.rb
 - lib/solarwinds_apm/noop/README.md
+- lib/solarwinds_apm/noop/api.rb
 - lib/solarwinds_apm/noop/context.rb
 - lib/solarwinds_apm/noop/metadata.rb
+- lib/solarwinds_apm/noop/span.rb
 - lib/solarwinds_apm/oboe_init_options.rb
 - lib/solarwinds_apm/opentelemetry.rb
 - lib/solarwinds_apm/opentelemetry/solarwinds_exporter.rb
@@ -118,11 +120,15 @@ files:
 - lib/solarwinds_apm/opentelemetry/solarwinds_response_propagator.rb
 - lib/solarwinds_apm/opentelemetry/solarwinds_sampler.rb
 - lib/solarwinds_apm/otel_config.rb
+- lib/solarwinds_apm/patch.rb
+- lib/solarwinds_apm/patch/dummy_patch.rb
 - lib/solarwinds_apm/support.rb
 - lib/solarwinds_apm/support/logger_formatter.rb
 - lib/solarwinds_apm/support/logging_log_event.rb
 - lib/solarwinds_apm/support/lumberjack_formatter.rb
 - lib/solarwinds_apm/support/oboe_tracing_mode.rb
+- lib/solarwinds_apm/support/service_key_checker.rb
+- lib/solarwinds_apm/support/support_report.rb
 - lib/solarwinds_apm/support/swomarginalia/LICENSE
 - lib/solarwinds_apm/support/swomarginalia/README.md
 - lib/solarwinds_apm/support/swomarginalia/comment.rb
@@ -134,8 +140,6 @@ files:
 - 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
 - lib/solarwinds_apm/version.rb
 homepage: https://documentation.solarwinds.com/en/success_center/observability/content/intro/landing-page.html
 licenses:
@@ -157,9 +161,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.26
 signing_key: