stackify-ruby-apm 1.10.4 → 1.14.0

data/lib/stackify_apm/spies/sinatra_activerecord/mysql_adapter.rb

@@ -2,12 +2,15 @@
 
 # Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
 
+require 'stackify_apm/helper/database_helper'
+
 module StackifyRubyAPM
   # @api private
   module Spies
     # @api private
     class MysqlAdapterSpy
       TYPE = 'db.sinatra_active_record.sql'.freeze
+      DEFAULT_PORT = 3306
       if ActiveRecord::VERSION::MAJOR.to_i >= 5
         def install
           ActiveRecord::ConnectionAdapters::MySQL::DatabaseStatements.class_eval do
@@ -22,14 +25,10 @@ module StackifyRubyAPM
                 exec_update_without_apm(sql, name, binds)
               end
 
-              ctx = Span::Context.new(
-                CATEGORY: 'Database',
-                SUBCATEGORY: 'Execute',
-                COMPONENT_CATEGORY: 'DB Query',
-                COMPONENT_DETAIL: 'Execute SQL Query',
-                SQL: sql,
-                PROVIDER: 'mysql'
-              )
+              payload = {sql: sql, binds: binds}
+              statement = query_variables(payload)
+              check_prepared_stmt(statement, payload)
+              ctx = Span::Context.new(statement)
 
               result = exec_update_without_apm(sql, name, binds)
 
@@ -45,14 +44,10 @@ module StackifyRubyAPM
                 exec_delete_without_apm(sql, name, binds)
               end
 
-              ctx = Span::Context.new(
-                CATEGORY: 'Database',
-                SUBCATEGORY: 'Execute',
-                COMPONENT_CATEGORY: 'DB Query',
-                COMPONENT_DETAIL: 'Execute SQL Query',
-                SQL: sql,
-                PROVIDER: 'mysql'
-              )
+              payload = {sql: sql, binds: binds}
+              statement = query_variables(payload)
+              check_prepared_stmt(statement, payload)
+              ctx = Span::Context.new(statement)
 
               result = exec_delete_without_apm(sql, name, binds)
 
@@ -69,22 +64,38 @@ module StackifyRubyAPM
                 exec_query_without_apm(sql, name, binds)
               end
 
-              ctx = Span::Context.new(
-                CATEGORY: 'Database',
-                SUBCATEGORY: 'Execute',
-                COMPONENT_CATEGORY: 'DB Query',
-                COMPONENT_DETAIL: 'Execute SQL Query',
-                SQL: sql,
-                PROVIDER: 'mysql'
-              )
+              payload = {sql: sql, binds: binds}
+              statement = query_variables(payload)
+              check_prepared_stmt(statement, payload)
+              ctx = Span::Context.new(statement)
 
               result = exec_query_without_apm(sql, name, binds)
-
               StackifyRubyAPM.span name, TYPE, context: ctx do
                 return result
               end
             end
             # rubocop:enable Lint/UnusedMethodArgument
+
+            def query_variables(payload)
+              props = get_common_db_properties
+              props[:PROVIDER] = 'mysql'
+              props[:SQL] = payload[:sql]
+              props[:URL] = get_host unless !get_host
+              props
+            end
+
+            def check_prepared_stmt(statement, payload)
+              if StackifyRubyAPM.agent.config.prefix_enabled
+                check_prepared_stmt_by_placeholder(payload[:sql].include?('?'), statement, payload)
+              end
+            end
+
+            def get_host
+              query_options = self.raw_connection.query_options.to_h
+              "#{query_options[:host]}:#{query_options[:port] || DEFAULT_PORT}"
+            rescue StandardError => error
+              nil
+            end
           end
         end
       else
@@ -110,6 +121,7 @@ module StackifyRubyAPM
                 SQL: sql,
                 PROVIDER: 'mysql'
               )
+              ctx[:URL] = get_host unless !get_host
 
               result = exec_query_without_apm(sql, name, binds)
 
