solarwinds_apm 5.1.9 → 6.0.0.preV1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e79b789228d9d0885289c825d1ae712bab1d9450334f6b27fd72e19763b436a
-  data.tar.gz: 62ec2e7f017cfa2824d269d7db3a3330d9c5c5555424552f8c289f1401caa60d
+  metadata.gz: 78b2c4b54eaff62c93db5c06ebd9e85f73aea61943fa8eb90f0ba157dc81ab01
+  data.tar.gz: 2133540e0d8ec4ab097cd638d0cfd834649bc4898555ffb9cbfd7fa58a6e2355
 SHA512:
-  metadata.gz: 210f5a2c53d302666b12a3afff04481bf3ea094f509b6275aedf5825cdce721d45dcd5dfd170b2c1ab484ef01c9e5bc098235213a066d0cb860caa99c9fbf00b
-  data.tar.gz: 49280e85e07e7523c67b0bb848d71c9160c01c4861fffcccd526af7be436ca709fb31e9995f5326cf497ceffa1622244fc98ba5bba1c601fcf2e5687a49b7d01
+  metadata.gz: 2731e533815670079641e91865a502157162a4924d4c1c0950b50f3e42d7417619305f51a2db22f12ef45ea9111b826d59bcd091f9201b1375afdb06e940421a
+  data.tar.gz: 6c2053e792310de17c09a58b68e8b74ba100a01c025d703d8cee315b7c3ad7ae6f23da08fe0b5dda2a6328a710330c6ce1468db12703c4d16ce98f1564df5436

data/LICENSE

@@ -1,4 +1,3 @@
-
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

data/ext/oboe_metal/extconf.rb

@@ -6,19 +6,18 @@
 require 'mkmf'
 require 'rbconfig'
 require 'open-uri'
-require 'no_proxy_fix'
 
 CONFIG['warnflags'] = CONFIG['warnflags'].gsub(/-Wdeclaration-after-statement/, '')
-                        .gsub(/-Wimplicit-function-declaration/, '')
-                        .gsub(/-Wimplicit-int/, '')
-                        .gsub(/-Wno-tautological-compare/, '')
-                        .gsub(/-Wno-self-assign/, '')
-                        .gsub(/-Wno-parentheses-equality/, '')
-                        .gsub(/-Wno-constant-logical-operand/, '')
-                        .gsub(/-Wno-cast-function-type/, '')
+                                         .gsub(/-Wimplicit-function-declaration/, '')
+                                         .gsub(/-Wimplicit-int/, '')
+                                         .gsub(/-Wno-tautological-compare/, '')
+                                         .gsub(/-Wno-self-assign/, '')
+                                         .gsub(/-Wno-parentheses-equality/, '')
+                                         .gsub(/-Wno-constant-logical-operand/, '')
+                                         .gsub(/-Wno-cast-function-type/, '')
 init_mkmf(CONFIG)
 
-ext_dir = File.expand_path(File.dirname(__FILE__))
+ext_dir = __dir__
 
 # Set the mkmf lib paths so we have no issues linking to
 # the SolarWindsAPM libs.
@@ -37,13 +36,13 @@ else
   ao_path = File.join('https://agent-binaries.cloud.solarwinds.com/apm/c-lib/', version)
 end
 
-ao_arch = "x86_64"
+ao_arch = 'x86_64'
 system_arch = `uname -m` # for mac, the command is `uname` # "Darwin\n"; try `uname -a`
 case system_arch.gsub("\n","")
-when "x86_64"
-  ao_arch = "x86_64"
-when "aarch64"
-  ao_arch = "aarch64"
+when 'x86_64'
+  ao_arch = 'x86_64'
+when 'aarch64'
+  ao_arch = 'aarch64'
 end
 
 if File.exist?('/etc/alpine-release')
@@ -67,12 +66,9 @@ retries = 3
 success = false
 while retries > 0
   begin
-    download = URI.open(ao_item, 'rb')
-    IO.copy_stream(download, clib)
-
+    IO.copy_stream(URI.parse(ao_item).open, clib)
     clib_checksum = Digest::SHA256.file(clib).hexdigest
-    download.close
-    checksum =  File.read(ao_checksum_file).strip
+    checksum      =  File.read(ao_checksum_file).strip
 
     # unfortunately these messages only show if the install command is run
     # with the `--verbose` flag
