stackify-ruby-apm 1.12.3 → 1.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec496ca2f97d6531e0e5059845fb078d60e194f0b2896a5148cc570f8de66c13
-  data.tar.gz: 5dbc4a02c01e54b3d1276932f5d7528da2751d734a15926517595528b00dd0a8
+  metadata.gz: c1ee1b9b91d78729820e74b7fbc014310af4037390de6c0982cb0169cba50a8a
+  data.tar.gz: 3a7dfe377099f033779e85d591e8ec973039ee4a4b59f20175e57afdd967819a
 SHA512:
-  metadata.gz: 76c13b39665912b23fa8bd42cb75af0cfa455e83735814f167c768f380b96f411f4267670b8708f15d0aa6de9698d58055fba04ba6f8286dfb1efe51fb724361
-  data.tar.gz: 2aa04cf139250db11e987a38ad213863a0d4dab9427561a1a2f63240a42005b37ab1dd9e8ae62df54159d6a05f9d7039df116fa41eea71f00ed69adfc173ebc3
+  metadata.gz: 143b1fba17994c286ad71dc020d731247079b28a75fda11ee742ed8d49c023557a731e16c0ae8715153d6f5c98dbbb7dbbdaa10a225d4ad8f5f0750aedb7a739
+  data.tar.gz: 28be6a1c40fa6dab5fc5a35f2c56e99984c579d4e5f84e5481ffa6e5c9b9fa9c615a0425c1af81d5a3d1d7d4088df1b4f777250fde816b48a2049f320a1df1c4

data/lib/stackify_apm/config.rb

@@ -214,7 +214,10 @@ module StackifyRubyAPM
         httparty
         stackify_logger
         sidekiq
-        delayed_job
+        delayed_job 
+        faraday
+        sucker_punch
+        dynamo_db
       ]
     end
 

data/lib/stackify_apm/helper/database_helper.rb

@@ -29,7 +29,7 @@ module DatabaseHelper
   #               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.
+  #               So if there's payload value we append PREFIX_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)
@@ -37,14 +37,15 @@ module DatabaseHelper
     unless payload[:binds].nil?
       payload[:binds].each_with_index do |record, idx|
         if record && defined?(record.value)
-          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record.value)
+          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record.value[0..999])
         elsif ((record && record.instance_of?(Array)) && defined?(record[1]))
-          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record[1])
+          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record[1][0..999])
         else
-          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record)
+          StackifyRubyAPM::Util.pushToAryIndex(sqlParam, idx, record[0..999])
         end
       end
-      statement[:SQL_PARAMETERS] = sqlParam.to_json if sqlParam.count > 0
+      statement[:PREFIX_SQL_PARAMETERS] = sqlParam[0..99].to_json if sqlParam.count > 0
+      statement[:PREFIX_SQL_PARAMETER_COUNT] = sqlParam.length.to_s if sqlParam.count > 0
       true
     else
       false

data/lib/stackify_apm/root_info.rb

@@ -47,12 +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[:PREFIX_RESPONSE_BODY] = @transaction.context.prefix.response_body.to_s if @transaction.context.prefix && @transaction.context.prefix.response_body
+      hash[:PREFIX_RESPONSE_SIZE_BYTES] = @transaction.context.prefix.response_body.length.to_s if @transaction.context.prefix && @transaction.context.prefix.response_body
+      hash[:PREFIX_RESPONSE_HEADERS] =  @transaction.context.prefix.response_headers.to_s if @transaction.context.prefix && @transaction.context.prefix.response_headers
+      hash[:PREFIX_REQUEST_BODY] = @transaction.context.prefix.request_body.to_s if @transaction.context.prefix && @transaction.context.prefix.request_body
+      hash[:PREFIX_REQUEST_SIZE_BYTES] = @transaction.context.prefix.request_body.length.to_s if @transaction.context.prefix && @transaction.context.prefix.request_body
+      hash[:PREFIX_REQUEST_HEADERS] = @transaction.context.prefix.request_headers.to_s if @transaction.context.prefix && @transaction.context.prefix.request_headers
       hash
     end
     # rubocop:enable Metrics/CyclomaticComplexity

data/lib/stackify_apm/span/context.rb

@@ -17,7 +17,8 @@ module StackifyRubyAPM
                     :COMPONENT_CATEGORY,
                     :COMPONENT_DETAIL,
                     :SQL,
-                    :SQL_PARAMETERS,
+                    :PREFIX_SQL_PARAMETERS,
+                    :PREFIX_SQL_PARAMETER_COUNT,
                     :SQL_TRUNCATED,
                     :MONGODB_COLLECTION,
                     :METHOD,
