solarwinds_apm 6.1.0 → 6.1.2

data/lib/solarwinds_apm/support/swomarginalia/comment.rb

@@ -1,206 +0,0 @@
-# frozen_string_literal: true
-
-require 'socket'
-require 'opentelemetry-api'
-
-module SolarWindsAPM
-  module SWOMarginalia
-    module Comment
-      mattr_accessor :components, :lines_to_ignore, :prepend_comment
-      SWOMarginalia::Comment.components ||= [:traceparent]
-      # To add new components:
-      # Create file and load after loading solarwinds_apm, and add following:
-      # SolarWindsAPM::SWOMarginalia::Comment.component = [:user_defined]
-
-      def self.update!(controller = nil)
-        self.marginalia_controller = controller
-      end
-
-      def self.update_job!(job)
-        self.marginalia_job = job
-      end
-
-      def self.update_adapter!(adapter)
-        self.marginalia_adapter = adapter
-      end
-
-      def self.construct_comment
-        ret = +''
-        components.each do |c|
-          component_value = send(c)
-          ret << "#{c}='#{component_value}'," if component_value.present?
-        end
-        ret.chop!
-        escape_sql_comment(ret)
-      end
-
-      def self.construct_inline_comment
-        return nil if inline_annotations.none?
-
-        escape_sql_comment(inline_annotations.join)
-      end
-
-      def self.escape_sql_comment(str)
-        str = str.gsub('/*', '').gsub('*/', '') while str.include?('/*') || str.include?('*/')
-        str
-      end
-
-      def self.clear!
-        self.marginalia_controller = nil
-      end
-
-      def self.clear_job!
-        self.marginalia_job = nil
-      end
-
-      def self.marginalia_controller=(controller)
-        Thread.current[:marginalia_controller] = controller
-      end
-
-      def self.marginalia_controller
-        Thread.current[:marginalia_controller]
-      end
-
-      def self.marginalia_job=(job)
-        Thread.current[:marginalia_job] = job
-      end
-
-      def self.marginalia_job
-        Thread.current[:marginalia_job]
-      end
-
-      def self.marginalia_adapter=(adapter)
-        Thread.current[:marginalia_adapter] = adapter
-      end
-
-      def self.marginalia_adapter
-        Thread.current[:marginalia_adapter]
-      end
-
-      def self.application
-        SWOMarginalia.application_name ||= if defined?(::Rails.application)
-                                             ::Rails.application.class.name.split('::').first
-                                           else
-                                             'rails'
-                                           end
-
-        SWOMarginalia.application_name
-      end
-
-      def self.job
-        marginalia_job&.class&.name
-      end
-
-      def self.controller
-        marginalia_controller.controller_name if marginalia_controller.respond_to? :controller_name
-      end
-
-      def self.controller_with_namespace
-        marginalia_controller&.class&.name
-      end
-
-      def self.action
-        marginalia_controller.action_name if marginalia_controller.respond_to? :action_name
-      end
-
-      def self.sidekiq_job
-        marginalia_job['class'] if marginalia_job.respond_to?(:[])
-      end
-
-      DEFAULT_LINES_TO_IGNORE_REGEX = %r{\.rvm|/ruby/gems/|vendor/|marginalia|rbenv|monitor\.rb.*mon_synchronize}
-
-      def self.line
-        SWOMarginalia::Comment.lines_to_ignore ||= DEFAULT_LINES_TO_IGNORE_REGEX
-
-        last_line = caller.detect do |line|
-          line !~ SWOMarginalia::Comment.lines_to_ignore
-        end
-        return unless last_line
-
-        root = if defined?(Rails) && Rails.respond_to?(:root)
-                 Rails.root.to_s
-               elsif defined?(RAILS_ROOT)
-                 RAILS_ROOT
-               else
-                 ''
-               end
-        last_line = last_line[root.length..] if last_line.start_with? root
-        last_line
-      end
-
-      def self.hostname
-        @hostname ||= Socket.gethostname
-      end
-
-      def self.pid
-        Process.pid
-      end
-
-      def self.request_id
-        return unless marginalia_controller.respond_to?(:request) && marginalia_controller.request.respond_to?(:uuid)
-
-        marginalia_controller.request.uuid
-      end
-
-      def self.socket
-        return unless connection_config.present?
-
-        connection_config[:socket]
-      end
-
-      def self.db_host
-        return unless connection_config.present?
-
-        connection_config[:host]
-      end
-
-      def self.database
-        return unless connection_config.present?
-
-        connection_config[:database]
-      end
-
-      ##
-      # Insert trace string as traceparent to sql statement
-      # Not insert if:
-      #   there is no valid current trace context
-      #   current trace context is not sampled
-      #
-      def self.traceparent
-        span_context = ::OpenTelemetry::Trace.current_span.context
-        return '' if span_context == ::OpenTelemetry::Trace::SpanContext::INVALID
-
-        trace_flag = span_context.trace_flags.sampled? ? '01' : '00'
-        return '' if trace_flag == '00'
-
-        format(
-          '00-%<trace_id>s-%<span_id>s-%<trace_flags>.2d',
-          trace_id: span_context.hex_trace_id,
-          span_id: span_context.hex_span_id,
-          trace_flags: trace_flag
-        )
-      rescue NameError => e
-        SolarWindsAPM.logger.error { "[#{name}/#{__method__}] Couldn't find OpenTelemetry. Error: #{e.message}" }
-      end
-
-      if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('6.1')
-        def self.connection_config
-          return if marginalia_adapter.pool.nil?
-
-          marginalia_adapter.pool.spec.config
-        end
-      else
-        def self.connection_config
-          # `pool` might be a NullPool which has no db_config
-          return unless marginalia_adapter.pool.respond_to?(:db_config)
-
-          marginalia_adapter.pool.db_config.configuration_hash
-        end
-      end
-
-      def self.inline_annotations
-        Thread.current[:marginalia_inline_annotations] ||= []
-      end
-    end
-  end
-end

