stackify-ruby-apm 1.9.8 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 897d8d6a22f1c94f016daa020e4b423a9f3d891141a88874c9630a0940a1ccec
-  data.tar.gz: 701690bce6b06e581c57640107f1e49999ba81e284fd269edb893390d15fbb6f
+  metadata.gz: 5617c10d650b0e32554d8e6ae3deb13c24275b7d2df82f0f1c6b223654397e4d
+  data.tar.gz: 55a0d2aa8b75165c5f4d7c4cdc0fad19411ae6b3a6e3c57e3d47e13b4f9b37a7
 SHA512:
-  metadata.gz: 55f6cff0dcdcef0626befd3522ca56cd78ce82a360d2ed13aba19dc6b00c6fb6bdc7f0033fd40bfc5ecdc25608f65b293654ac2993c171ab301f84e5c92b72f8
-  data.tar.gz: 71c2cfdfa651ba9bcefc10e2c747e83016e5394fa601bd30640ae0a3729dde52b037df36134c1a773e963f8b74102c50466fed7d0642f013cc67bd559ea61a00
+  metadata.gz: d9cd97e0abb2265239113f5afcfa73bb7d9522de34e37137e3da8ab5b49705d96864d8f03c3e55908623e695bfe5a5b981319463e8a0ebf4e085d71c2b020e0d
+  data.tar.gz: 842839b3d394985cbf583b3b200515272e3c510b377406f0ff0054d2ca85d8145a7f1ae81c3edfec4362f35cf30d5d4f5b2ab17da739a8fba6e8a8b720953866

data/lib/stackify_apm/agent.rb

@@ -101,8 +101,6 @@ module StackifyRubyAPM
       info '[Agent] start()'
       info '[Agent] transport type: ' + @config.transport
       spies_name = ''
-      # If the rake task is detected as being ran then we don't load the spies
-      StackifyRubyAPM::Util.apm_disabled_in_rake
       return false unless @config.instrument
       config.enabled_spies.each do |lib|
         spies_name = spies_name + ', ' + lib.inspect.to_s

data/lib/stackify_apm/config.rb

@@ -209,6 +209,8 @@ module StackifyRubyAPM
         curb/multi
         httparty
         stackify_logger
+        sidekiq
+        delayed_job
       ]
     end
 

data/lib/stackify_apm/context.rb

@@ -12,7 +12,7 @@ module StackifyRubyAPM
   class Context
     include NaivelyHashable
 
-    attr_accessor :request, :response, :aws
+    attr_accessor :request, :response, :aws, :category
     attr_reader :custom, :tags
 
     def initialize

data/lib/stackify_apm/helper/database_helper.rb

@@ -18,7 +18,7 @@ module DatabaseHelper
     elsif driver.include? 'db2'
       'db2'
     elsif driver.include? 'sqlite'
-      'generic'
+      'sqlite'
     end
   end
   # rubocop:enable Metrics/CyclomaticComplexity

data/lib/stackify_apm/instrumenter_helper.rb

@@ -90,9 +90,8 @@ module StackifyRubyAPM
                           )
                         end
 
-                  req = #{current_method_without}(*args, &block)
                   StackifyRubyAPM.span name, type, context: ctx do
-                    req
+                    #{current_method_without}(*args, &block)
                   end
                 else
                   return #{current_method_without}(*args, &block)
@@ -169,9 +168,9 @@ module StackifyRubyAPM
                             CATEGORY: 'Ruby'
                           )
                         end
-                  req = _self_without_apm_#{current_method}(*args, &block)
+
                   StackifyRubyAPM.span name, type, context: ctx do
-                    req
+                    _self_without_apm_#{current_method}(*args, &block)
                   end
                 else
                   return _self_without_apm_#{current_method}(*args, &block)

data/lib/stackify_apm/logger/log_device.rb

