solarwinds_apm 5.1.8 → 6.0.0.preV1

data/lib/solarwinds_apm/support/swomarginalia/LICENSE

@@ -0,0 +1,20 @@
+# 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

@@ -0,0 +1,41 @@
+# swomarginalia 
+
+This folder contains the code that is copied from original [marginalia](https://github.com/basecamp/marginalia)
+
+## File structure
+
+```
+|-- 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
+
+```
+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/solarwindscloud/swotel-ruby/tree/main/lib/solarwinds_apm/support/swomarginalia/LICENSE).

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

@@ -0,0 +1,205 @@
+# 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 swotel-ruby, 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 = String.new
+        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
+        if defined?(::Rails.application)
+          SWOMarginalia.application_name ||= ::Rails.application.class.name.split("::").first
+        else
+          SWOMarginalia.application_name ||= "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}.freeze
+
+      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 {"[#{self.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/load_swomarginalia.rb

@@ -0,0 +1,48 @@
+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|
+            begin
+              SWOMarginalia::Comment.update_job! job
+              block.call
+            ensure
+              SWOMarginalia::Comment.clear_job!
+            end
+          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
+
+        ActiveRecord::ConnectionAdapters::SQLite3Adapter.prepend(SWOMarginalia::ActiveRecordInstrumentation) if defined? ActiveRecord::ConnectionAdapters::SQLite3Adapter
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,22 @@
+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

@@ -0,0 +1,86 @@
+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)
+        super(annotate_sql(sql), *args)
+      end
+
+      def execute_and_clear(sql, *args, &block)
+        super(annotate_sql(sql), *args, &block)
+      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)
+      block.call if block.present?
+    ensure
+      SWOMarginalia::Comment.inline_annotations.pop
+    end
+  end
+end

data/lib/solarwinds_apm/support/transaction_cache.rb

@@ -0,0 +1,24 @@
+module SolarWindsAPM
+  # Simple TransactionCache
+  # TODO: improve cache to have lru mechanism that avoid too many values
+  module TransactionCache
+    def self.initialize
+      @cache = {}
+    end
+
+    def self.get(key)
+      @cache[key]
+    end
+
+    def self.del(key)
+      @cache.delete(key)
+    end
+
+    def self.set(key, value)
+      @cache[key] = value
+      SolarWindsAPM.logger.debug {"[#{self.class}/#{__method__}] current TransactionCache #{@cache.inspect}"}
+    end
+  end
+end
+
+SolarWindsAPM::TransactionCache.initialize