@@ -33,33 +34,35 @@ module StackifyRubyAPM
                     :LEVEL,
                     :MESSAGE,
                     :EXCEPTION,
-                    :REQUEST_BODY,
-                    :REQUEST_SIZE_BYTES,
-                    :REQUEST_HEADERS,
-                    :RESPONSE_BODY,
-                    :RESPONSE_SIZE_BYTES,
-                    :RESPONSE_HEADERS
+                    :PREFIX_REQUEST_BODY,
+                    :PREFIX_REQUEST_SIZE_BYTES,
+                    :PREFIX_REQUEST_HEADERS,
+                    :PREFIX_RESPONSE_BODY,
+                    :PREFIX_RESPONSE_SIZE_BYTES,
+                    :PREFIX_RESPONSE_HEADERS,
+                    :PREFIX,
+                    :ACTION
       # rubocop:disable Style/VariableName
       def update_status(status)
         @STATUS = status
       end
 
       def update_request_body(body)
-        @REQUEST_BODY = body.to_s
-        @REQUEST_SIZE_BYTES = body.to_s.length.to_s
+        @PREFIX_REQUEST_BODY = body.to_s
+        @PREFIX_REQUEST_SIZE_BYTES = body.to_s.length.to_s
       end
 
       def update_request_headers(headers)
-        @REQUEST_HEADERS = to_json_list(headers)
+        @PREFIX_REQUEST_HEADERS = to_json_list(headers)
       end
 
       def update_response_body(body)
-        @RESPONSE_BODY = body.to_s
-        @RESPONSE_SIZE_BYTES = body.to_s.length.to_s
+        @PREFIX_RESPONSE_BODY = body.to_s
+        @PREFIX_RESPONSE_SIZE_BYTES = body.to_s.length.to_s
       end
 
       def update_response_headers(headers)
-        @RESPONSE_HEADERS = to_json_list(headers)
+        @PREFIX_RESPONSE_HEADERS = to_json_list(headers)
       end
 
       private

data/lib/stackify_apm/spies/dynamo_db.rb

@@ -0,0 +1,50 @@
+# Monkey patch for the Aws::DynamoDB::Client class
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class DynamoDBSpy
+      TYPE = 'db.dynamo.aws'.freeze
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def install
+        Aws::DynamoDB::Client.class_eval do
+          # Alias all available operations
+          api.operation_names.each do |operation_name|
+            alias_method "#{operation_name}_without_apm", "#{operation_name}"
+
+            define_method(operation_name) do |params = {}, options = {}|
+              original_method = method("#{operation_name}_without_apm")
+              return original_method.call(params, options) unless StackifyRubyAPM.current_transaction
+
+              result = nil
+
+              begin
+                name = operation_name
+                ctx = Span::Context.new(
+                  CATEGORY: 'Database',
+                  SUBCATEGORY: 'DynamoDB',
+                  ACTION: operation_name,
+                )
+              rescue Exception => e
+                StackifyRubyAPM.agent.error "[DynamoDBSpy] Error: creating span context."
+                StackifyRubyAPM.agent.error "[DynamoDBSpy] #{e.inspect}"
+                return original_method.call(params, options)
+              end
+
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                result = original_method.call(params, options)
+                return result
+              end
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+
+    # Registers Aws::DynamoDB::Client spy, go to: /stackify_apm/spies.rb
+    #
+    register 'Aws::DynamoDB::Client', 'aws-sdk-dynamodb', DynamoDBSpy.new
+  end
+end

data/lib/stackify_apm/spies/faraday.rb