@@ -133,6 +145,7 @@ module StackifyRubyAPM
                 SQL: sql,
                 PROVIDER: 'mysql'
               )
+              ctx[:URL] = get_host unless !get_host
 
               result = exec_delete_without_apm(sql, name, binds)
 
@@ -156,6 +169,7 @@ module StackifyRubyAPM
                 SQL: sql,
                 PROVIDER: 'mysql'
               )
+              ctx[:URL] = get_host unless !get_host
 
               result = exec_update_without_apm(sql, name, binds)
 
@@ -179,6 +193,7 @@ module StackifyRubyAPM
                 SQL: sql,
                 PROVIDER: 'mysql'
               )
+              ctx[:URL] = get_host unless !get_host
 
               result = exec_insert_without_apm(sql, name, binds, _pk = nil, _sequence_name = nil)
 
@@ -186,6 +201,14 @@ module StackifyRubyAPM
                 return result
               end
             end
+
+            def get_host
+              config = self.config.to_h
+              "#{config[:host]}:#{config[:port] || DEFAULT_PORT}"
+            rescue StandardError => error
+              nil
+            end
+
           end
         end
       end

data/lib/stackify_apm/spies/sinatra_activerecord/postgresql_adapter.rb

@@ -2,6 +2,8 @@
 
 # Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
 
+require 'stackify_apm/helper/database_helper'
+
 module StackifyRubyAPM
   # @api private
   module Spies
@@ -22,15 +24,11 @@ module StackifyRubyAPM
               exec_update_without_apm(sql, name, binds)
             end
 
-            ctx = Span::Context.new(
-              CATEGORY: 'Database',
-              SUBCATEGORY: 'Execute',
-              COMPONENT_CATEGORY: 'DB Query',
-              COMPONENT_DETAIL: 'Execute SQL Query',
-              SQL: sql,
-              PROVIDER: 'postgresql'
-            )
+            payload = {sql: sql, binds: binds}
+            statement = query_variables(payload)
+            check_prepared_stmt(statement, payload)
 
+            ctx = Span::Context.new(statement)
             result = exec_update_without_apm(sql, name, binds)
 
             StackifyRubyAPM.span name, TYPE, context: ctx do
@@ -45,15 +43,11 @@ module StackifyRubyAPM
               exec_delete_without_apm(sql, name, binds)
             end
 
-            ctx = Span::Context.new(
-              CATEGORY: 'Database',
-              SUBCATEGORY: 'Execute',
-              COMPONENT_CATEGORY: 'DB Query',
-              COMPONENT_DETAIL: 'Execute SQL Query',
-              SQL: sql,
-              PROVIDER: 'postgresql'
-            )
+            payload = {sql: sql, binds: binds}
+            statement = query_variables(payload)
+            check_prepared_stmt(statement, payload)
 
+            ctx = Span::Context.new(statement)
             result = exec_delete_without_apm(sql, name, binds)
 
             StackifyRubyAPM.span name, TYPE, context: ctx do
@@ -69,15 +63,11 @@ module StackifyRubyAPM
               exec_query_without_apm(sql, name, binds)
             end
 
-            ctx = Span::Context.new(
-              CATEGORY: 'Database',
-              SUBCATEGORY: 'Execute',
-              COMPONENT_CATEGORY: 'DB Query',
-              COMPONENT_DETAIL: 'Execute SQL Query',
-              SQL: sql,
-              PROVIDER: 'postgresql'
-            )
+            payload = {sql: sql, binds: binds}
+            statement = query_variables(payload)
+            check_prepared_stmt(statement, payload)
 
+            ctx = Span::Context.new(statement)
             result = exec_query_without_apm(sql, name, binds)
 
             StackifyRubyAPM.span name, TYPE, context: ctx do
@@ -85,6 +75,27 @@ module StackifyRubyAPM
             end
           end
           # rubocop:enable Lint/UnusedMethodArgument