data/lib/solarwinds_apm/support/swomarginalia/formatter.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module SolarWindsAPM
-  module SWOMarginalia
-    module Formatter
-      def tag_content
-        comment = super
-        comment.tr!(':', '=')
-        comment
-      end
-    end
-  end
-end
-
-# Prepend the Formatter module to the singleton class of ActiveRecord::QueryLogs
-if defined?(ActiveRecord::QueryLogs)
-  class << ActiveRecord::QueryLogs
-    prepend SolarWindsAPM::SWOMarginalia::Formatter
-  end
-end

data/lib/solarwinds_apm/support/swomarginalia/load_swomarginalia.rb

@@ -1,55 +0,0 @@
-# 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 'swomarginalia'
-
-module SolarWindsAPM
-  module SWOMarginalia
-    module LoadSWOMarginalia
-      def self.insert
-        insert_into_active_record
-        insert_into_action_controller
-        insert_into_active_job
-      end
-
-      def self.insert_into_active_job
-        return unless defined? ::ActiveJob::Base
-
-        ::ActiveJob::Base.class_eval do
-          around_perform do |job, block|
-            SWOMarginalia::Comment.update_job! job
-            block.call
-          ensure
-            SWOMarginalia::Comment.clear_job!
-          end
-        end
-      end
-
-      def self.insert_into_action_controller
-        return unless defined? ::ActionController::Base
-
-        ::ActionController::Base.include SWOMarginalia::ActionControllerInstrumentation
-
-        return unless defined? ::ActionController::API
-
-        ::ActionController::API.include SWOMarginalia::ActionControllerInstrumentation
-      end
-
-      def self.insert_into_active_record
-        ActiveRecord::ConnectionAdapters::Mysql2Adapter.prepend(SWOMarginalia::ActiveRecordInstrumentation) if defined? ActiveRecord::ConnectionAdapters::Mysql2Adapter
-        ActiveRecord::ConnectionAdapters::MysqlAdapter.prepend(SWOMarginalia::ActiveRecordInstrumentation) if defined? ActiveRecord::ConnectionAdapters::MysqlAdapter
-        ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(SWOMarginalia::ActiveRecordInstrumentation) if defined? ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
-        return unless defined? ActiveRecord::ConnectionAdapters::SQLite3Adapter
-
-        return unless defined? ActiveRecord::ConnectionAdapters::SQLite3Adapter
-
-        ActiveRecord::ConnectionAdapters::SQLite3Adapter.prepend(SWOMarginalia::ActiveRecordInstrumentation)
-      end
-    end
-  end
-end