@@ -89,7 +85,7 @@ while retries > 0
       success = true
       retries = 0
     end
-  rescue => e
+  rescue StandardError => e
     File.write(clib, '')
     retries -= 1
     if retries == 0
@@ -139,15 +135,15 @@ if success
 
     create_makefile('libsolarwinds_apm', 'src')
   else
-    $stderr.puts   '== ERROR ========================================================='
+    $stderr.puts '== ERROR ========================================================='
     if have_library('oboe')
       $stderr.puts "The c-library either needs to be updated or doesn't match the OS."
       $stderr.puts 'No tracing will occur.'
     else
       $stderr.puts 'Could not find a matching c-library. No tracing will occur.'
     end
-    $stderr.puts   'Contact technicalsupport@solarwinds.com if the problem persists.'
-    $stderr.puts   '=================================================================='
+    $stderr.puts 'Contact technicalsupport@solarwinds.com if the problem persists.'
+    $stderr.puts '=================================================================='
     create_makefile('oboe_noop', 'noop')
   end
 end

data/ext/oboe_metal/lib/liboboe-1.0-aarch64.so.sha256

@@ -1 +1 @@
-5403faf71b2d26bf2a0fd32d159f10b920d5fdafc0aef4b335e5e272d22c1b70
+b931c715d8ddaa9f2b91c72ad708ed3467e6e68ee4255756123b2ca96f1b98d0

data/ext/oboe_metal/lib/liboboe-1.0-alpine-aarch64.so.sha256

@@ -1 +1 @@
-78964dc06204715aa29a8ff47b259984ae476ab72f3d0d983e2ef1c52ef70d6a
+c8189fe6f5b31c15c31d3b005aebcff90f97ff82e92d9e0d3b254bbbe2a7367d

data/ext/oboe_metal/lib/liboboe-1.0-alpine-x86_64.so.sha256

@@ -1 +1 @@
-97c82835d4dbf1130b33a1c75a3c5d9923b1b5c5224e19db9902288c29d128c5
+2824ba630ba794ff6280358922b54e8e1be4ccdb145376f90601e6652d149525

data/ext/oboe_metal/lib/liboboe-1.0-x86_64.so.sha256

@@ -1 +1 @@
-6c04a460825bf130caa83433ad0aa01b56f4c5a4ca891df3ffa516db8dc9486a
+82a003ec82e3703260cdc215ef4c0c0bc7bc916cef27ef509034b60fd5ef9b35

data/ext/oboe_metal/src/VERSION

@@ -1,2 +1,2 @@
-12.3.0
+12.4.0
 

data/ext/oboe_metal/src/oboe_debug.h