@@ -14,9 +14,6 @@ module StackifyRubyAPM
         if FileTest.exist?(@filename)
         else
           @dev = create_logfile(@filename)
-          File.chmod(0o777, @filename)
-
-          return @dev
         end
       end
       write_without_apm(message)
@@ -58,7 +55,6 @@ module StackifyRubyAPM
       temp_newfilename = "#{temp_filename}-#{filename_counter}.log"
       @filename = temp_newfilename
       @dev = create_logfile(@filename)
-      File.chmod(0o777, @filename)
 
       true
     end
@@ -80,10 +76,16 @@ module StackifyRubyAPM
       @dev.close rescue nil
       File.rename(@filename.to_s, age_file)
       @dev = create_logfile(@filename)
-      File.chmod(0o777, @filename)
 
       true
     end
+
+    # Override create_logfile of core LogDevice class where we set File.chmod to 0o777
+    def create_logfile(filename)
+      logdev = super
+      File.chmod(0o777, filename)
+      logdev
+    end
     # rubocop:enable Style/RescueModifier
     # rubocop:enable Lint/RescueWithoutErrorClass
   end

data/lib/stackify_apm/logger/logger_high_version.rb

@@ -29,7 +29,11 @@ module StackifyRubyAPM
           temp_filename = logdev.gsub('-1.log', '')
           new_logdev = temp_filename + '-1.log'
         end
-        @logdev = LogDevice.new(new_logdev, shift_size: shift_size)
+        begin
+          @logdev = LogDevice.new(new_logdev, shift_size: shift_size)
+        rescue StandardError => e
+          puts "Stackify Profiler unable to access [" + logdev + "]"
+        end
       end
     end
     require 'stackify_apm/logger/log_device'

data/lib/stackify_apm/logger/logger_lower_version.rb

@@ -20,7 +20,11 @@ module StackifyRubyAPM
           temp_filename = logdev.gsub('-1.log', '')
           new_logdev = temp_filename + '-1.log'
         end
-        @logdev = LogDevice.new(new_logdev, shift_size: shift_size)
+        begin
+          @logdev = LogDevice.new(new_logdev, shift_size: shift_size)
+        rescue StandardError => e
+          puts "Stackify Profiler unable to access [" + logdev + "]"
+        end
       end
     end
 

data/lib/stackify_apm/root_info.rb

