stackify-ruby-apm 1.8.0 → 1.10.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a671e23d695c474d3aafa85df6756d98fa51610411f40e2c750a8e2e5ad2bb1
-  data.tar.gz: c34ada9683508fbf2345434260c616100a5394fc58c22c4ea5eeceb8e7be78fe
+  metadata.gz: 4b2d9a08bd90459363bada0dcc980ab8ee610d5f7bbb41100c53f4d6dc8be6ac
+  data.tar.gz: 624b3bd6b64a48270927b77e94663e11416e8f0be84fd86b32b6f5c215251510
 SHA512:
-  metadata.gz: 135db2d570f4d24b94ebd39f70909eb1ca21beb52052eaf25f1788d339039803f229ccdfaea00618386f6656378ae934e79f4a85d4c8eee059ff3941794b9c3f
-  data.tar.gz: b6d344829e9d14e8736bf3e0807fe2c9995d859a733fd1b79920196bc30df3afeac1c2374ad469e1a4bffe9428f43b258243af5138c61981e627ba14f37928f7
+  metadata.gz: 8e749581d00b6d425476dfd7683a86b4ccd67491a5713c50be3602668e666519d94ca3abc74f561454d8cb2283113426caee59e226cea4e2dd83ba1bd0fbc856
+  data.tar.gz: 9f6784afe5998f4d5c3b5c2501df118d19384b0bd00e9e57c20d58ccc1987021eed0ce114b642624b5ca11339d51c2a91d5527a6a10eab123f57fc8b61fd479b

data/Gemfile

@@ -4,27 +4,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in stackify-ruby-apm.gemspec
 gemspec
-
-group :test do
-  gem 'activerecord'
-  gem 'curb', '0.9.8'
-  gem 'fakeredis'
-  gem 'google-protobuf', '3.5.0'
-  gem 'http'
-  gem 'httpclient'
-  gem 'mongo'
-  gem 'mysql2'
-  gem 'net_http_unix', '~> 0.2'
-  gem 'pg', '~> 0.20'
-  gem 'rack-test'
-  gem 'rails', '~> 4.0'
-  gem 'rubocop', require: false
-  gem 'sequel'
-  gem 'sinatra'
-  gem 'sinatra-activerecord'
-  gem 'sqlite3', '1.3.13'
-  gem 'stackify-api-ruby'
-  gem 'timecop'
-  gem 'to_bool'
-  gem 'webmock'
-end

data/lib/stackify-ruby-apm-lambda.rb

@@ -0,0 +1 @@
+require 'stackify_ruby_apm_lambda'

data/lib/stackify_apm/agent.rb

@@ -118,6 +118,10 @@ module StackifyRubyAPM
     # Stores transaction in queue
     #
     def enqueue_transaction(transaction)
+      if !@config.queue
+        return @trace_logger.post([transaction])
+      end
+
       boot_worker unless worker_running?
       pending_transactions.push(transaction)
       return unless should_flush_transactions?

data/lib/stackify_apm/config.rb

@@ -8,7 +8,12 @@ require 'logger'
 require 'yaml'
 require 'socket'
 module StackifyRubyAPM
-  TRANSPORT = [TRACE_LOG = 'default'.freeze, UNIX_SOCKET = 'agent_socket'.freeze, AGENT_HTTP = 'agent_http'.freeze].freeze
+  TRANSPORT = [
+    TRACE_LOG = 'default'.freeze,
+    UNIX_SOCKET = 'agent_socket'.freeze,
+    AGENT_HTTP = 'agent_http'.freeze,
+    LOGGING = 'logging'.freeze
+].freeze
 
   # @api private
   class Config
@@ -62,7 +67,10 @@ module StackifyRubyAPM
       stackify_properties_file: '/usr/local/stackify/stackify-ruby-apm/stackify.properties',
       agent_traces_url: '/traces',
       unix_socket_path: '/usr/local/stackify/stackify.sock',
