solarwinds_apm 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 807b88fafed018cf28ab385ea2cb52667127fc4cbab96aac770b5c1f3ab894a6
-  data.tar.gz: b7ec5c206351c3f6fdc90da61550482d9b9e1d2e82f27c1d1a54408111c3f8db
+  metadata.gz: 3ab7453d8ca9dc042ac880b99dd8cd11d6344e3372bb84b2fab1e6b4fa3d65ab
+  data.tar.gz: '009803a9d3ad0f678824c57dca3031ef3b9f79989c00fecb16946962cb641f1e'
 SHA512:
-  metadata.gz: 637ac2da4665dfe45e8095928ca1d46ac2bfdde1f3574913d232c6978d003158a0d94bdb472a5ed65088c89ab070b2e86079e518a9c60503dcd7c3c8af5059c3
-  data.tar.gz: 41dabb11f5b5e692342620a1936224e5acffe738bf01c0f9ca0ceabbec1a882eda455cdfd1fb9c3469e75300e0ef66227ab8699d369c0daf15eba6ff40b057b2
+  metadata.gz: d80d9759f1050927d249d9ac1264eb6bd5407603cf2fee8c09ce27137c6b39773ea3f7b57dd7e5c428890a9ee27f7ba1cc02d20672bef43cfb0470f04de0b70c
+  data.tar.gz: 664ade107e0f49a1709d0d5b87012ea6766094d469b3942afb10100a63c066735f512bb7d2aafae5925b99f4a305f4d2f2a31101090f3bddeee68e722e6efafd

data/ext/oboe_metal/extconf.rb

@@ -18,20 +18,17 @@ CONFIG['warnflags'] = CONFIG['warnflags'].gsub('-Wdeclaration-after-statement',
 init_mkmf(CONFIG)
 
 ext_dir = __dir__
-oboe_debug = ENV['OBOE_DEBUG'].to_s.casecmp('true').zero?
-non_production = ENV['OBOE_DEV'].to_s.casecmp('true').zero? || ENV['OBOE_STAGING'].to_s.casecmp('true').zero?
+oboe_env = ENV.fetch('OBOE_ENV', nil)
+non_production = %w[dev stg].include? oboe_env.to_s
 
 swo_lib_dir = File.join(ext_dir, 'lib')
 version     = File.read(File.join(ext_dir, 'src', 'VERSION')).strip
 
-# OBOE_DEBUG has the highest priorities over oboe environment
-if oboe_debug
-  swo_path = File.join('https://agent-binaries.cloud.solarwinds.com/apm/c-lib/', version, 'relwithdebinfo')
-  puts 'Fetching c-lib from PRODUCTION DEBUG Build'
-elsif ENV['OBOE_DEV'].to_s.casecmp('true').zero?
+case oboe_env
+when 'dev'
   swo_path = 'https://solarwinds-apm-staging.s3.us-west-2.amazonaws.com/apm/c-lib/nightly'
   puts 'Fetching c-lib from DEVELOPMENT Build'
-elsif ENV['OBOE_STAGING'].to_s.casecmp('true').zero?
+when 'stg'
   swo_path = File.join('https://agent-binaries.global.st-ssp.solarwinds.com/apm/c-lib/', version)
   puts 'Fetching c-lib from STAGING Build'
 else
@@ -39,6 +36,15 @@ else
   puts 'Fetching c-lib from PRODUCTION Build'
 end
 
+oboe_debug = ENV['OBOE_DEBUG'].to_s.casecmp('true').zero?
+
+if oboe_debug
+  swo_path = File.join(swo_path, 'relwithdebinfo')
+  puts "Fetching DEBUG Build based on #{oboe_env.to_s.empty? ? 'prod' : oboe_env}"
+end
+
+puts "final swo_path: #{swo_path}"
+
 swo_arch = 'x86_64'
 system_arch = `uname -m` # for mac, the command is `uname` # "Darwin\n"; try `uname -a`
 system_arch.delete!("\n")
@@ -120,7 +126,7 @@ if success
   dir_config('oboe', 'src', 'lib')
 
   # create Makefile
-  if have_library('oboe', 'oboe_config_get_revision', 'oboe.h')
+  if have_library('oboe')
     $libs = append_library($libs, 'oboe')
     $libs = append_library($libs, 'stdc++')
 

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

@@ -1 +1 @@
-61538e93d28a320f25615c04330c61c9b85fb61832d0be570b35ac75ce3cb05c
+53295ec020a713c5f6fe7c14b150a10ac7db0e5ea692fbd6945ee69f7a581271

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

@@ -1 +1 @@
-84dadb40257d98b3f1a1bf79aec922bd41f35119538ddf128546048738ae7729
+37407ece6aafcb662fbce8eb23f98a9b017154c66c8ec02eda835702ba14f446

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

@@ -1 +1 @@
-50ef136fd07dda69b9fed1c7fd61e364aae23402c814b56e03775f32525af348
+925d65c2a940a82315525ea2e82eb357793f7db8a2a8ec529e7c03e2478bc965

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

@@ -1 +1 @@
-38204cae649edff5ac37ea97b5991ed06ed6dca47201745ac261be9f15386dbc
+3d49133827a0b6839744231e3ca49f8c9340380063286b8c3794bde585370001

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

@@ -1 +1 @@
-65808108b17f1b883d8fbbcd48eb04c5682b67b5ec04c04c5642f29664aa29af
+e2198827ce86309a59def33be14f17d0474477df33a5d75bd415d73a01c790b3

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

@@ -1 +1 @@
-337fb9e998fd2f802b6d8305a45a7d0c6248da621d2607ddf2d0b4254d5a6fde
+798a7c9551c66af743e1d6d2b736bf5667fa97fdc0ac8eec825fe4f63adaa044

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-15.0.2
+15.0.3

data/ext/oboe_metal/src/oboe.h

@@ -161,7 +161,7 @@ typedef struct oboe_metric_tag {
 } oboe_metric_tag_t;
 
 typedef struct oboe_init_options {
-    int version;                            // the version of this structure (currently on version 16)
+    int version;                            // the version of this structure (currently on version 17)
     const char *hostname_alias;             // optional hostname alias
     int log_level;                          // level at which log messages will be written to log file (0-6)
                                             // use OBOE_INIT_LOG_LEVEL_INFO(3) for default log level
@@ -188,6 +188,7 @@ typedef struct oboe_init_options {
                                             // only used in lambda reporter (off=0, on=1, default off)
     int metric_format;                      // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
     int log_type;                           // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+    int defer_init;                           // defer init (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
 } oboe_init_options_t;
 
 typedef struct oboe_span_params {

data/ext/oboe_metal/src/oboe_api.cpp

@@ -587,11 +587,12 @@ Reporter::Reporter(
     int stdout_clear_nonblocking,   // flag indicating if the O_NONBLOCK flag on stdout should be cleared,
                                     // only used in lambda reporter (off=0, on=1, default off)
     int metric_format,              // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
-    int log_type                    // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+    int log_type,                   // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+    int defer_init                  // defer init (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
 ) {
     oboe_init_options_t options;
     memset(&options, 0, sizeof(options));
-    options.version = 16;
+    options.version = 17;
     oboe_init_options_set_defaults(&options);
 
     if (hostname_alias != "") {
@@ -628,6 +629,7 @@ Reporter::Reporter(
     options.stdout_clear_nonblocking = stdout_clear_nonblocking;
     options.metric_format = metric_format;
     options.log_type = log_type;
+    options.defer_init = defer_init;
     init_status = oboe_init(&options);
 }
 
@@ -694,7 +696,7 @@ std::string Config::getVersionString() {
 OboeAPI::OboeAPI(const OboeAPIOptions& options) {
     oboe_init_options_t oboe_options;
     memset(&oboe_options, 0, sizeof(oboe_options));
-    oboe_options.version = 16;
+    oboe_options.version = 17;
     oboe_init_options_set_defaults(&oboe_options);
     oboe_options.log_level = options.logging_options.level;
     oboe_options.log_type = options.logging_options.type;

data/ext/oboe_metal/src/oboe_api.h

@@ -463,7 +463,8 @@ class Reporter : private oboe_reporter_t {
         int stdout_clear_nonblocking,   // flag indicating if the O_NONBLOCK flag on stdout should be cleared,
                                         // only used in lambda reporter (off=0, on=1, default off)
         int metric_format,              // flag indicating the format of metric (0 = Both; 1 = TransactionResponseTime only; 2 = ResponseTime only; default = 0)
-        int log_type                    // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+        int log_type,                   // log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
+        int defer_init                  // defer init (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
     );
 
     ~Reporter();

data/ext/oboe_metal/src/oboe_swig_wrap.cc

@@ -6870,6 +6870,7 @@ _wrap_new_Reporter(int argc, VALUE *argv, VALUE self) {
   int arg20 ;
   int arg21 ;
   int arg22 ;
+  int arg23 ;
   int val2 ;
   int ecode2 = 0 ;
   int val4 ;
@@ -6900,10 +6901,12 @@ _wrap_new_Reporter(int argc, VALUE *argv, VALUE self) {
   int ecode21 = 0 ;
   int val22 ;
   int ecode22 = 0 ;
+  int val23 ;
+  int ecode23 = 0 ;
   Reporter *result = 0 ;
   
-  if ((argc < 22) || (argc > 22)) {
-    rb_raise(rb_eArgError, "wrong # of arguments(%d for 22)",argc); SWIG_fail;
+  if ((argc < 23) || (argc > 23)) {
+    rb_raise(rb_eArgError, "wrong # of arguments(%d for 23)",argc); SWIG_fail;
   }
   {
     std::string *ptr = (std::string *)0;
@@ -7043,7 +7046,12 @@ _wrap_new_Reporter(int argc, VALUE *argv, VALUE self) {
     SWIG_exception_fail(SWIG_ArgError(ecode22), Ruby_Format_TypeError( "", "int","Reporter", 22, argv[21] ));
   } 
   arg22 = static_cast< int >(val22);
-  result = (Reporter *)new Reporter(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9,arg10,arg11,arg12,arg13,arg14,arg15,arg16,arg17,arg18,arg19,arg20,arg21,arg22);
+  ecode23 = SWIG_AsVal_int(argv[22], &val23);
+  if (!SWIG_IsOK(ecode23)) {
+    SWIG_exception_fail(SWIG_ArgError(ecode23), Ruby_Format_TypeError( "", "int","Reporter", 23, argv[22] ));
+  } 
+  arg23 = static_cast< int >(val23);
+  result = (Reporter *)new Reporter(arg1,arg2,arg3,arg4,arg5,arg6,arg7,arg8,arg9,arg10,arg11,arg12,arg13,arg14,arg15,arg16,arg17,arg18,arg19,arg20,arg21,arg22,arg23);
   DATA_PTR(self) = result;
   return self;
 fail:

data/lib/oboe_metal.rb

@@ -14,9 +14,10 @@ module SolarWindsAPM
   @loaded    = false
   @reporter  = nil
   @oboe_api  = nil
+  @init_sent = false
 
   class << self
-    attr_accessor :reporter, :loaded, :oboe_api
+    attr_accessor :reporter, :loaded, :oboe_api, :init_sent
 
     def sample_rate(rate)
       return unless SolarWindsAPM.loaded
@@ -38,7 +39,7 @@ module SolarWindsAPM
         options = SolarWindsAPM::OboeInitOptions.instance.array_for_oboe # creates an array with the options in the right order
         SolarWindsAPM.reporter = Oboe_metal::Reporter.new(*options)
         SolarWindsAPM.loaded = true
-        report_init
+        report_init if (options[22]).zero? # report init at beginning if no after fork enabled
       rescue StandardError => e
         warn e.message
         SolarWindsAPM.loaded = false
@@ -70,12 +71,15 @@ module SolarWindsAPM
       # 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)
+        # Don't send __Init in test or if SolarWindsAPM isn't fully loaded (e.g. missing c-extension)
+        # or if already sent (e.g. SolarWindsAPM.init_sent = true)
+        return if SolarWindsAPM.init_sent
         return unless SolarWindsAPM.loaded
 
         platform_info = build_swo_init_report
         log_init(layer, platform_info)
+
+        SolarWindsAPM.init_sent = true
         SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] Init message has been sent." }
       end
 

data/lib/solarwinds_apm/oboe_init_options.rb

@@ -67,6 +67,8 @@ module SolarWindsAPM
       @metric_format = determine_the_metric_model
       # log type (0 = stderr; 1 = stdout; 2 = file; 3 = null; 4 = disabled; default = 0)
       @log_type = determine_oboe_log_type
+      # after fork enablement (0 = disable; 1 = enabled, parent process will not init oboe but fork child process will init oboe; default = 0)
+      @after_fork = determine_oboe_after_fork
     end
 
     # for testing with changed ENV vars
@@ -97,7 +99,8 @@ module SolarWindsAPM
         @grpc_proxy,             # 18
         0,                       # 19 arg for lambda (no lambda for ruby yet)
         @metric_format,          # 20
-        @log_type                # 21
+        @log_type,               # 21
+        @after_fork              # 22
       ]
     end
 
@@ -176,8 +179,14 @@ module SolarWindsAPM
       (allowed_uri.include? ENV.fetch('SW_APM_COLLECTOR', nil))
     end
 
+    def java_collector?(uri)
+      java_collector_regex = /java-collector:\d+/
+      uri.match?(java_collector_regex)
+    end
+
     def sanitize_collector_uri(uri)
       return uri if uri.nil? || uri.empty?
+      return uri if java_collector?(uri)
 
       begin
         sanitized_uri = ::URI.parse("http://#{uri}").host
@@ -205,5 +214,9 @@ module SolarWindsAPM
         true
       end
     end
+
+    def determine_oboe_after_fork
+      ENV['SW_APM_ENABLE_AFTER_FORK'].to_s == 'true' ? 1 : 0
+    end
   end
 end

data/lib/solarwinds_apm/opentelemetry/solarwinds_processor.rb

@@ -30,7 +30,7 @@ module SolarWindsAPM
       #  started span.
       def on_start(span, parent_context)
         SolarWindsAPM.logger.debug do
-          "[#{self.class}/#{__method__}] processor on_start span: #{span.inspect}, parent_context: #{parent_context.inspect}"
+          "[#{self.class}/#{__method__}] processor on_start span: #{span.to_span_data.inspect}, parent_context: #{parent_context.inspect}"
         end
 
         return if non_entry_span(parent_context: parent_context)
@@ -47,7 +47,7 @@ module SolarWindsAPM
       #
       # @param [Span] span the {Span} that just ended.
       def on_finish(span)
-        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] processor on_finish span: #{span.inspect}" }
+        SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] processor on_finish span: #{span.to_span_data.inspect}" }
 
         return if non_entry_span(span: span)
 

data/lib/solarwinds_apm/opentelemetry/solarwinds_response_propagator.rb

@@ -35,9 +35,10 @@ module SolarWindsAPM
         def inject(carrier, context: ::OpenTelemetry::Context.current,
                    setter: ::OpenTelemetry::Context::Propagation.text_map_setter)
           span_context = ::OpenTelemetry::Trace.current_span(context).context
-          SolarWindsAPM.logger.debug do
-            "[#{self.class}/#{__method__}] context: #{context.inspect}; span_context: #{span_context.inspect}"
-          end
+
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] context current_span: #{context.instance_variable_get(:@entries)&.values&.first.inspect}" }
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] span_context: #{span_context.inspect}" }
+
           return unless span_context&.valid?
 
           x_trace                = Utils.traceparent_from_context(span_context)

data/lib/solarwinds_apm/opentelemetry/solarwinds_sampler.rb

@@ -55,6 +55,8 @@ module SolarWindsAPM
                                         attributes: #{attributes}"
         end
 
+        SolarWindsAPM::Reporter.send(:report_init) # This only happens if after_fork enabled
+
         parent_span_context = ::OpenTelemetry::Trace.current_span(parent_context).context
         xtraceoptions       = ::SolarWindsAPM::XTraceOptions.new(parent_context)
         SolarWindsAPM.logger.debug do

data/lib/solarwinds_apm/otel_config.rb

@@ -111,6 +111,9 @@ module SolarWindsAPM
         ENV['OTEL_LOG_LEVEL'] = SolarWindsAPM::Config::SW_LOG_LEVEL_MAPPING.dig(log_level, :otel)
       end
 
+      # for dbo, traceparent injection as comments
+      require_relative 'patch/tag_sql_patch' if SolarWindsAPM::Config[:tag_sql]
+
       ::OpenTelemetry::SDK.configure { |c| c.use_all(@@config_map) }
 
       validate_propagator(::OpenTelemetry.propagation.instance_variable_get(:@propagators))
@@ -126,6 +129,13 @@ module SolarWindsAPM
 
       # configure sampler afterwards
       ::OpenTelemetry.tracer_provider.sampler = @@config[:sampler]
+
+      if ENV['SW_APM_AUTO_CONFIGURE'] == 'false'
+        SolarWindsAPM.logger.info '==================================================================='
+        SolarWindsAPM.logger.info "\e[1mSolarWindsAPM manual initialization was successful.\e[0m"
+        SolarWindsAPM.logger.info '==================================================================='
+      end
+
       nil
     end
 

data/lib/solarwinds_apm/patch/tag_sql/sw_mysql2_patch.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+module SolarWindsAPM
+  module Patch
+    module TagSql
+      module SWOMysql2Patch
+        def query(sql, options = {})
+          current_span = ::OpenTelemetry::Trace.current_span
+
+          annotated_sql = ''
+          if current_span.context.trace_flags.sampled?
+            traceparent = SolarWindsAPM::Utils.traceparent_from_context(current_span.context)
+            annotated_traceparent = "/*traceparent='#{traceparent}'*/"
+            current_span.add_attributes({ 'sw.query_tag' => annotated_traceparent })
+            annotated_sql = "#{sql} #{annotated_traceparent}"
+          else
+            annotated_sql = sql
+          end
+
+          super(annotated_sql, options)
+        end
+      end
+    end
+  end
+end
+
+# need to prepend before mysql2 instrumentation prepend the original function
+# after entire process, the call sequence will be:
+# upstream instrumentation -> our patch -> original function
+Mysql2::Client.prepend(SolarWindsAPM::Patch::TagSql::SWOMysql2Patch) if defined?(Mysql2::Client)

data/lib/solarwinds_apm/patch/tag_sql_patch.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# © 2023 SolarWinds Worldwide, LLC. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at:http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+require_relative 'tag_sql/sw_mysql2_patch'

data/lib/solarwinds_apm/support.rb

@@ -18,17 +18,3 @@ 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)
-    if Rails.version < '7'
-      require_relative 'support/swomarginalia/railtie'
-    else
-      require_relative 'support/swomarginalia/comment'
-      require_relative 'support/swomarginalia/formatter' if Rails.version <= '7.1'
-    end
-  elsif defined?(ActiveRecord)
-    require_relative 'support/swomarginalia/load_swomarginalia'
-    SolarWindsAPM::SWOMarginalia::LoadSWOMarginalia.insert
-  end
-end

data/lib/solarwinds_apm/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Maia Engeli
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-all
@@ -100,6 +100,8 @@ files:
 - lib/solarwinds_apm/otel_lambda_config.rb
 - lib/solarwinds_apm/patch.rb
 - lib/solarwinds_apm/patch/dummy_patch.rb
+- lib/solarwinds_apm/patch/tag_sql/sw_mysql2_patch.rb
+- lib/solarwinds_apm/patch/tag_sql_patch.rb
 - lib/solarwinds_apm/support.rb
 - lib/solarwinds_apm/support/logger_formatter.rb
 - lib/solarwinds_apm/support/logging_log_event.rb