data/lib/solarwinds_apm/support/swomarginalia/railtie.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails/railtie'
-require_relative 'load_swomarginalia'
-
-module SolarWindsAPM
-  module SWOMarginalia
-    class Railtie < Rails::Railtie
-      initializer 'swomarginalia.insert' do
-        ActiveSupport.on_load :active_record do
-          ::SolarWindsAPM::SWOMarginalia::LoadSWOMarginalia.insert_into_active_record
-        end
-
-        ActiveSupport.on_load :action_controller do
-          ::SolarWindsAPM::SWOMarginalia::LoadSWOMarginalia.insert_into_action_controller
-        end
-
-        ActiveSupport.on_load :active_job do
-          ::SolarWindsAPM::SWOMarginalia::LoadSWOMarginalia.insert_into_active_job
-        end
-      end
-    end
-  end
-end

data/lib/solarwinds_apm/support/swomarginalia/swomarginalia.rb

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'comment'
-
-module SolarWindsAPM
-  module SWOMarginalia
-    mattr_accessor :application_name
-
-    # This ActiveRecordInstrumentation should only work for activerecord < 7.0 since after rails 7
-    # this module won't be prepend to activerecord
-    module ActiveRecordInstrumentation
-      def execute(sql, *args, **options)
-        super(annotate_sql(sql), *args, **options)
-      end
-
-      # only for postgresql adapter
-      def execute_and_clear(sql, *args, **options)
-        super(annotate_sql(sql), *args, **options)
-      end
-
-      def exec_query(sql, *args, **options)
-        super(annotate_sql(sql), *args, **options)
-      end
-
-      def exec_delete(sql, *args)
-        super(annotate_sql(sql), *args)
-      end
-
-      def exec_update(sql, *args)
-        super(annotate_sql(sql), *args)
-      end
-
-      def annotate_sql(sql)
-        SWOMarginalia::Comment.update_adapter!(self)            # switch to current sql adapter
-        comment = SWOMarginalia::Comment.construct_comment      # comment will include traceparent
-        if comment.present? && !sql.include?(comment)
-          sql = if SWOMarginalia::Comment.prepend_comment
-                  "/*#{comment}*/ #{sql}"
-                else
-                  "#{sql} /*#{comment}*/"
-                end
-        end
-
-        inline_comment = SWOMarginalia::Comment.construct_inline_comment # this is for customized_swo_inline_annotations (user-defined value)
-        if inline_comment.present? && !sql.include?(inline_comment)
-          sql = if SWOMarginalia::Comment.prepend_comment
-                  "/*#{inline_comment}*/ #{sql}"
-                else
-                  "#{sql} /*#{inline_comment}*/"
-                end
-        end
-
-        sql
-      end
-
-      # We don't want to trace framework caches.
-      # Only instrument SQL that directly hits the database.
-      def ignore_payload?(name)
-        %w[SCHEMA EXPLAIN CACHE].include?(name.to_s)
-      end
-    end
-
-    module ActionControllerInstrumentation
-      def self.included(instrumented_class)
-        instrumented_class.class_eval do
-          if respond_to?(:around_action)
-            around_action :record_query_comment
-          else
-            around_filter :record_query_comment
-          end
-        end
-      end
-
-      def record_query_comment
-        SWOMarginalia::Comment.update!(self)
-        yield
-      ensure
-        SWOMarginalia::Comment.clear!
-      end
-    end
-
-    def self.with_annotation(comment, &block)
-      SWOMarginalia::Comment.inline_annotations.push(comment)
-      yield if block.present?
-    ensure
-      SWOMarginalia::Comment.inline_annotations.pop
-    end
-  end
-end