stackify-ruby-apm 1.0.1 → 1.1.0

data/lib/{stackify → stackify_apm}/spies/sinatra.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
-#
+
 # Monkey patch for the Sinatra::Base class which is responsible for handling requests.
-#
 
 module StackifyRubyAPM
   # @api private
   module Spies
     # @api private
     class SinatraSpy
-      # rubocop:disable Metrics/MethodLength
       def install
         ::Sinatra::Base.class_eval do
-          alias dispatch_without_apm! dispatch!
-          alias compile_template_without_apm compile_template
+          alias_method 'dispatch_without_apm!', 'dispatch!'
+          alias_method 'compile_template_without_apm', 'compile_template'
 
-          # Sets transaction name from Sinatra env's route name 
+          # Sets transaction name from Sinatra env's route name
           #
           def dispatch!(*args, &block)
             dispatch_without_apm!(*args, &block).tap do
@@ -25,7 +23,7 @@ module StackifyRubyAPM
             end
           end
 
-          # Tilt engine template 
+          # Tilt engine template
           #
           def compile_template(engine, data, opts, *args, &block)
             opts[:__stackify_apm_template_name] =
@@ -38,15 +36,14 @@ module StackifyRubyAPM
           end
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
 
-    # Registers Sinatra spy, go to: /stackify/spies.rb
+    # Registers Sinatra spy, go to: /stackify_apm/spies.rb
     #
     register 'Sinatra::Base', 'sinatra/base', SinatraSpy.new
 
     # Tilt template helper & span creator
     #
-    require 'stackify/spies/tilt'
+    require 'stackify_apm/spies/tilt'
   end
 end

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

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+# Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class MysqlAdapterSpy
+      TYPE = 'db.sinatra_active_record.sql'.freeze
+
+      if ActiveRecord::VERSION::MAJOR.to_i >= 5
+        def install
+          ActiveRecord::ConnectionAdapters::MySQL::DatabaseStatements.class_eval do
+            alias_method 'exec_query_without_apm', 'exec_query'
+            alias_method 'exec_delete_without_apm', 'exec_delete'
+            alias_method 'exec_update_without_apm', 'exec_update'
+
+            def exec_update(sql, name = nil, binds = [])
+              result = nil
+
+              unless StackifyRubyAPM.current_transaction
+                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'
+              )
+
+              result = exec_update_without_apm(sql, name, binds)
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+
+            def exec_delete(sql, name = nil, binds = [])
+              result = nil
+
+              unless StackifyRubyAPM.current_transaction
+                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'
+              )
+
+              result = exec_delete_without_apm(sql, name, binds)
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+
+            # rubocop:disable Lint/UnusedMethodArgument
+            def exec_query(sql, name = 'SQL', binds = [], prepare: false)
+              result = nil
+
+              unless StackifyRubyAPM.current_transaction
+                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'
+              )
+
+              result = exec_query_without_apm(sql, name, binds)
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+            # rubocop:enable Lint/UnusedMethodArgument
+          end
+        end
+      else
+        def install
+          ActiveRecord::ConnectionAdapters::Mysql2Adapter.class_eval do
+            alias_method 'exec_query_without_apm', 'exec_query'
+            alias_method 'exec_delete_without_apm', 'exec_delete'
+            alias_method 'exec_update_without_apm', 'exec_update'
+            alias_method 'exec_insert_without_apm', 'exec_insert'
+
+            def exec_query(sql, name = 'SQL', binds = [], _prepare: false)
+              result = nil
+
+              unless StackifyRubyAPM.current_transaction
+                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'
+              )
+
+              result = exec_query_without_apm(sql, name, binds)
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+
+            def exec_delete(sql, name = nil, binds = [])
+              result = nil
+
+              unless StackifyRubyAPM.current_transaction
+                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'
+              )
+
+              result = exec_delete_without_apm(sql, name, binds)
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+
+            def exec_update(sql, name, binds)
+              result = nil
+
+              unless StackifyRubyAPM.current_transaction
+                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'
+              )
+
+              result = exec_update_without_apm(sql, name, binds)
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+
+            def exec_insert(sql, name, binds, _pk = nil, _sequence_name = nil)
+              result = nil
+
+              unless StackifyRubyAPM.current_transaction
+                exec_insert_without_apm(sql, name, binds, _pk = nil, _sequence_name = nil)
+              end
+
+              ctx = Span::Context.new(
+                CATEGORY: 'Database',
+                SUBCATEGORY: 'Execute',
+                COMPONENT_CATEGORY: 'DB Query',
+                COMPONENT_DETAIL: 'Execute SQL Query',
+                SQL: sql,
+                PROVIDER: 'mysql'
+              )
+
+              result = exec_insert_without_apm(sql, name, binds, _pk = nil, _sequence_name = nil)
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+          end
+        end
+      end
+    end
+
+    if ActiveRecord::VERSION::MAJOR.to_i >= 5
+      register 'ActiveRecord::ConnectionAdapters::MySQL::DatabaseStatements', 'active_record/connection_adapters/mysql/database_statements', MysqlAdapterSpy.new
+    else
+      register 'ActiveRecord::ConnectionAdapters::Mysql2Adapter', 'active_record/connection_adapters/mysql2_adapter', MysqlAdapterSpy.new
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class PostgresqlAdapterSpy
+      TYPE = 'db.sinatra_active_record.sql'.freeze
+
+      def install
+        ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements.class_eval do
+          alias_method 'exec_query_without_apm', 'exec_query'
+          alias_method 'exec_delete_without_apm', 'exec_delete'
+          alias_method 'exec_update_without_apm', 'exec_update'
+
+          def exec_update(sql, name = nil, binds = [])
+            result = nil
+
+            unless StackifyRubyAPM.current_transaction
+              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'
+            )
+
+            result = exec_update_without_apm(sql, name, binds)
+
+            StackifyRubyAPM.span name, TYPE, context: ctx do
+              return result
+            end
+          end
+
+          def exec_delete(sql, name = nil, binds = [])
+            result = nil
+
+            unless StackifyRubyAPM.current_transaction
+              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'
+            )
+
+            result = exec_delete_without_apm(sql, name, binds)
+
+            StackifyRubyAPM.span name, TYPE, context: ctx do
+              return result
+            end
+          end
+
+          # rubocop:disable Lint/UnusedMethodArgument
+          def exec_query(sql, name = 'SQL', binds = [], prepare: false)
+            result = nil
+
+            unless StackifyRubyAPM.current_transaction
+              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'
+            )
+
+            result = exec_query_without_apm(sql, name, binds)
+
+            StackifyRubyAPM.span name, TYPE, context: ctx do
+              return result
+            end
+          end
+          # rubocop:enable Lint/UnusedMethodArgument
+        end
+      end
+    end
+
+    register 'ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements', 'active_record/connection_adapters/postgresql/database_statements', PostgresqlAdapterSpy.new
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class SqliteAdapterSpy
+      TYPE = 'db.sinatra_active_record.sql'.freeze
+
+      def install
+        ActiveRecord::ConnectionAdapters::SQLite3Adapter.class_eval do
+          alias_method 'exec_query_without_apm', 'exec_query'
+
+          # rubocop:disable Lint/UnusedMethodArgument
+          def exec_query(sql, name = 'SQL', binds = [], prepare: false)
+            result = nil
+
+            unless StackifyRubyAPM.current_transaction
+              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'
+            )
+
+            result = exec_query_without_apm(sql, name, binds)
+
+            StackifyRubyAPM.span name, TYPE, context: ctx do
+              return result
+            end
+          end
+          # rubocop:enable Lint/UnusedMethodArgument
+        end
+      end
+    end
+
+    register 'ActiveRecord::ConnectionAdapters::SQLite3Adapter', 'active_record/connection_adapters/sqlite3_adapter', SqliteAdapterSpy.new
+  end
+end

data/lib/stackify_apm/spies/stackify_logger.rb

@@ -0,0 +1,60 @@
+# Monkeypatch for the MsgObject to set the value id for Logging / Trace Linking
+#
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class StackifyLoggerSpy
+      if defined? Stackify
+        ::Stackify::LoggerClient.class_eval do
+          require 'securerandom'
+          alias_method 'log_message_task_without_apm', 'log_message_task'
+          alias_method 'log_exception_task_without_apm', 'log_exception_task'
+          # set trans_id parameter on log message to be passed unto MsgObject
+          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
+
+            # build span context
+            ctx = Span::Context.new(
+              CATEGORY: 'Stackify',
+              SUBCATEGORY: 'Log',
+              ID: log_uuid # matching the MsgObject id
+            )
+
+            # create log span
+            StackifyRubyAPM.span(msg, 'stackify.log', context: ctx) do
+              log_message_task_without_apm(level, msg, call_trace, trans_id, log_uuid)
+            end
+          end
+
+          # set trans_id parameter on log exception to be passed unto MsgObject
+          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
+
+            # build span context
+            ctx = Span::Context.new(
+              CATEGORY: 'Stackify',
+              SUBCATEGORY: 'Log',
+              ID: log_uuid # matching the MsgObject id
+            )
+
+            # create log span
+            StackifyRubyAPM.span(ex.message, 'stackify.log', context: ctx) do
+              log_exception_task_without_apm(level, ex, trans_id, log_uuid)
+            end
+          end
+        end
+      end
+    end
+
+    # Registers StackifyLogger spy, go to: /stackify_apm/spies.rb
+    #
+    register 'StackifyLogger', 'stackifylogger', StackifyLoggerSpy.new if defined? Stackify
+  end
+end