stackify-ruby-apm 1.0.1 → 1.1.0

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Monkey patch for the Tilt::Template class on template rendering and span creation.
 #
@@ -8,12 +9,11 @@ module StackifyRubyAPM
   module Spies
     # @api private
     class TiltSpy
-
       TYPE = 'template.tilt'.freeze
 
       def install
         ::Tilt::Template.class_eval do
-          alias render_without_apm render
+          alias_method 'render_without_apm', 'render'
 
           def render(*args, &block)
             name = options[:__stackify_apm_template_name] || 'Unknown template'
@@ -28,7 +28,7 @@ module StackifyRubyAPM
       end
     end
 
-    # Registers Tilt spy, go to: /stackify/spies.rb
+    # Registers Tilt spy, go to: /stackify_apm/spies.rb
     #
     register 'Tilt::Template', 'tilt/template', TiltSpy.new
   end

data/lib/stackify_apm/stacktrace.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# This module starts creation for frames
+
+module StackifyRubyAPM
+  # @api private
+  class Stacktrace
+    attr_accessor :frames
+
+    def length
+      frames.length
+    end
+
+    def to_a
+      frames.map(&:to_h)
+    end
+  end
+end

data/lib/stackify_apm/stacktrace/frame.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module StackifyRubyAPM
+  class Stacktrace
+    # @api private
+    class Frame
+      include NaivelyHashable
+
+      attr_accessor(
+        :abs_path,
+        :filename,
+        :function,
+        :vars,
+        :pre_context,
+        :context_line,
+        :post_context,
+        :library_frame,
+        :lineno,
+        :module,
+        :Method,
+        :colno
+      )
+
+      def build_context(context_line_count)
+        return unless abs_path && context_line_count.positive?
+
+        padding = (context_line_count - 1) / 2
+        from = lineno - padding - 1
+        from = 0 if from.negative?
+        to = lineno + padding - 1
+        file_lines = read_lines(abs_path, from..to)
+
+        self.context_line = file_lines[padding]
+        self.pre_context  = file_lines.first(padding)
+        self.post_context = file_lines.last(padding)
+      end
+
+      private
+
+      def read_lines(path, range)
+        File.readlines(path)[range]
+      rescue Errno::ENOENT
+        []
+      end
+    end
+  end
+end

data/lib/{stackify → stackify_apm}/stacktrace_builder.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
-#
+
 # This module gathers the lists of frames and build them into hash format
-#
-require 'stackify/stacktrace/frame'
-require 'stackify/util/lru_cache'
+
+require 'stackify_apm/stacktrace/frame'
+require 'stackify_apm/util/lru_cache'
 
 module StackifyRubyAPM
   # @api private
@@ -31,7 +31,6 @@ module StackifyRubyAPM
 
     private
 
-    # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
     def build_frame(cache, keys)
       line, type = keys
       abs_path, lineno, function, _module_name = parse_line(line)
@@ -39,11 +38,11 @@ module StackifyRubyAPM
       library_frame = library_frame?(config, abs_path)
 
       frame = Stacktrace::Frame.new
-      #frame.abs_path = abs_path
-      #frame.filename = strip_load_path(abs_path)
-      frame.Method =  "#{function} (#{current_filename}:#{lineno})"
-      #frame.lineno = lineno.to_i
-      #frame.library_frame = library_frame?(config, abs_path)
+      # frame.abs_path = abs_path
+      # frame.filename = strip_load_path(abs_path)
+      frame.Method = "#{function} (#{current_filename}:#{lineno})"
+      # frame.lineno = lineno.to_i
+      # frame.library_frame = library_frame?(config, abs_path)
 
       line_count =
         context_lines_for(config, type, library_frame)
@@ -51,7 +50,6 @@ module StackifyRubyAPM
 
       cache[[line, type]] = frame
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     def parse_line(line)
       ruby_match = line.match(RUBY_FORMAT)