@@ -6,6 +6,7 @@ extern "C" {
 #endif
 
 #include <stdbool.h>
+#include <stdio.h>
 
 /**
  * Defined diagnostic log detail levels.

data/lib/oboe_metal.rb

@@ -1,15 +1,13 @@
 # Copyright (c) 2016 SolarWinds, LLC.
 # All rights reserved.
 
-require 'thread'
-
 # Disable docs and Camelcase warns since we're implementing
 # an interface here.  See OboeBase for details.
-# rubocop:disable Style/Documentation, Naming/MethodName
 module SolarWindsAPM
   extend SolarWindsAPMBase
   include Oboe_metal
 
+  # Reporter that send span data to SWO
   class Reporter
     class << self
       ##
@@ -26,13 +24,8 @@ module SolarWindsAPM
 
           SolarWindsAPM.reporter = Oboe_metal::Reporter.new(*options)
 
-          # Only report __Init from here if we are not instrumenting a framework.
-          # Otherwise, frameworks will handle reporting __Init after full initialization
-          unless defined?(::Rails) || defined?(::Sinatra) || defined?(::Padrino) || defined?(::Grape)
-            SolarWindsAPM::API.report_init
-          end
-
-        rescue => e
+          report_init
+        rescue StandardError=> e
           $stderr.puts e.message
           raise
         end
@@ -44,8 +37,8 @@ module SolarWindsAPM
       #
       # Send the report for the given event
       #
-      def sendReport(evt)
-        SolarWindsAPM.reporter.sendReport(evt)
+      def send_report(evt, with_system_timestamp: true)
+        SolarWindsAPM.reporter.sendReport(evt, with_system_timestamp)
       end
 
       ##
@@ -53,8 +46,8 @@ module SolarWindsAPM
       #
       # Send the report for the given event
       #
-      def sendStatus(evt, context = nil)
-        SolarWindsAPM.reporter.sendStatus(evt, context)
+      def send_status(evt, context=nil, with_system_timestamp: true)
+        SolarWindsAPM.reporter.sendStatus(evt, context, with_system_timestamp)
       end
 
       ##
@@ -67,20 +60,11 @@ module SolarWindsAPM
       end
 
       ##
-      # hard_clear_all_traces
-      #
-      # Truncates the trace output file to zero by deleting the original bson file
-      #
-      def hard_clear_all_traces
-        File.delete(SolarWindsAPM::OboeInitOptions.instance.host) if File.exist?(SolarWindsAPM::OboeInitOptions.instance.host)
-      end
-
-      ##
-      # get_all_traces
+      # obtain_all_traces
       #
       # Retrieves all traces written to the trace file
       #
-      def get_all_traces
+      def obtain_all_traces
         io = File.open(SolarWindsAPM::OboeInitOptions.instance.host, 'r')
         contents = io.readlines(nil)
         io.close
@@ -106,68 +90,121 @@ module SolarWindsAPM
           end
         else
           bbb = ::BSON::ByteBuffer.new(contents[0])
-          until bbb.length == 0
-            traces << Hash.from_bson(bbb)
-          end
+          traces << Hash.from_bson(bbb) until bbb.length == 0
         end
 
         traces
       end
-    end
-  end
 
-  module EventUtil
-    def self.metadataString(evt)
-      evt.metadataString
+      private
+      
+      # Internal: Report that instrumentation for the given layer has been
+      # installed, as well as the version of instrumentation and version of
+      # layer.
+      #
+      def report_init(layer=:rack) # :nodoc:
+        # Don't send __Init in test or if SolarWindsAPM
+        # isn't fully loaded (e.g. missing c-extension)
+        return if ENV.has_key?('SW_APM_GEM_TEST') || !SolarWindsAPM.loaded
+
+        platform_info = build_swo_init_report
+        log_init(layer, platform_info)
+      end
+
+      ##
+      # :nodoc:
+      # Internal: Reports agent init to the collector
+      #
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event
+      def log_init(layer=:rack, kvs={})
+        context = SolarWindsAPM::Metadata.makeRandom
+        return SolarWindsAPM::Context.toString unless context.isValid
+
+        event = context.createEvent
+        event.addInfo('Layer', layer.to_s)
+        event.addInfo('Label', 'single')
+        kvs.each do |k, v|
+          event.addInfo(k, v.to_s)
+        end
+
+        SolarWindsAPM::Reporter.send_status(event, context, with_system_timestamp: true)
+        SolarWindsAPM::Context.toString
+      end
+
+      ##
+      #  build_swo_init_report
+      #
+      # Internal: Build a hash of KVs that reports on the status of the
+      # running environment for swo only. This is used on stack boot in __Init reporting
+      # and for SolarWindsAPM.support_report.
+      #
+      def build_swo_init_report
+
+        platform_info = {'__Init' => true}
+
+        begin
+          platform_info['APM.Version']             = SolarWindsAPM::Version::STRING
+          platform_info['APM.Extension.Version']   = extension_lib_version
+          
+          # OTel Resource Attributes (Optional)
+          platform_info['process.executable.path'] = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name']).sub(/.*\s.*/m, '"\&"')
+          platform_info['process.executable.name'] = RbConfig::CONFIG['ruby_install_name']
+          platform_info['process.command_line']    = $PROGRAM_NAME
+          platform_info['process.telemetry.path']  = Gem::Specification.find_by_name('solarwinds_apm')&.full_gem_path
+          platform_info['os.type']                 = RUBY_PLATFORM
+
+          platform_info.merge!(report_gem_in_use)
+
+          # Collect up opentelemetry sdk version (Instrumented Library Versions) (Required)
+          begin
+            require 'opentelemetry/sdk'
+            ::OpenTelemetry::SDK::Resources::Resource.telemetry_sdk.attribute_enumerator.each {|k,v| platform_info[k] = v}
+            ::OpenTelemetry::SDK::Resources::Resource.process.attribute_enumerator.each {|k,v| platform_info[k] = v}
+          rescue StandardError => e
+            SolarWindsAPM.logger.warn {"[#{self.class}/#{__method__}] Fail to extract telemetry attributes. Error: #{e.message}"}
+          end
+        rescue StandardError, ScriptError => e
+          # Also rescue ScriptError (aka SyntaxError) in case one of the expected
+          # version defines don't exist
+
+          platform_info['Error'] = "Error in build_report: #{e.message}"
+
+          SolarWindsAPM.logger.warn {"[#{self.class}/#{__method__}] Error in build_init_report: #{e.message}"}
+          SolarWindsAPM.logger.debug {e.backtrace}
+        end
+        platform_info
+      end
+
+      ##
+      # Collect up the loaded gems
+      ##
+      def report_gem_in_use
+        platform_info = {}
+        if defined?(Gem) && Gem.respond_to?(:loaded_specs)
+          Gem.loaded_specs.each_pair {|k, v| platform_info["Ruby.#{k}.Version"] = v.version.to_s}
+        else
+          platform_info.merge!(legacy_build_init_report)
+        end
+        platform_info
+      end
+
+      ##
+      # get extension library version by looking at the VERSION file
+      # oboe not loaded yet, can't use oboe_api function to read oboe VERSION
+      ##
+      def extension_lib_version
+        gem_location = Gem::Specification.find_by_name('solarwinds_apm')
+        clib_version_file = File.join(gem_location&.gem_dir, 'ext', 'oboe_metal', 'src', 'VERSION')
+        File.read(clib_version_file).strip
+      end
     end
   end
 
   class << self