+
+          def query_variables(payload)
+            props = get_common_db_properties
+            props[:PROVIDER] = 'postgresql'
+            props[:SQL] = payload[:sql]
+            props[:URL] = get_host unless !get_host
+            props
+          end
+
+          def check_prepared_stmt(statement, payload)
+            if StackifyRubyAPM.agent.config.prefix_enabled
+              check_prepared_stmt_by_placeholder(!!payload[:sql].match(/\$\d/), statement, payload)
+            end
+          end
+
+          def get_host
+            connection = self.raw_connection
+            "#{connection.host}:#{connection.port}"
+          rescue StandardError => error
+            nil
+          end
         end
       end
     end

data/lib/stackify_apm/spies/sinatra_activerecord/sqlite_adapter.rb

@@ -2,6 +2,8 @@
 
 # Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
 
+require 'stackify_apm/helper/database_helper'
+
 module StackifyRubyAPM
   # @api private
   module Spies
@@ -21,15 +23,11 @@ module StackifyRubyAPM
               exec_query_without_apm(sql, name, binds)
             end
 
-            ctx = Span::Context.new(
-              CATEGORY: 'Database',
-              SUBCATEGORY: 'Execute',
-              COMPONENT_CATEGORY: 'DB Query',
-              COMPONENT_DETAIL: 'Execute SQL Query',
-              SQL: sql,
-              PROVIDER: 'generic'
-            )
+            payload = {sql: sql, binds: binds}
+            statement = query_variables(payload)
+            check_prepared_stmt(statement, payload)
 
+            ctx = Span::Context.new(statement)
             result = exec_query_without_apm(sql, name, binds)
 
             StackifyRubyAPM.span name, TYPE, context: ctx do
@@ -37,6 +35,18 @@ module StackifyRubyAPM
             end
           end
           # rubocop:enable Lint/UnusedMethodArgument
+
+          def query_variables(payload)
+            props = get_common_db_properties
+            props[:SQL] = payload[:sql]
+            props
+          end
+
+          def check_prepared_stmt(statement, payload)
+            if StackifyRubyAPM.agent.config.prefix_enabled
+              check_prepared_stmt_by_placeholder(payload[:sql].include?('?'), statement, payload)
+            end
+          end
         end
       end
     end

data/lib/stackify_apm/spies/stackify_logger.rb

@@ -14,15 +14,21 @@ module StackifyRubyAPM
           def log_message_task(level, msg, call_trace)
             return log_message_task_without_apm(level, msg, call_trace) unless StackifyRubyAPM.current_transaction
 
-            trans_id = StackifyRubyAPM.current_transaction.id
-            log_uuid = SecureRandom.uuid
+            begin
+              trans_id = StackifyRubyAPM.current_transaction.id
+              log_uuid = SecureRandom.uuid
 
-            # build span context
-            ctx = Span::Context.new(
-              CATEGORY: 'Stackify',
-              SUBCATEGORY: 'Log',
-              ID: log_uuid # matching the MsgObject id
-            )
+              # build span context
+              ctx = Span::Context.new(
+                CATEGORY: 'Stackify',
+                SUBCATEGORY: 'Log',
+                ID: log_uuid # matching the MsgObject id
+              )
+            rescue Exception => e
+              StackifyRubyAPM.agent.error "[StackifyLoggerSpy] Error: creating span context."
+              StackifyRubyAPM.agent.error "[StackifyLoggerSpy] #{e.inspect}"
+              return log_message_task_without_apm(level, msg, call_trace)
+            end
 
             # create log span
             StackifyRubyAPM.span(msg, 'stackify.log', context: ctx) do
@@ -34,15 +40,21 @@ module StackifyRubyAPM
           def log_exception_task(level, ex)
             return log_exception_task_without_apm(level, ex) unless StackifyRubyAPM.current_transaction
 