@@ -73,6 +71,7 @@ module StackifyRubyAPM
 
       if abs_path.start_with?(config.root_path)
         return true if abs_path.start_with?(config.root_path + '/vendor')
+
         return false
       end
 

data/lib/{stackify → stackify_apm}/subscriber.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
-#
+
 # The Subscriber registers the existing events.
 # This will trigger (together with the Middleware) once there is a web request.
-#
 
 require 'active_support/notifications'
-require 'stackify/normalizers'
+require 'stackify_apm/normalizers'
 
 module StackifyRubyAPM
   # @api private
@@ -36,8 +35,11 @@ module StackifyRubyAPM
     Notification = Struct.new(:id, :span)
 
     # [call] Called when the rails version is 3.x
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def call(name, started, finished, id, payload)
       return unless (transaction = @agent.current_transaction)
+
       debug '[Subscriber] call():'
       debug id
       debug name
@@ -47,34 +49,38 @@ module StackifyRubyAPM
 
       if started
         span =
-        if normalized == :skip
-          nil
-        else
-          name, type, context = normalized
-          @agent.span(name, type, context: context)
-        end
+          if normalized == :skip
+            nil
+          else
+            name, type, context = normalized
+            @agent.span(name, type, context: context)
+          end
         transaction.notifications << Notification.new(id, span)
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:disable Style/GuardClause
 
       if finished
         while (notification = transaction.notifications.pop)
           next unless notification.id == id
-  
           if (span = notification.span)
             span.done
           end
           return
         end
       end
+      # rubocop:enable Style/GuardClause
     end
 
     # [start] Called when the rails version is NOT 3.x
     def start(name, id, payload)
       return unless (transaction = @agent.current_transaction)
-        debug '[Subscriber] start():'
-        debug id
-        debug name
-        debug transaction
+
+      debug '[Subscriber] start():'
+      debug id
+      debug name
+      debug transaction
       normalized = @normalizers.normalize(transaction, name, payload)
 
       span =

data/lib/{stackify → stackify_apm}/trace_logger.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
-#
+
 # This class generates/appends the json log file after every Web Request
-#
 
-require 'stackify/root_info'
-require 'stackify/serializers'
+require 'stackify_apm/root_info'
+require 'stackify_apm/serializers'
 
 module StackifyRubyAPM
-
   # @api private
   class TraceLogger
     include Log
@@ -15,14 +13,12 @@ module StackifyRubyAPM
     def initialize(config)
       @config = config
       @trace_file_counter = 0
-      @process_id = 0
       @transaction_serializers = Serializers::Transactions.new(config)
     end
 
-    attr_accessor :trace_file_counter, :process_id
+    attr_accessor :trace_file_counter
 
     def post(transactions = [])
-  
       # convert transactions to json
       json_traces = []
       transactions.each  do |transaction|
@@ -33,16 +29,14 @@ module StackifyRubyAPM
         json_traces.push(json_transaction)
       end
 
-      pid = $PID || Process.pid
-      host_name = @config.hostname || `hostname`
       date_now = Time.now
-      current_datetime = date_now.strftime("%Y-%m-%d, %H:%M:%S.%6N")
+      current_datetime = date_now.strftime('%Y-%m-%d, %H:%M:%S.%6N')
+
+      return unless ENV['STACKIFY_RUBY_ENV'] != 'rspec'
 
-      if(ENV['STACKIFY_RUBY_ENV'] != 'rspec')
-        json_traces.each do |json_trace|
-          update_json = current_datetime + " > " + json_trace + "\n"
-          @config.tracer_logger.<<(update_json)
-        end
+      json_traces.each do |json_trace|
+        update_json = current_datetime + ' > ' + json_trace + "\n"
+        @config.tracer_logger.<<(update_json)
       end
     end
   end

data/lib/stackify_apm/transaction.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+#
+# This class creates and initializes a new transaction.
+#
+module StackifyRubyAPM
+  require 'securerandom'
+  # @api private
+  class Transaction
+    DEFAULT_TYPE = 'custom'.freeze
+
+    def initialize(instrumenter, name = nil,
+                   type = nil, context: nil)
+      # puts "Loads transaction new initialize
+      # instrumenter, name = nil, type = nil, context: nil"
+      @id = SecureRandom.uuid
+      @instrumenter = instrumenter
+      @name = name
+      @type = type || DEFAULT_TYPE
+      @timestamp = Time.now.to_f * 1000
+
+      @spans = []
+      @span_id_ticker = -1
+      @dropped_spans = 0
+
+      @notifications = [] # for AS::Notifications
+      @context = context || Context.new
+      @exceptions = []
+
+      yield self if block_given?
+    end
+
+    attr_accessor :name, :type, :http_status
+    attr_reader :id, :context, :duration, :dropped_spans, :instrumenter
+    attr_reader :timestamp, :spans, :result, :notifications, :exceptions
+
+    def add_exception(exception)
+      @exceptions << exception
+    end
+
+    def release
+      @instrumenter.current_transaction = nil
+    end
+
+    def done(result = nil)
+      @duration = Time.now.to_f * 1000
+      @result = result
+      @http_status = result
+
+      self
+    end
+
+    def done?
+      !@duration.nil?
+    end
+
+    def submit(result = nil, status: nil, headers: {})
+      done result unless duration
+      context.response = Context::Response.new(status, headers: headers) if status
+
+      release
+      @instrumenter.submit_transaction self
+
+      self
+    end
+
+    # This method is being used in unit testing
+    def running_spans
+      spans.select(&:running?)
+    end
+
+    def span(name, type = nil, backtrace: nil, context: nil)
+      span = build_and_start_span(name, type, context, backtrace)
+      return span unless block_given?
+
+      begin
+        result = yield span
+      ensure
+        span.done
+      end
+
+      result
+    end
+
+    def current_span
+      spans.reverse.lazy.find(&:running?)
+    end
+
+    def inspect
+      "<StackifyRubyAPM::Transaction id:#{id}" \
+      " name:#{name.inspect}" \
+      " type:#{type.inspect}" \
+      '>'
+    end
+
+    private
+
+    def next_span_id
+      @span_id_ticker += 1
+    end
+
+    def next_span(name, type, context)
+      Span.new(
+        self,
+        next_span_id,
+        name,
+        type,
+        parent_id: current_span.nil? ? -1 : current_span.id,
+        context: context,
+        http_status: @http_status
+      )
+    end
+
+    def span_frames_min_duration?
+      @instrumenter.agent.config.span_frames_min_duration != 0
+    end
+
+    def build_and_start_span(name, type, context, backtrace)
+      span = next_span(name, type, context)
+      spans << span
+
+      span.original_backtrace = backtrace if backtrace && span_frames_min_duration?
+
+      span.start
+    end
+  end
+end

data/lib/{stackify → stackify_apm}/util.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This module utilizes or handles the time usage or duration of transaction
 module StackifyRubyAPM
   # @api private
@@ -7,4 +9,4 @@ module StackifyRubyAPM
     end
   end
 end
-require 'stackify/util/inspector'
+require 'stackify_apm/util/inspector'

data/lib/{stackify → stackify_apm}/util/dig.rb

@@ -28,4 +28,4 @@ if RUBY_VERSION < '2.3'
   class Hash
     include RubyDig
   end
-end
+end

data/lib/{stackify → stackify_apm}/util/inspector.rb

@@ -6,7 +6,6 @@ module StackifyRubyAPM
         @width = width
       end
 
-      # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       def transaction(transaction)
         unless transaction.done?
           raise ArgumentError, 'Transaction still running'
@@ -47,7 +46,6 @@ module StackifyRubyAPM
         puts e.backtrace.join("\n")
         nil
       end
-      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
       private
 
@@ -56,4 +54,4 @@ module StackifyRubyAPM
       end
     end
   end
-end
+end