solarwinds_apm 6.1.0 → 6.1.2

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/rails/generators/solarwinds_apm/templates/solarwinds_apm_initializer.rb

@@ -169,9 +169,5 @@ if defined?(SolarWindsAPM::Config)
   # Example:
   #   SELECT `posts`.* FROM `posts` /*traceparent=00-a448f096d441e167d12ebd32a927c1a5-a29655a47e430119-01*/
   #
-  # This option can add a small overhead for prepared statements since the traceparent value is unique per execution.
-  # This feature uses marginalia, see its caveat and possible workaround
-  # https://github.com/basecamp/marginalia/blob/master/README.md#prepared-statements
-  #
   SolarWindsAPM::Config[:tag_sql] = false
 end

data/lib/solarwinds_apm/api/custom_instrumentation.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# © 2024 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 Tracer
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Helper method to instrument custom method
+        #
+        # `add_tracer` can add a custom span to the specified instance or class method that is already defined.
+        # It requires the custom span name and optionally takes the span kind and additional attributes
+        # in hash format.
+        #
+        # === Argument:
+        #
+        # * +method_name+ - (String) A non-empty string that match the method name that need to be instrumented
+        # * +span_name+ - (String, optional, default = method_name) A non-empty string that define the span name (default to method_name)
+        # * +options+ - (Hash, optional, default = {}) A hash with desired options include attributes and span kind e.g. {attributes: {}, kind: :consumer}
+        #
+        # === Example:
+        #
+        #   class DogfoodsController < ApplicationController
+        #     include SolarWindsAPM::API::Tracer
+        #
+        #     def create
+        #       @dogfood = Dogfood.new(params.permit(:brand, :name))
+        #       @dogfood.save
+        #       custom_method
+        #     end
+        #
+        #     def custom_method
+        #     end
+        #     add_tracer :custom_method, 'custom_name', { attributes: { 'foo' => 'bar' }, kind: :consumer }
+        #
+        #   end
+        #
+        #   class DogfoodsController < ApplicationController
+        #     def create
+        #       @dogfood = Dogfood.new(params.permit(:brand, :name))
+        #       @dogfood.save
+        #       custom_method
+        #     end
+        #
+        #     def self.custom_method
+        #     end
+        #
+        #     class << self
+        #       include SolarWindsAPM::API::Tracer
+        #       add_tracer :custom_method, 'custom_name', { attributes: { 'foo' => 'bar' }, kind: :consumer }
+        #     end
+        #
+        #   end
+        #
+        # === Returns:
+        # * nil
+        #
+        def add_tracer(method_name, span_name = nil, options = {})
+          span_name = name.nil? ? "#{to_s.split(':').last&.tr('>', '')}/#{__method__}" : "#{name}/#{__method__}" if span_name.nil?
+
+          original_method = instance_method(method_name)
+
+          define_method(method_name) do |*args, &block|
+            SolarWindsAPM::API.in_span(span_name, **options) do |_span|
+              original_method.bind_call(self, *args, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solarwinds_apm/api.rb

@@ -11,6 +11,7 @@ require_relative 'api/current_trace_info'
 require_relative 'api/tracing'
 require_relative 'api/opentelemetry'
 require_relative 'api/custom_metrics'
+require_relative 'api/custom_instrumentation'
 
 module SolarWindsAPM
   module API
@@ -19,5 +20,6 @@ module SolarWindsAPM
     extend SolarWindsAPM::API::Tracing
     extend SolarWindsAPM::API::OpenTelemetry
     extend SolarWindsAPM::API::CustomMetrics
+    extend SolarWindsAPM::API::Tracer
   end
 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_dbo_utils.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module SolarWindsAPM
+  module Patch
+    module TagSql
+      module SWODboUtils
+        def self.annotate_span_and_sql(sql)
+          return sql if sql.to_s.empty?
+
+          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
+
+          SolarWindsAPM.logger.debug { "[#{self.class}/#{__method__}] annotated_sql: #{annotated_sql}" }
+          annotated_sql
+        rescue StandardError => e
+          SolarWindsAPM.logger.error { "[#{self.class}/#{__method__}] Failed to annotated sql. Error: #{e.message}" }
+          sql
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# 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 = {})
+          annotated_sql = ::SolarWindsAPM::Patch::TagSql::SWODboUtils.annotate_span_and_sql(sql)
+          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/sw_pg_patch.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright The OpenTelemetry Authors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+module SolarWindsAPM
+  module Patch
+    module TagSql
+      module SWOPgPatch
+        # We target operations covered by the upstream pg instrumentation.
+        # These are all alike in that they will have a SQL
+        # statement as the first parameter, and they are all
+        # non-prepared statement execute.
+        EXEC_ISH_METHODS = %i[
+          exec
+          query
+          sync_exec
+          async_exec
+          exec_params
+          async_exec_params
+          sync_exec_params
+        ].freeze
+
+        EXEC_ISH_METHODS.each do |method|
+          define_method method do |*args|
+            annotated_sql = ::SolarWindsAPM::Patch::TagSql::SWODboUtils.annotate_span_and_sql(args[0])
+            args[0] = annotated_sql
+            super(*args)
+          end
+        end
+      end
+    end
+  end
+end
+
+# need to prepend before pg instrumentation patch itself
+# upstream instrumentation -> our patch -> original function
+PG::Connection.prepend(SolarWindsAPM::Patch::TagSql::SWOPgPatch) if defined?(PG::Connection)

data/lib/solarwinds_apm/patch/tag_sql_patch.rb

@@ -0,0 +1,11 @@
+# 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_dbo_utils'
+require_relative 'tag_sql/sw_mysql2_patch'
+require_relative 'tag_sql/sw_pg_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  = 2 # fix => BFF
     PRE    = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: solarwinds_apm
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.2
 platform: ruby
 authors:
 - Maia Engeli
 - Peter Giacomo Lombardo
 - Spiros Eliopoulos
 - Xuan Cao
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opentelemetry-instrumentation-all
@@ -74,6 +74,7 @@ files:
 - lib/solarwinds_apm.rb
 - lib/solarwinds_apm/api.rb
 - lib/solarwinds_apm/api/current_trace_info.rb
+- lib/solarwinds_apm/api/custom_instrumentation.rb
 - lib/solarwinds_apm/api/custom_metrics.rb
 - lib/solarwinds_apm/api/opentelemetry.rb
 - lib/solarwinds_apm/api/tracing.rb
@@ -100,6 +101,10 @@ 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_dbo_utils.rb
+- lib/solarwinds_apm/patch/tag_sql/sw_mysql2_patch.rb
+- lib/solarwinds_apm/patch/tag_sql/sw_pg_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
@@ -107,13 +112,6 @@ files:
 - 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
-- lib/solarwinds_apm/support/swomarginalia/formatter.rb
-- lib/solarwinds_apm/support/swomarginalia/load_swomarginalia.rb
-- lib/solarwinds_apm/support/swomarginalia/railtie.rb
-- lib/solarwinds_apm/support/swomarginalia/swomarginalia.rb
 - lib/solarwinds_apm/support/transaction_cache.rb
 - lib/solarwinds_apm/support/transaction_settings.rb
 - lib/solarwinds_apm/support/txn_name_manager.rb
@@ -129,7 +127,7 @@ metadata:
   homepage_uri: https://documentation.solarwinds.com/en/success_center/observability/content/intro/landing-page.html
   source_code_uri: https://github.com/solarwinds/apm-ruby
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: SolarWindsAPM performance instrumentation gem for Ruby
 test_files: []

data/lib/solarwinds_apm/support/swomarginalia/LICENSE

@@ -1,20 +0,0 @@
-# Copyright (c) 2012 37signals, LLC
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/solarwinds_apm/support/swomarginalia/README.md

@@ -1,46 +0,0 @@
-# swomarginalia
-
-This folder contains the code that is copied from original [marginalia](https://github.com/basecamp/marginalia)
-
-## File structure
-
-```console
-|-- swomarginalia
-|   |-- LICENSE
-|   |-- README.md
-|   |-- comment.rb
-|   |-- railtie.rb
-|   |-- load_swomarginalia.rb
-|   `-- swomarginalia.rb
-```
-
-## Modification
-
-### railitie.rb
-
-1. Moved prepend logic into load_swomarginalia.rb in case that non-rails app using activerecord
-
-### swomarginlia.rb
-
-1. Removed the alias_method to achieve function override; instead, we use prepend.
-2. Added step of cleaning-up previous transparent comments
-
-### comment.rb
-
-1. Added the traceparent comment (trace string constructed based on opentelemetry)
-
-### load_swomarginalia.rb
-
-1. (new file) prepend the ActiveRecordInstrumentation to activerecord adapter
-
-## Example
-
-### Sample output of rails application
-
-```console
-Post Load (1.1ms)  SELECT `posts`.* FROM `posts` /*application=SqlcommenterRailsDemo,controller=posts,action=index,traceparent=00-a448f096d441e167d12ebd32a927c1a5-a29655a47e430119-01*/
-```
-
-## License
-
-This project is licensed under the [MIT License](https://github.com/solarwinds/apm-ruby/blob/main/lib/solarwinds_apm/support/swomarginalia/LICENSE).