-    # def sample?(opts = {})
-    #   # Return false if no-op mode
-    #   return false unless SolarWindsAPM.loaded
-    #
-    #   # Assure defaults since SWIG enforces Strings
-    #   xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : SW_APM_STR_BLANK
-    #
-    #   # the first arg has changed to be the service name, blank means to use the default (from the service key)
-    #   rv = SolarWindsAPM::Context.sampleRequest(SW_APM_STR_BLANK, xtrace)
-    #
-    #   if rv == 0
-    #     SolarWindsAPM.sample_rate = -1
-    #     SolarWindsAPM.sample_source = -1
-    #     false
-    #   else
-    #     # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
-    #     # source embedded
-    #     SolarWindsAPM.sample_rate = (rv & SAMPLE_RATE_MASK)
-    #     SolarWindsAPM.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
-    #     true
-    #   end
-    # rescue StandardError => e
-    #   SolarWindsAPM.logger.debug "[oboe/error] sample? error: #{e.inspect}"
-    #   false
-    # end
-
-    # def set_tracing_mode(mode)
-    #   return unless SolarWindsAPM.loaded
-    #
-    #   value = mode.to_sym
-    #
-    #   case value
-    #   when :disabled, :never
-    #     SolarWindsAPM::Context.setTracingMode(SW_APM_TRACE_DISABLED)
-    #
-    #   when :enabled, :always
-    #     SolarWindsAPM::Context.setTracingMode(SW_APM_TRACE_ENABLED)
-    #
-    #   else
-    #     SolarWindsAPM.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
-    #     SolarWindsAPM::Context.setTracingMode(SW_APM_TRACE_DISABLED)
-    #   end
-    # end
-
-    def set_sample_rate(rate)
+    def sample_rate(rate)
       return unless SolarWindsAPM.loaded
 
       # Update liboboe with the new SampleRate value
@@ -175,7 +212,6 @@ module SolarWindsAPM
     end
   end
 end
-# rubocop:enable Style/Documentation
 
 SolarWindsAPM.loaded = true
-SolarWindsAPM.config_lock = Mutex.new
+# rubocop:enable Style/Documentation

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

@@ -2,6 +2,7 @@
 # All rights reserved.
 
 module SolarWindsAPM
+  # InstallGenerator
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.join(File.dirname(__FILE__), 'templates')
     desc "Copies a SolarWindsAPM gem initializer file to your application."
@@ -20,7 +21,6 @@ module SolarWindsAPM
 
     private
 
-    # rubocop:disable Metrics/MethodLength
     def print_header
       say ""
       say shell.set_color "Welcome to the SolarWindsAPM Ruby instrumentation setup.", :green, :bold
@@ -34,7 +34,6 @@ module SolarWindsAPM
       say "More information on instrumenting Ruby applications can be found here:"
       say "https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=config-ruby-agent"
     end
-    # rubocop:enable Metrics/MethodLength
 
     def print_footer
       say ""