solarwinds_apm 6.0.0.preV5 → 6.0.0

data/lib/solarwinds_apm.rb

@@ -5,74 +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 RUBY_PLATFORM =~ /linux/
-      require_relative './libsolarwinds_apm.so'
-      require 'solarwinds_apm/oboe_init_options'
-      require_relative './oboe_metal'  # initialize Reporter; sets SolarWindsAPM.loaded = true if successful
+    if /linux/.match?(RUBY_PLATFORM)
+      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
-
-  # Auto-start the Reporter unless we are running Unicorn on Heroku
-  # In that case, we start the reporters after fork
-  unless SolarWindsAPM.forking_webserver?
-    SolarWindsAPM::Reporter.start if SolarWindsAPM.loaded
-  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
-
-  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.preV5
+  version: 6.0.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-06 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:
@@ -145,6 +149,7 @@ metadata:
   documentation_uri: https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent
   homepage_uri: https://documentation.solarwinds.com/en/success_center/observability/content/intro/landing-page.html
   source_code_uri: https://github.com/solarwinds/apm-ruby
+  github_repo: https://github.com/solarwinds/apm-ruby.git
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -156,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: