stackify-ruby-apm 1.11.1 → 1.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5617c10d650b0e32554d8e6ae3deb13c24275b7d2df82f0f1c6b223654397e4d
-  data.tar.gz: 55a0d2aa8b75165c5f4d7c4cdc0fad19411ae6b3a6e3c57e3d47e13b4f9b37a7
+  metadata.gz: ec496ca2f97d6531e0e5059845fb078d60e194f0b2896a5148cc570f8de66c13
+  data.tar.gz: 5dbc4a02c01e54b3d1276932f5d7528da2751d734a15926517595528b00dd0a8
 SHA512:
-  metadata.gz: d9cd97e0abb2265239113f5afcfa73bb7d9522de34e37137e3da8ab5b49705d96864d8f03c3e55908623e695bfe5a5b981319463e8a0ebf4e085d71c2b020e0d
-  data.tar.gz: 842839b3d394985cbf583b3b200515272e3c510b377406f0ff0054d2ca85d8145a7f1ae81c3edfec4362f35cf30d5d4f5b2ab17da739a8fba6e8a8b720953866
+  metadata.gz: 76c13b39665912b23fa8bd42cb75af0cfa455e83735814f167c768f380b96f411f4267670b8708f15d0aa6de9698d58055fba04ba6f8286dfb1efe51fb724361
+  data.tar.gz: 2aa04cf139250db11e987a38ad213863a0d4dab9427561a1a2f63240a42005b37ab1dd9e8ae62df54159d6a05f9d7039df116fa41eea71f00ed69adfc173ebc3

data/lib/stackify_apm/config.rb

@@ -26,7 +26,7 @@ module StackifyRubyAPM
       environment_name: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
       already_instrumented_flag: false,
       rum_auto_injection: false,
-      rum_enabled: false,
+      rum_enabled: true,
       rum_cookie_path: '/',
       rum_cookie_name: '.Stackify.Rum',
       transport: StackifyRubyAPM::TRACE_LOG,
@@ -70,7 +70,8 @@ module StackifyRubyAPM
       transport_http_endpoint: 'https://localhost:10601',
 
       queue: true,
-      lambda_handler: ''
+      lambda_handler: '',
+      prefix_enabled: false
     }.freeze
 
     ENV_TO_KEY = {
@@ -97,7 +98,8 @@ module StackifyRubyAPM
       'STACKIFY_FLUSH_INTERVAL' => 'flush_interval_seconds',
       'STACKIFY_DISABLED_SPIES' => [:list, 'disabled_spies'],
       'STACKIFY_QUEUE' => [:bool, 'queue'],
-      'STACKIFY_LAMBDA_HANDLER' => 'lambda_handler'
+      'STACKIFY_LAMBDA_HANDLER' => 'lambda_handler',
+      'STACKIFY_PREFIX_ENABLED' => [:bool, 'prefix_enabled']
     }.freeze
 
     def initialize(options = {})
@@ -105,6 +107,7 @@ module StackifyRubyAPM
       set_from_args(options)
       set_from_config_file
       set_from_env
+      set_prefix_paths if @prefix_enabled
       yield self if block_given?
       debug_logger
       StackifyRubyAPM::Util.host_os == 'WINDOWS' ? load_stackify_props_windows : load_stackify_props_linux
@@ -170,6 +173,7 @@ module StackifyRubyAPM
 
     attr_accessor :queue
     attr_accessor :lambda_handler
+    attr_accessor :prefix_enabled
 
     attr_reader :client_id
     attr_reader :device_id
@@ -214,6 +218,16 @@ module StackifyRubyAPM
       ]
     end
 
+    def prefix_spies
+      return [] unless @prefix_enabled
+      %w[
+        logger
+        logging
+        log4r
+        yell
+      ]
+    end
+
     def enabled_spies
       # check if the framework is rails or sinatra
       sinatra_activerecord_spies = %w[
@@ -233,7 +247,7 @@ module StackifyRubyAPM
                               available_spies
                             end
 
-      new_available_spies - disabled_spies
+      new_available_spies + prefix_spies - disabled_spies
     end
 
     # Default Transport
@@ -254,7 +268,11 @@ module StackifyRubyAPM
 
     def assign(options)
       options.each do |key, value|
-        send("#{key}=", value)
+        begin
+          send("#{key}=", value)
+        rescue Exception => e
+          info "[Config] Key: '#{key}' doesn't exist."
+        end
       end
     end
 
@@ -295,6 +313,14 @@ module StackifyRubyAPM
       assign(YAML.load_file(config_file) || {})
     end
 
+    # set log paths to prefix path if prefix_enabled is true
+    def set_prefix_paths
+      all_user_profile = ENV['ALLUSERSPROFILE'] || "C:\\ProgramData"
+
+      @log_path = StackifyRubyAPM::Util.host_os == 'WINDOWS' ? "#{all_user_profile}\\Stackify\\Agent\\debug\\stackify-ruby-apm-1.log" : "/usr/local/prefix/debug/stackify-ruby-apm-1.log"
+      @log_trace_path = StackifyRubyAPM::Util.host_os == 'WINDOWS' ? "#{all_user_profile}\\Stackify\\Agent\\log\\" : '/usr/local/prefix/log/'
+    end
+
     # rubocop:disable Naming/AccessorMethodName
     def set_rails(app)
       self.application_name ||= format_name(application_name || app.class.parent_name).strip
@@ -382,6 +408,7 @@ module StackifyRubyAPM
       info '[Config] environment_name must be String type.' unless @environment_name.is_a?(String) && defined?(@environment_name)
       info '[Config] transport must be String type.' unless @transport.is_a?(String) && defined?(@transport)
       info '[Config] Transport should be one of these values: [agent_socket, default, agent_http]. Should be a String.' if defined?(@transport) && !%w[agent_socket default agent_http].include?(@transport.downcase)
+      info '[Config] prefix_enabled must be Boolean type: true/false.' unless [TrueClass, FalseClass].include?(@prefix_enabled.class) && defined?(@prefix_enabled)
     end
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity

data/lib/stackify_apm/context.rb

@@ -2,7 +2,9 @@
 
 # This class initializes the parameters and variables for the context of Transaction/Span
 
+require 'stackify_apm/context/prefix'
 require 'stackify_apm/context/request'
+require 'stackify_apm/context/request/headers'
 require 'stackify_apm/context/request/socket'
 require 'stackify_apm/context/request/url'
 require 'stackify_apm/context/response'
@@ -12,12 +14,13 @@ module StackifyRubyAPM
   class Context
     include NaivelyHashable
 
-    attr_accessor :request, :response, :aws, :category
+    attr_accessor :request, :response, :aws, :category, :prefix
     attr_reader :custom, :tags
 
     def initialize
       @custom = {}
       @tags = {}
+      @prefix = Context::Prefix.new
     end
 
     # add aws context to context instance

data/lib/stackify_apm/context/prefix.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module StackifyRubyAPM
+  class Context
+    # @api private
+    class Prefix
+      include NaivelyHashable
+
+      attr_accessor :response_body, :request_body
+      attr_reader :response_headers, :request_headers
+
+      def request_headers=(headers)
+        @request_headers = to_json_list(headers)
+      end
+
+      def response_headers=(headers)
+        @response_headers = to_json_list(headers)
+      end
+
+      private
+      def to_json_list(header)
+        list_header = []
+        header.each do |key, value|
+          list_header << {key => value}
+        end
+        list_header.to_json
+      end
+    end
+  end
+end

data/lib/stackify_apm/context/request/headers.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module StackifyRubyAPM
+  # @api private
+  class Context
+    # @api private
+    class Request
+      # @api private
+      class Headers
+        include NaivelyHashable
+
+        def initialize(req)
+          @values = build_headers req
+        end
+
+        attr_reader :values
+
+        def build_headers req
+          env = req.env
+          headers = Hash[*env.select {|k,v| k.start_with? 'HTTP_'}
+            .collect {|k,v| [k.sub(/^HTTP_/, ''), v]}
+            .collect {|k,v| [k.split('_').collect(&:capitalize).join('-'), v]}
+            .sort
+            .flatten]
+          return headers
+        end
+      end
+    end
+  end
+end

data/lib/stackify_apm/context_builder.rb

@@ -27,6 +27,7 @@ module StackifyRubyAPM
       request.method = req.request_method
       request.url = Context::Request::Url.new(req).to_h
       request.body = get_body(req)
+      request.headers = Context::Request::Headers.new(req).values
 
       context
     end

data/lib/stackify_apm/helper/database_helper.rb

@@ -23,5 +23,43 @@ module DatabaseHelper
   end
   # rubocop:enable Metrics/CyclomaticComplexity
   # rubocop:enable Metrics/PerceivedComplexity
+
+  # Check the prepared statement by placeholder if its valid
+  # placeholder - contains the prepared statement pattern.
+  #               Placeholder for mysql, sqlite, jdbc oracle, db2 is ?, example "SELECT * FROM posts WHERE author = ? and id = ?"
+  #               Placeholder for postgres is $1, $2,...$n, example "SELECT * FROM posts WHERE author = $1 and id = $2"
+  # statement   - contains the db properties such as SQL, PROVIDER, etc.
+  #               So if there's payload value we append SQL_PARAMETERS to the existing object properties.
+  # payload     - contains the payload[:binds] which is the payload value/data of the placeholder.
+  #               Example payload: {:sql=>"SELECT * FROM posts WHERE author = ? and id = ?", :db_adapter=>"mysql2::client", :binds=>["J.K. Rowling", 1]}
+  def check_prepared_stmt_by_placeholder(placeholder, statement, payload)
+    sqlParam = []
+    unless payload[:binds].nil?
+      payload[:binds].each_with_index do |record, idx|
+        if record && defined?(record.value)
+          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record.value)
+        elsif ((record && record.instance_of?(Array)) && defined?(record[1]))
+          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record[1])
+        else
+          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record)
+        end
+      end
+      statement[:SQL_PARAMETERS] = sqlParam.to_json if sqlParam.count > 0
+      true
+    else
+      false
+    end
+  end
+
+  # Common DB span properties shared to sequel, activerecord, etc.
+  def get_common_db_properties
+    {
+      CATEGORY: 'Database',
+      SUBCATEGORY: 'Execute',
+      COMPONENT_CATEGORY: 'DB Query',
+      COMPONENT_DETAIL: 'Execute SQL Query',
+      PROVIDER: 'generic'
+    }
+  end
 end
 include DatabaseHelper

data/lib/stackify_apm/instrumenter_helper.rb

@@ -189,6 +189,93 @@ module StackifyRubyAPM
       @custom_class_info[current_class.to_s]['controller'] = true if class_path && class_path.include?('controllers')
       @custom_class_info[current_class.to_s]['model'] = true if class_path && class_path.include?('models')
     end
+
+    # Monkey patch the single ruby module file.
+    #
+    # tracked_func - trackedFunction variable in stackify.json
+    # current_module - module variable in stackify.json
+    # class_path - file_path variable in stackify.json
+    # options - other options such as trackedFunctionName
+    def self.patched_module(tracked_func, current_module, class_path, **options)
+      current_method = options[:current_method] || nil
+      tracked_function_name = options[:tracked_function_name] || nil
+      transaction = options[:is_transaction] || nil
+      mod_spy = "#{current_module}Spy"
+
+      unless @custom_instrumented[current_module.to_s]
+        @custom_instrumented[current_module.to_s] = {}
+      end
+
+      unless @custom_instrumented[current_module.to_s][current_method.to_s]
+        @custom_instrumented[current_module.to_s][current_method.to_s] = false
+      end
+
+      unless @custom_class_info[current_module.to_s]
+        @custom_class_info[current_module.to_s] = {}
+      end
+
+      unless @custom_class_info[current_module.to_s]['controller']
+        @custom_class_info[current_module.to_s]['controller'] = false
+      end
+
+      unless @custom_class_info[current_module.to_s]['model']
+        @custom_class_info[current_module.to_s]['model'] = false
+      end
+
+      return unless @custom_instrumented[current_module.to_s][current_method.to_s] == false
+
+      eval <<-RUBY
+        module #{mod_spy}
+          def self.install
+            #{current_module}.class_eval do
+              class<< self
+                alias_method "#{current_method}_without_apm", "#{current_method}"
+
+                def #{current_method}(*args, &block)
+                  if StackifyRubyAPM.current_transaction.nil? && #{!transaction.nil?}
+                    t = StackifyRubyAPM.transaction("custom.#{current_module}.#{current_method}", TRACETYPE)
+                    begin
+                      req = #{current_method}_without_apm(*args, &block)
+                    rescue Exception => e
+                      StackifyRubyAPM.report(e)
+                      raise e
+                    ensure
+                      t.submit
+                    end
+                    return req
+                  elsif StackifyRubyAPM.current_transaction
+                    name = "Custom Instrument"
+                    type = "#{current_module}##{current_method}"
+                    ctx = if "#{tracked_func}" == 'true'
+                            Span::Context.new(
+                              CATEGORY: 'Ruby',
+                              TRACKED_FUNC: "#{tracked_function_name}"
+                            )
+                          else
+                            Span::Context.new(
+                              CATEGORY: 'Ruby'
+                            )
+                          end
+
+                    StackifyRubyAPM.span name, type, context: ctx do
+                      #{current_method}_without_apm(*args, &block)
+                    end
+                  else
+                    return #{current_method}_without_apm(*args, &block)
+                  end
+                end
+              end
+            end
+          end
+        end
+
+        StackifyRubyAPM::Spies.register current_module.to_s, class_path.to_s, #{mod_spy}, true, "#{current_method}", "#{tracked_func}", "#{tracked_function_name}"
+      RUBY
+      @custom_instrumented[current_module.to_s][current_method.to_s] = true
+      @custom_class_info[current_module.to_s]['controller'] = true if class_path && class_path.include?('controllers')
+      @custom_class_info[current_module.to_s]['model'] = true if class_path && class_path.include?('models')
+    end
+
     # rubocop:enable Metrics/CyclomaticComplexity
     # rubocop:enable Metrics/PerceivedComplexity
     # rubocop:enable Lint/UselessAssignment

data/lib/stackify_apm/middleware.rb

@@ -39,7 +39,8 @@ module StackifyRubyAPM
     # rubocop:disable Metrics/PerceivedComplexity
     def call(env)
       begin
-        transaction = build_transaction(env) if running?
+        context = StackifyRubyAPM.build_context(env)
+        transaction = build_transaction(env, context) if running?
         resp = @app.call env
 
         @rack_status = resp[0].to_i
@@ -47,6 +48,8 @@ module StackifyRubyAPM
         @rack_body = resp[2]
         @configuration = config
 
+        build_prefix_context(transaction, context)
+
         if okay_to_modify?
           @configuration.already_instrumented_flag = true
           if @configuration.rum_enabled.is_a?(TrueClass)
@@ -92,8 +95,9 @@ module StackifyRubyAPM
 
     # Start of transaction building with params: name, type, context
     #
-    def build_transaction(env)
-      StackifyRubyAPM.transaction 'Rack', 'WEBAPP', context: StackifyRubyAPM.build_context(env)
+    def build_transaction(env, context=nil)
+      context = context || StackifyRubyAPM.build_context(env)
+      StackifyRubyAPM.transaction 'Rack', 'WEBAPP', context: context
     end
 
     def running?
@@ -129,5 +133,19 @@ module StackifyRubyAPM
     def xhr?
       @rack_headers['HTTP_X_REQUESTED_WITH'] == 'XMLHttpRequest'
     end