-      transport_http_endpoint: 'https://localhost:10601'
+      transport_http_endpoint: 'https://localhost:10601',
+
+      queue: true,
+      lambda_handler: ''
     }.freeze
 
     ENV_TO_KEY = {
@@ -87,7 +95,9 @@ module StackifyRubyAPM
       'STACKIFY_SPAN_FRAMES_MIN_DURATION' => [:int, 'span_frames_min_duration'],
       'STACKIFY_MAX_QUEUE_SIZE' => [:int, 'max_queue_size'],
       'STACKIFY_FLUSH_INTERVAL' => 'flush_interval_seconds',
-      'STACKIFY_DISABLED_SPIES' => [:list, 'disabled_spies']
+      'STACKIFY_DISABLED_SPIES' => [:list, 'disabled_spies'],
+      'STACKIFY_QUEUE' => [:bool, 'queue'],
+      'STACKIFY_LAMBDA_HANDLER' => 'lambda_handler'
     }.freeze
 
     def initialize(options = {})
@@ -158,6 +168,9 @@ module StackifyRubyAPM
     attr_accessor :root_path
     attr_accessor :http_status
 
+    attr_accessor :queue
+    attr_accessor :lambda_handler
+
     attr_reader :client_id
     attr_reader :device_id
     attr_reader :apm_disabled_in_rake
@@ -196,6 +209,8 @@ module StackifyRubyAPM
         curb/multi
         httparty
         stackify_logger
+        sidekiq
+        delayed_job
       ]
     end
 
@@ -221,11 +236,18 @@ module StackifyRubyAPM
       new_available_spies - disabled_spies
     end
 
+    # Default Transport
+    #
+    # initialize default logger transport
     def debug_logger
-      debugger_logpath = log_path == '-' ? $stdout : log_path
-      logger = StackifyLogger.new(debugger_logpath, debugger_filenum_rotate, debugger_byte_size)
-      logger.level = log_level
-      self.logger = logger
+      case @transport.downcase
+      # For unix socket we don't create a trace log file
+      when StackifyRubyAPM::TRACE_LOG
+        debugger_logpath = log_path == '-' ? $stdout : log_path
+        logger = StackifyLogger.new(debugger_logpath, debugger_filenum_rotate, debugger_byte_size)
+        logger.level = log_level
+        self.logger = logger
+      end
     end
 
     private

data/lib/stackify_apm/context.rb

@@ -12,12 +12,19 @@ module StackifyRubyAPM
   class Context
     include NaivelyHashable
 
-    attr_accessor :request, :response
+    attr_accessor :request, :response, :aws, :category
     attr_reader :custom, :tags
 
     def initialize
       @custom = {}
       @tags = {}
     end
+
+    # add aws context to context instance
+    #
+    # values {arn}
+    def add_aws_context ctx
+      @aws = ctx
+    end
   end
 end

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/root_info.rb

@@ -15,8 +15,18 @@ module StackifyRubyAPM
     def build
       # get process id
       pid = $PID || Process.pid
+      # get hostname and remove extra unwanted characters
+      begin
+        hostname = (@config.hostname || `hostname`).strip
+      rescue StandardError
+        # use socket to get hostname if `hostname` throws exception
+        require 'socket'
+        hostname = Socket.gethostname
+      end
+
       hash = {
-        CATEGORY: 'Ruby',
+        PROFILER_VERSION: StackifyRubyAPM::VERSION,
+        CATEGORY: @transaction.context.category || 'Ruby',
         APPLICATION_PATH: '/',
         APPLICATION_FILESYSTEM_PATH: @config.root_path,
         APPLICATION_NAME: @config.application_name.strip,
@@ -26,7 +36,7 @@ module StackifyRubyAPM
         THREAD_ID: Thread.current.object_id,
         TRACE_SOURCE: 'RUBY',
         TRACE_TARGET: 'RETRACE',
-        HOST_NAME: (@config.hostname || `hostname`).strip,
+        HOST_NAME: hostname,
         OS_TYPE: StackifyRubyAPM::Util.host_os,
         PROCESS_ID: pid,
         TRACE_VERSION: '2.0',
@@ -36,6 +46,7 @@ module StackifyRubyAPM
       hash[:STATUS] = @transaction.context.response.status_code if @transaction.context && @transaction.context.response && @transaction.context.response.status_code
       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
     end
     # rubocop:enable Metrics/CyclomaticComplexity

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}"