@@ -0,0 +1,87 @@
+# Monkey patch for the Faraday class
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class FaradaySpy
+      def install
+        Faraday::Connection.class_eval do
+          alias_method 'run_request_without_apm', 'run_request'
+
+          def run_request(method, url, body, headers, &block)
+            result = nil
+            return run_request_without_apm(method, url, body, headers, &block) unless StackifyRubyAPM.current_transaction
+
+            begin
+              uri = URI(build_url(url))
+
+              # url is not available yet if it is set inside block
+              # we need to build temporary request as of now
+              # NOTE: this could have a side effect doing yeild twice
+              unless uri.host
+                tmp_request = build_request(method) do |req|
+                  yield(req) if block_given?
+                end
+                uri = URI(tmp_request.path)
+              end
+
+              host = uri.host
+              method_upcase = method.to_s.upcase
+              name = "#{method_upcase} #{host}"
+              type = "ext.faraday.#{method_upcase}"
+
+              # Builds span context
+              #
+              ctx = Span::Context.new(
+                CATEGORY: 'Web External',
+                SUBCATEGORY: 'Execute',
+                URL: uri,
+                STATUS: '',
+                METHOD: method_upcase
+              )
+            rescue Exception => e
+              StackifyRubyAPM.agent.error "[FaradaySpy] Error: creating span context."
+              StackifyRubyAPM.agent.error "[FaradaySpy] #{e.inspect}"
+              return run_request_without_apm(method, url, body, headers, &block)
+            end
+
+            # Creates new span from HTTP result
+            #
+            StackifyRubyAPM.span name, type, context: ctx do
+              # Submits HTTP request
+              #
+              result = run_request_without_apm(method, url, body, headers) do |req|
+                yield req if block_given?
+
+                if StackifyRubyAPM.agent.config.prefix_enabled
+                  ctx.update_request_body(req.body || body || "")
+                  ctx.update_request_headers(req.headers || headers || Hash.new)
+                end
+              end
+
+              begin
+                status_code = result.status.to_s
+                ctx.update_status(status_code)
+
+                if StackifyRubyAPM.agent.config.prefix_enabled
+                  ctx.update_response_body(result.body || "")
+                  ctx.update_response_headers(result.headers || Hash.new)
+                end
+              rescue Exception => e
+                StackifyRubyAPM.agent.error '[FaradaySpy] Error: getting status code or updating request/response context.'
+                StackifyRubyAPM.agent.error "[FaradaySpy] #{e.inspect}"
+              end
+              return result
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+    end
+
+    # Registers Faraday spy, go to: /stackify_apm/spies.rb
+    #
+    register 'Faraday', 'faraday', FaradaySpy.new
+  end
+end

data/lib/stackify_apm/spies/log4r.rb

@@ -34,7 +34,8 @@ module StackifyRubyAPM
                 CATEGORY: 'Log',
                 SUBCATEGORY: 'Log4r',
                 LEVEL: Log4r::LNAMES[logevent.level] || 'ANY',
-                MESSAGE: log_message
+                MESSAGE: log_message,
+                PREFIX: 'TRUE'
               )
 
               if exception

data/lib/stackify_apm/spies/logger.rb

@@ -96,7 +96,8 @@ module StackifyRubyAPM
             CATEGORY: 'Log',
             SUBCATEGORY: 'Logger',
             LEVEL: severity || 'ANY',
-            MESSAGE: log_message
+            MESSAGE: log_message,
+            PREFIX: 'TRUE'
           )
 
           if exception

data/lib/stackify_apm/spies/logging.rb

@@ -40,7 +40,8 @@ module StackifyRubyAPM
                 CATEGORY: 'Log',
                 SUBCATEGORY: 'Logging',
                 LEVEL: LVL_LABEL[event.level] || 'ANY',
-                MESSAGE: log_message
+                MESSAGE: log_message,
+                PREFIX: 'TRUE'
               )
 
               if exception

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

@@ -39,7 +39,8 @@ module StackifyRubyAPM
                 CATEGORY: 'Log',
                 SUBCATEGORY: 'Yell',
                 LEVEL: SEVERITIES[options.severity],
-                MESSAGE: log_message.to_s
+                MESSAGE: log_message.to_s,
+                PREFIX: 'TRUE'
               )
 
               if exception.length > 0

data/lib/stackify_apm/version.rb

@@ -2,5 +2,5 @@
 
 # Sets the version of the APM
 module StackifyRubyAPM
-  VERSION = '1.12.3'.freeze
+  VERSION = '1.13.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackify-ruby-apm
 version: !ruby/object:Gem::Version
-  version: 1.12.3
+  version: 1.13.2
 platform: ruby
 authors:
 - Stackify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -474,6 +474,8 @@ files:
 - lib/stackify_apm/spies/curb/multi.rb
 - lib/stackify_apm/spies/custom_instrumenter.rb
 - lib/stackify_apm/spies/delayed_job.rb
+- lib/stackify_apm/spies/dynamo_db.rb
+- lib/stackify_apm/spies/faraday.rb
 - lib/stackify_apm/spies/httparty.rb
 - lib/stackify_apm/spies/httpclient.rb
 - lib/stackify_apm/spies/httprb.rb
@@ -490,6 +492,7 @@ files:
 - lib/stackify_apm/spies/sinatra_activerecord/postgresql_adapter.rb
 - lib/stackify_apm/spies/sinatra_activerecord/sqlite_adapter.rb
 - lib/stackify_apm/spies/stackify_logger.rb
+- lib/stackify_apm/spies/sucker_punch.rb
 - lib/stackify_apm/spies/tilt.rb
 - lib/stackify_apm/spies/yell.rb
 - lib/stackify_apm/stacktrace.rb