+
+    # Add prefix instrument data to transaction context if enabled
+    def build_prefix_context(transaction, context)
+      return nil unless @configuration.prefix_enabled.is_a?(TrueClass)
+
+      source = nil
+      body = @rack_body
+      body.each { |fragment| source ? (source << fragment.to_s) : (source = fragment.to_s) }
+
+      transaction.context.prefix.request_body = context && context.request && context.request.body || ""
+      transaction.context.prefix.request_headers = context && context.request && context.request.headers || Hash.new
+      transaction.context.prefix.response_body = source || ""
+      transaction.context.prefix.response_headers = @rack_headers || Hash.new
+    end
   end
 end

data/lib/stackify_apm/normalizers/active_record.rb

@@ -20,6 +20,7 @@ module StackifyRubyAPM
           return :skip if %w[SCHEMA CACHE].include?(payload[:name])
 
           statement = query_variables(payload)
+          check_prepared_stmt(statement, payload)
           name = payload[:sql] || payload[:name] || 'Default'
           context = Span::Context.new(statement)
           [name, @type, context]
@@ -28,14 +29,10 @@ module StackifyRubyAPM
         private
 
         def query_variables(payload)
-          {
-            CATEGORY: 'Database',
-            SUBCATEGORY: 'Execute',
-            COMPONENT_CATEGORY: 'DB Query',
-            COMPONENT_DETAIL: 'Execute SQL Query',
-            SQL: payload[:sql],
-            PROVIDER: get_profiler(lookup_adapter)
-          }
+          props = get_common_db_properties
+          props[:PROVIDER] = get_profiler(lookup_adapter)
+          props[:SQL] = payload[:sql]
+          props
         end
 
         def lookup_adapter
@@ -44,6 +41,17 @@ module StackifyRubyAPM
           debug '[SqlNormalizer] lookup_adapter err: ' + error.inspect.to_s
           nil
         end
+
+        def check_prepared_stmt(statement, payload)
+          if StackifyRubyAPM.agent.config.prefix_enabled
+            case get_profiler(lookup_adapter)
+            when 'generic', 'mysql', 'sqlite', 'oracle', 'db2'
+              check_prepared_stmt_by_placeholder(payload[:sql].include?('?'), statement, payload)
+            when 'postgresql'
+              check_prepared_stmt_by_placeholder(!!payload[:sql].match(/\$\d/), statement, payload)
+            end
+          end
+        end
       end
     end
   end

data/lib/stackify_apm/root_info.rb

@@ -47,6 +47,12 @@ module StackifyRubyAPM
       hash[:URL] = @transaction.context.request.url[:full] if @transaction.context && @transaction.context.request && @transaction.context.request.url[:full]
       hash[:RUM] = true if @config.rum_enabled.is_a?(TrueClass)
       hash[:AWS_LAMBDA_ARN] = @transaction.context.aws[:arn] if @transaction.context && @transaction.context.aws && @transaction.context.aws[:arn]
+      hash[:RESPONSE_BODY] = @transaction.context.prefix.response_body.to_s if @transaction.context.prefix && @transaction.context.prefix.response_body
+      hash[:RESPONSE_SIZE_BYTES] = @transaction.context.prefix.response_body.length.to_s if @transaction.context.prefix && @transaction.context.prefix.response_body
+      hash[:RESPONSE_HEADERS] =  @transaction.context.prefix.response_headers.to_s if @transaction.context.prefix && @transaction.context.prefix.response_headers
+      hash[:REQUEST_BODY] = @transaction.context.prefix.request_body.to_s if @transaction.context.prefix && @transaction.context.prefix.request_body
+      hash[:REQUEST_SIZE_BYTES] = @transaction.context.prefix.request_body.length.to_s if @transaction.context.prefix && @transaction.context.prefix.request_body
+      hash[:REQUEST_HEADERS] = @transaction.context.prefix.request_headers.to_s if @transaction.context.prefix && @transaction.context.prefix.request_headers
       hash
     end
     # rubocop:enable Metrics/CyclomaticComplexity