-            trans_id = StackifyRubyAPM.agent.current_transaction.id
-            log_uuid = SecureRandom.uuid
+            begin
+              trans_id = StackifyRubyAPM.agent.current_transaction.id
+              log_uuid = SecureRandom.uuid
 
-            # build span context
-            ctx = Span::Context.new(
-              CATEGORY: 'Stackify',
-              SUBCATEGORY: 'Log',
-              ID: log_uuid # matching the MsgObject id
-            )
+              # build span context
+              ctx = Span::Context.new(
+                CATEGORY: 'Stackify',
+                SUBCATEGORY: 'Log',
+                ID: log_uuid # matching the MsgObject id
+              )
+            rescue Exception => e
+              StackifyRubyAPM.agent.error "[StackifyLoggerSpy] Error: creating span context."
+              StackifyRubyAPM.agent.error "[StackifyLoggerSpy] #{e.inspect}"
+              return log_exception_task_without_apm(level, ex)
+            end
 
             # create log span
             StackifyRubyAPM.span(ex.message, 'stackify.log', context: ctx) do

data/lib/stackify_apm/spies/sucker_punch.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Monkey patch for the sucker_punch class for running async tasks.
+#
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class SuckerPunchSpy
+      def install
+        SuckerPunch::Job::ClassMethods.class_eval do
+          alias_method '__run_perform_without_elastic_apm', '__run_perform'
+
+          def __run_perform(*args)
+            ret = nil
+            begin
+              name = "#{to_s}.perform"
+              ctx = StackifyRubyAPM::Context.new
+              ctx.category = 'SuckerPunch::Job'
+              transaction = StackifyRubyAPM.transaction name, 'TASK', context: ctx
+              ret = __run_perform_without_elastic_apm(*args)
+            rescue StackifyRubyAPM::InternalError
+              raise # Don't report StackifyRubyAPM errors
+            rescue StandardError => e
+              StackifyRubyAPM.report e
+              raise e
+            ensure
+              transaction.submit()
+            end
+            ret
+          end
+        end
+      end
+    end
+
+    register 'SuckerPunch', 'sucker_punch', SuckerPunchSpy.new
+  end
+end

data/lib/stackify_apm/spies/yell.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Monkey patch for the Yell::Logger class for logging log messages.
+#
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class YellSpy
+      SEVERITIES = ['DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN'].freeze
+
+      def install
+        Yell::Logger.module_eval do
+          alias_method 'add_without_apm', 'add'
+
+          # Log messages
+          def add(options, *messages, &block)
+            return add_without_apm(options, *messages, &block) unless StackifyRubyAPM.current_transaction
+
+            begin
+              name = 'yell;'
+              type = 'ext.yell'
+              log_message = []
+              exception = []
+
+              messages.each { |msg|
+                case msg
+                when ::String
+                  log_message.push(msg)
+                when ::Exception
+                  log_message.push(msg.message)
+                  exception.push("(#{ msg.class })\n#{ msg.backtrace.join("\n") if msg.backtrace }")
+                else
+                  log_message.push(msg.inspect)
+                end
+              }
+
+              ctx = Span::Context.new(
+                CATEGORY: 'Log',
+                SUBCATEGORY: 'Yell',
+                LEVEL: SEVERITIES[options.severity],
+                MESSAGE: log_message.to_s,
+                PREFIX: 'TRUE'
+              )
+
+              if exception.length > 0
+                ctx.EXCEPTION = exception.to_s
+              end
+            rescue Exception => e
+              StackifyRubyAPM.agent.error "[YellSpy] Error: creating span context."
+              StackifyRubyAPM.agent.error "[YellSpy] #{e.inspect}"
+              return add_without_apm(options, *messages, &block)
+            end
+
+            StackifyRubyAPM.span name, type, context: ctx do
+              add_without_apm(options, *messages, &block)
+            end
+          end
+        end
+      end
+    end
+
+    register 'Yell', 'yell', YellSpy.new
+  end
+end