@@ -26,7 +26,7 @@ module StackifyRubyAPM
 
       hash = {
         PROFILER_VERSION: StackifyRubyAPM::VERSION,
-        CATEGORY: 'Ruby',
+        CATEGORY: @transaction.context.category || 'Ruby',
         APPLICATION_PATH: '/',
         APPLICATION_FILESYSTEM_PATH: @config.root_path,
         APPLICATION_NAME: @config.application_name.strip,

data/lib/stackify_apm/spies/custom_instrumenter.rb

@@ -3,6 +3,7 @@
 # Monkey patch for the custom instrumentation any values from config/stackify.json will be loop and will
 # register as a spy.
 #
+require 'logger'
 require 'stackify_apm/instrumenter_helper.rb'
 require 'stackify_apm/config'
 require 'json'
@@ -10,7 +11,8 @@ require 'json'
 # rubocop:disable Metrics/PerceivedComplexity
 module StackifyRubyAPM
   # @api private
-  module Spies
+  module Spies extend Log
+
     def self.run_custom_instrumentation
       config = Config.new
       to_instrument = parse_json_config(config.json_config_file)
@@ -27,11 +29,21 @@ module StackifyRubyAPM
         tracked_func = custom_spy['trackedFunction']
         tracked_func_name = defined?(custom_spy['trackedFunctionName']) ? custom_spy['trackedFunctionName'] : ''
         transaction = defined?(custom_spy['transaction']) ? custom_spy['transaction'] : nil
+        file_path = defined?(custom_spy['file_path']) ? custom_spy['file_path'] : nil
 
         tracked_function_tpl = tracked_func_name.nil? ? '{{ClassName}}.{{MethodName}}' : tracked_func_name
         tracked_function_name = tracked_function_tpl.sub '{{ClassName}}', current_class
         tracked_function_name = tracked_function_name.sub '{{MethodName}}', current_method
 
+        if !class_exists?(current_class) && !file_path.nil?
+          begin
+            require file_path
+          rescue LoadError => e
+            debug "[StackifyRubyAPM] File path doesn't exist."
+            debug e.inspect
+          end
+        end
+
         # rubocop:disable Style/Next
         if class_exists?(current_class)
           mod_constant = Module.const_get(current_class.to_s)

data/lib/stackify_apm/spies/delayed_job.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Monkey patch for the delayed_job class for running async tasks.
+#
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class DelayedJobSpy
+      def install
+        Delayed::Backend::Base.class_eval do
+          alias_method 'invoke_job_without_apm', 'invoke_job'
+
+          def invoke_job(*args, &block)
+            ret = nil
+            begin
+              name = nil
+              if payload_object.is_a?(::Delayed::PerformableMethod)
+                object = payload_object.object
+                klass = object.is_a?(Class) ? object : object.class
+                class_name = klass.name
+                separator = payload_object.object.is_a?(Class) ? '.' : '#'
+                method_name = payload_object.method_name
+                name = "#{class_name}#{separator}#{method_name}"
+              else
+                name = payload_object.class.name
+              end
+              ctx = StackifyRubyAPM::Context.new
+              ctx.category = 'Delayed::Job'
+              transaction = StackifyRubyAPM.transaction name, 'TASK', context: ctx
+              ret = invoke_job_without_apm(*args, &block)
+            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 'Delayed::Backend::Base', 'delayed/backend/base', DelayedJobSpy.new
+  end
+end

data/lib/stackify_apm/spies/sidekiq.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Monkey patch for the sidekiq class for running async tasks.
+#
+
+module StackifyRubyAPM
+  # @api private
+  module Spies
+    # @api private
+    class SidekiqClientSpy
+      def install
+        Sidekiq::Processor.class_eval do
+          alias_method 'process_without_apm', 'process'
+
+          def process(work, *args, &block)
+            ret = nil
+            begin
+              job = nil
+              if defined? work.message
+                job = work.message
+              else
+                job = work.job
+              end
+              job_hash = JSON.parse job
+              name = job_hash["class"]
+              transaction = StackifyRubyAPM.transaction name, 'TASK'
+              ret = process_without_apm(work, *args, &block)
+            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 'Sidekiq::Processor', 'sidekiq/processor', SidekiqClientSpy.new
+  end
+end

data/lib/stackify_apm/transport/agent_base.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'stackify_apm/root_info'
 require 'stackify_apm/serializers'
 
@@ -12,6 +13,15 @@ module StackifyRubyAPM
       @transaction_serializers = Serializers::Transactions.new(config)
     end
 
+    def get_protobuf_message(transactions)
+      protobuf_obj = build_message(transactions)
+      StackifyProtoBuf::Traces.encode(protobuf_obj)
+    end
+
+    def get_json_message(transactions)
+      JSON.generate(build_json_message(transactions))
+    end
+
     # This method will build a group of Stackify::Traces from the protobuf objects.
     # It accept Array of transactions.
     def build_message(transactions = [])
@@ -28,6 +38,19 @@ module StackifyRubyAPM
       debug "[AgentBaseTransport] build_message() exception: #{e.inspect}"
     end
 
+    def build_json_message(transactions = [])
+      traces = []
+      transactions.each do |transaction|
+        # convert transaction to json
+        json_transaction = @transaction_serializers.build_json(@config, transaction)
+        # add to traces array
+        traces << json_transaction
+      end
+      return traces
+    rescue StandardError => e
+      debug "[AgentBaseTransport] build_json_message() exception: #{e.inspect}"
+    end
+
     def post(_transactions = [])
       raise NotImplementedError
     end

data/lib/stackify_apm/transport/agent_http_client.rb

@@ -5,24 +5,32 @@ require 'faraday'
 require 'ostruct'
 
 module StackifyRubyAPM
-  # This class will handle the sending of protobuf messages through HTTP.
+  # This class will handle the sending of transaction messages through HTTP.
   # @api private
   class AgentHTTPClient < AgentBaseTransport
     include Log
 
-    HEADERS = {
-      'Content-Type' => 'application/x-protobuf'
-    }.freeze
-
     def initialize(config)
       @config = config
       super(config)
     end
 
+    def get_protobuf_headers
+      {
+        'Content-Type' => 'application/x-protobuf'
+      }.freeze
+    end
+
+    def get_json_headers
+      {
+        'Content-Type' => 'application/json'
+      }.freeze
+    end
+
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
     #
-    # This method will send a protobuf message to HTTP request.
+    # This method will send a transction message to HTTP request.
     # It will accept Array of transactions.
     def post(transactions = [])
       debug '[AgentHTTPClient] post()' if ENV['STACKIFY_TRANSPORT_LOG_LEVEL'] == '0'
@@ -31,16 +39,14 @@ module StackifyRubyAPM
       retry_count = 0
       delay = @config.delay_seconds
       begin
-        protobuf_obj = build_message(transactions)
-        message = StackifyProtoBuf::Traces.encode(protobuf_obj)
-        # Convert message into binary and send it to http request
+        message = get_json_message(transactions)
         conn = Faraday.new(ssl: { verify: false })
         response = conn.post do |req|
           req.url URI(@config.transport_http_endpoint + @config.agent_traces_url)
-          req.headers = HEADERS
+          req.headers = get_json_headers
           req.body = message
         end
-        if response.try(:status) == 200
+        if defined?(response.status) && response.status == 200
           debug '[AgentHTTPClient] Successfully send message via http request.' if ENV['STACKIFY_TRANSPORT_LOG_LEVEL'] == '0'
         elsif ENV['STACKIFY_TRANSPORT_LOG_LEVEL'] == '0'
           debug "[AgentHTTPClient] Failure sending via http request: #{response.inspect}"

data/lib/stackify_apm/transport/unix_socket_client.rb

@@ -4,7 +4,7 @@ require 'net_http_unix'
 require 'ostruct'
 
 module StackifyRubyAPM
-  # This class will handle the sending of protobuf messages through unix domain socket.
+  # This class will handle the sending of transaction messages through unix domain socket.
   # @api private
   class UnixSocketClient < AgentBaseTransport
     include Log
@@ -14,10 +14,18 @@ module StackifyRubyAPM
       super(config)
     end
 
+    def get_protobuf_headers
+      'application/x-protobuf'
+    end
+
+    def get_json_headers
+      'application/json'
+    end
+
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
     #
-    # This method will send a protobuf message to the unix domain socket.
+    # This method will send a transaction message to the unix domain socket.
     # It will accept Array of transactions.
     def post(transactions = [])
       debug '[UnixSocketClient] post()' if ENV['STACKIFY_TRANSPORT_LOG_LEVEL'] == '0'
@@ -27,11 +35,10 @@ module StackifyRubyAPM
       delay = @config.delay_seconds
       begin
         # Convert message into binary and send it to unix domain socket
-        protobuf_obj = build_message(transactions)
-        message = StackifyProtoBuf::Traces.encode(protobuf_obj)
+        message = get_json_message(transactions)
         client = NetX::HTTPUnix.new('unix://' + @config.unix_socket_path)
         req = Net::HTTP::Post.new(@config.agent_traces_url)
-        req.set_content_type('application/x-protobuf')
+        req.set_content_type(get_json_headers)
         req.body = message
         response = client.request(req)
         debug "[UnixSocketClient] status_code = #{response.code}" if ENV['STACKIFY_TRANSPORT_LOG_LEVEL'] == '0'

data/lib/stackify_apm/util.rb

@@ -8,15 +8,6 @@ module StackifyRubyAPM
       target.to_i * 1_000_000 + target.usec
     end
 
-    #
-    # This method will check if there is any rake task is running.
-    # If rake task is detected we set instrument=false and don't load the spies.
-    #
-    def self.apm_disabled_in_rake
-      cmd_rake = ($PROGRAM_NAME =~ /rake$/)
-      StackifyRubyAPM.agent.config.instrument = false if cmd_rake
-    end
-
     def self.host_os
       host_os = RbConfig::CONFIG['host_os']
       case host_os

data/lib/stackify_apm/version.rb

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

data/lib/stackify_ruby_apm.rb

@@ -35,9 +35,6 @@ require 'stackify_apm/transport/unix_socket_client'
 require 'stackify_apm/transport/agent_http_client'
 require 'stackify_apm/transport/aws_lambda_logging'
 
-require 'google/protobuf'
-require 'proto/stackify_trace'
-
 # Checks if the framework using is Rails
 require 'stackify_apm/railtie' if defined?(::Rails::Railtie)
 

data/stackify-ruby-apm.gemspec

@@ -33,20 +33,6 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency  'bigdecimal'
   end
 
-  # rubocop
-  if RUBY_VERSION >= '2.2.0'
-    spec.add_development_dependency 'rubocop-performance'
-  end
-
-  # protobuf
-  if RUBY_VERSION >= '2.7'
-    spec.add_development_dependency 'google-protobuf', '= 3.5.0'
-  elsif RUBY_VERSION > '2.3'
-    spec.add_development_dependency 'google-protobuf', '>= 3.5.0'
-  else
-    spec.add_development_dependency 'google-protobuf', '= 3.5.0'
-  end
-
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
@@ -57,7 +43,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'httpclient'
   spec.add_development_dependency 'mongo'
   spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'net_http_unix', '~> 0.2'
   spec.add_development_dependency 'pg', '~> 0.20'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rubocop'
@@ -69,11 +54,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'to_bool'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'delayed_job'
 
   spec.add_dependency('concurrent-ruby', '~> 1.0')
   spec.add_dependency('delegate_matcher', '~> 0.4')
   spec.add_dependency('faraday', '~> 0.8')
-  spec.add_dependency('google-protobuf', '>= 3.5.0', '< 4.0')
   spec.add_dependency('net_http_unix', '~> 0.2')
   spec.add_dependency('rufus-scheduler', '~> 3.0')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackify-ruby-apm
 version: !ruby/object:Gem::Version
-  version: 1.9.8
+  version: 1.11.1
 platform: ruby
 authors:
 - Stackify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,34 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: google-protobuf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,20 +178,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: net_http_unix
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -374,6 +332,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: delayed_job
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -416,26 +388,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-- !ruby/object:Gem::Dependency
-  name: google-protobuf
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: net_http_unix
   requirement: !ruby/object:Gem::Requirement
@@ -519,6 +471,7 @@ files:
 - lib/stackify_apm/spies/curb/easy.rb
 - 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/httparty.rb
 - lib/stackify_apm/spies/httpclient.rb
 - lib/stackify_apm/spies/httprb.rb
@@ -526,6 +479,7 @@ files:
 - lib/stackify_apm/spies/net_http.rb
 - lib/stackify_apm/spies/redis.rb
 - lib/stackify_apm/spies/sequel.rb
+- lib/stackify_apm/spies/sidekiq.rb
 - lib/stackify_apm/spies/sinatra.rb
 - lib/stackify_apm/spies/sinatra_activerecord/mysql_adapter.rb
 - lib/stackify_apm/spies/sinatra_activerecord/postgresql_adapter.rb