stackify-ruby-apm 0.9.0 → 1.0.0

data/lib/stackify/spies/sinatra_activerecord/postgresql_adapter.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+# Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
+#
+module StackifyRubyAPM
+    # @api private
+    module Spies
+      # @api private
+      class PostgresqlAdapterSpy
+        TYPE = 'db.sinatra_active_record.sql'.freeze
+  
+        # rubocop:disable Metrics/MethodLength
+        def install
+          ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements.class_eval do
+            alias exec_query_without_apm exec_query
+            alias exec_delete_without_apm exec_delete
+            alias exec_update_without_apm exec_update
+            
+            def exec_update(sql, name = nil, binds = [])
+              result = nil
+  
+              unless StackifyRubyAPM.current_transaction
+                exec_update_without_apm(sql, name, binds)
+              end
+  
+              ctx = Span::Context.new(
+                CATEGORY: 'Database',
+                SUBCATEGORY: 'Execute',
+                COMPONENT_CATEGORY: 'DB Query',
+                COMPONENT_DETAIL: 'Execute SQL Query',
+                SQL: sql,
+                PROVIDER: "mysql"
+              )
+              
+              result = exec_update_without_apm(sql, name, binds)
+  
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+            
+            def exec_delete(sql, name = nil, binds = [])
+              result = nil
+  
+              unless StackifyRubyAPM.current_transaction
+                exec_delete_without_apm(sql, name, binds)
+              end
+  
+              ctx = Span::Context.new(
+                CATEGORY: 'Database',
+                SUBCATEGORY: 'Execute',
+                COMPONENT_CATEGORY: 'DB Query',
+                COMPONENT_DETAIL: 'Execute SQL Query',
+                SQL: sql,
+                PROVIDER: "postgresql"
+              )
+              
+              result = exec_delete_without_apm(sql, name, binds)
+  
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+            
+            
+            def exec_query(sql, name = "SQL", binds = [], prepare: false)
+              result = nil
+  
+              unless StackifyRubyAPM.current_transaction
+                exec_query_without_apm(sql, name, binds)
+              end
+  
+              ctx = Span::Context.new(
+                CATEGORY: 'Database',
+                SUBCATEGORY: 'Execute',
+                COMPONENT_CATEGORY: 'DB Query',
+                COMPONENT_DETAIL: 'Execute SQL Query',
+                SQL: sql,
+                PROVIDER: "postgresql"
+              )
+              
+              result = exec_query_without_apm(sql, name, binds)
+  
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+  
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+  
+      register 'ActiveRecord::ConnectionAdapters::PostgreSQL::DatabaseStatements', 'active_record/connection_adapters/postgresql/database_statements', PostgresqlAdapterSpy.new
+    end
+  end
+  

data/lib/stackify/spies/sinatra_activerecord/sqlite_adapter.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# Spies for active record when sinatra framework is used and active_record is being extended. (mysql adapter)
+#
+module StackifyRubyAPM
+    # @api private
+    module Spies
+      # @api private
+      class SqliteAdapterSpy
+        TYPE = 'db.sinatra_active_record.sql'.freeze
+  
+        # rubocop:disable Metrics/MethodLength
+        def install
+          ActiveRecord::ConnectionAdapters::SQLite3Adapter.class_eval do
+            alias exec_query_without_apm exec_query
+            
+            
+            def exec_query(sql, name = "SQL", binds = [], prepare: false)
+              result = nil
+  
+              unless StackifyRubyAPM.current_transaction
+                exec_query_without_apm(sql, name, binds)
+              end
+  
+              ctx = Span::Context.new(
+                CATEGORY: 'Database',
+                SUBCATEGORY: 'Execute',
+                COMPONENT_CATEGORY: 'DB Query',
+                COMPONENT_DETAIL: 'Execute SQL Query',
+                SQL: sql,
+                PROVIDER: "sqlite"
+              )
+              
+              result = exec_query_without_apm(sql, name, binds)
+  
+              StackifyRubyAPM.span name, TYPE, context: ctx do
+                return result
+              end
+            end
+  
+          end
+        end
+        # rubocop:enable Metrics/MethodLength
+      end
+  
+      register 'ActiveRecord::ConnectionAdapters::SQLite3Adapter', 'active_record/connection_adapters/sqlite3_adapter', SqliteAdapterSpy.new
+    end
+  end
+  

data/lib/stackify/spies/tilt.rb

@@ -1,11 +1,14 @@
 # frozen_string_literal: true
+#
+# Monkey patch for the Tilt::Template class on template rendering and span creation.
+#
 
 module StackifyRubyAPM
   # @api private
   module Spies
     # @api private
     class TiltSpy
-      # This class monkeypatch the Tilt::Template class with render method.
+
       TYPE = 'template.tilt'.freeze
 
       def install
@@ -15,6 +18,8 @@ module StackifyRubyAPM
           def render(*args, &block)
             name = options[:__stackify_apm_template_name] || 'Unknown template'
 
+            # Creates new span for Tilt templating
+            #
             StackifyRubyAPM.span name, TYPE do
               render_without_apm(*args, &block)
             end
@@ -23,6 +28,8 @@ module StackifyRubyAPM
       end
     end
 
+    # Registers Tilt spy, go to: /stackify/spies.rb
+    #
     register 'Tilt::Template', 'tilt/template', TiltSpy.new
   end
 end

data/lib/stackify/stacktrace_builder.rb

@@ -21,7 +21,7 @@ module StackifyRubyAPM
 
     attr_reader :config
 
-    def build(backtrace, type:)
+    def build(backtrace, type)
       Stacktrace.new.tap do |s|
         s.frames = backtrace.map do |line|
           @cache[[line, type]]
@@ -36,6 +36,7 @@ module StackifyRubyAPM
       line, type = keys
       abs_path, lineno, function, _module_name = parse_line(line)
       current_filename = strip_load_path(abs_path)
+      library_frame = library_frame?(config, abs_path)
 
       frame = Stacktrace::Frame.new
       #frame.abs_path = abs_path
@@ -45,7 +46,7 @@ module StackifyRubyAPM
       #frame.library_frame = library_frame?(config, abs_path)
 
       line_count =
-        context_lines_for(config, type, library_frame: frame.library_frame)
+        context_lines_for(config, type, library_frame)
       frame.build_context line_count
 
       cache[[line, type]] = frame
@@ -93,7 +94,7 @@ module StackifyRubyAPM
       prefix ? path[prefix.chomp(File::SEPARATOR).length + 1..-1] : path
     end
 
-    def context_lines_for(config, type, library_frame:)
+    def context_lines_for(config, type, library_frame)
       key = "source_lines_#{type}_#{library_frame ? 'library' : 'app'}_frames"
       config.send(key.to_sym)
     end

data/lib/stackify/subscriber.rb

@@ -13,7 +13,7 @@ module StackifyRubyAPM
     include Log
 
     def initialize(agent)
-      debug '@stackify_ruby [Subscriber] [lib/subscriber.rb] initialize()'
+      debug '[Subscriber] initialize()'
       debug agent.inspect
       @agent = agent
       @normalizers = Normalizers.build(agent.config)
@@ -38,7 +38,7 @@ module StackifyRubyAPM
     # [call] Called when the rails version is 3.x
     def call(name, started, finished, id, payload)
       return unless (transaction = @agent.current_transaction)
-      debug '@stackify_ruby [Subscriber] [lib/subscriber.rb] call():'
+      debug '[Subscriber] call():'
       debug id
       debug name
       debug transaction
@@ -71,7 +71,7 @@ module StackifyRubyAPM
     # [start] Called when the rails version is NOT 3.x
     def start(name, id, payload)
       return unless (transaction = @agent.current_transaction)
-        debug '@stackify_ruby [Subscriber] [lib/subscriber.rb] start():'
+        debug '[Subscriber] start():'
         debug id
         debug name
         debug transaction
@@ -91,7 +91,7 @@ module StackifyRubyAPM
     # [finish] Called when the rails version is NOT 3.x
     def finish(_name, id, _payload)
       # debug "AS::Notification#finish:#{name}:#{id}"
-      debug '@stackify_ruby [Subscriber] [lib/subscriber.rb] finish():'
+      debug '[Subscriber] finish():'
       return unless (transaction = @agent.current_transaction)
 
       while (notification = transaction.notifications.pop)

data/lib/stackify/trace_logger.rb

@@ -22,7 +22,7 @@ module StackifyRubyAPM
     attr_accessor :trace_file_counter, :process_id
 
     def post(transactions = [])
-
+  
       # convert transactions to json
       json_traces = []
       transactions.each  do |transaction|
@@ -36,31 +36,14 @@ module StackifyRubyAPM
       pid = $PID || Process.pid
       host_name = @config.hostname || `hostname`
       date_now = Time.now
-      current_time = date_now.strftime("%Y-%m-%d, %H:%M:%S.%6N")
-      trace_path = @config.log_trace_path
-      trace_file_result = @config.check_lastlog_needs_new(trace_path)
-      current_trace_file = trace_file_result['latest_file']
-
-      if trace_file_result['new_flagger'] == true
-        @trace_file_counter = @trace_file_counter + 1
-        file_ctr = @trace_file_counter
-        current_trace_file = trace_path + host_name + "#" + pid.to_s + "-" + file_ctr.to_s + ".log"
-      else
-        if @process_id != pid
-          @trace_file_counter = 1
-          @process_id = pid
-          file_ctr = @trace_file_counter
-          current_trace_file = trace_path + host_name + "#" + pid.to_s + "-" + file_ctr.to_s + ".log"
-        end
-      end
+      current_datetime = date_now.strftime("%Y-%m-%d, %H:%M:%S.%6N")
 
-      current_trace_file = current_trace_file.gsub(/[[:space:]]/, '')
-      open(current_trace_file, 'a') {|f|
+      if(ENV['STACKIFY_RUBY_ENV'] != 'rspec')
         json_traces.each do |json_trace|
-          f.puts current_time + "> " + json_trace + "\n"
+          update_json = current_datetime + " > " + json_trace + "\n"
+          @config.tracer_logger.<<(update_json)
         end
-      }
-
+      end
     end
   end
 end

data/lib/stackify/transaction.rb

@@ -24,6 +24,7 @@ module StackifyRubyAPM
 
           @notifications = [] # for AS::Notifications
           @context = context || Context.new
+          @exceptions = []
 
           yield self if block_given?
         end
@@ -31,7 +32,11 @@ module StackifyRubyAPM
 
         attr_accessor :name, :type, :http_status
         attr_reader :id, :context, :duration, :dropped_spans,
-            :timestamp, :spans, :result, :notifications, :instrumenter
+            :timestamp, :spans, :result, :notifications, :instrumenter, :exceptions
+
+        def add_exception exception
+          @exceptions << exception
+        end
 
         def release
           @instrumenter.current_transaction = nil
@@ -60,6 +65,10 @@ module StackifyRubyAPM
 
           self
         end
+        # This method is being used in unit testing
+        def running_spans
+          spans.select(&:running?)
+        end
         # rubocop:disable Metrics/MethodLength
         def span name, type = nil, backtrace: nil, context: nil
           span = build_and_start_span(name, type, context, backtrace)

data/lib/stackify/util.rb

@@ -2,22 +2,9 @@
 module StackifyRubyAPM
   # @api private
   module Util
-    def self.nearest_minute(target = Time.now.utc)
-      target - target.to_i % 60
-    end
-
     def self.micros(target = Time.now.utc)
       target.to_i * 1_000_000 + target.usec
     end
-
-    def self.inspect_transaction(transaction)
-      Inspector.new.transaction transaction
-    end
-
-    def self.git_sha
-      sha = `git rev-parse --verify HEAD 2>&1`.chomp
-      $? && $?.success? ? sha : nil # rubocop:disable Style/SpecialGlobalVars
-    end
   end
 end
 require 'stackify/util/inspector'

data/lib/stackify/version.rb

@@ -1,4 +1,4 @@
 # Sets the version of the APM
 module StackifyRubyAPM
-  VERSION = '0.9.0'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/stackify/worker.rb

@@ -83,13 +83,13 @@ module StackifyRubyAPM
     def collect_and_send_transactions
       return if pending_transactions.empty?
       transactions = collect_batched_transactions
-      debug '@stackify_ruby [lib/worker.rb] Successfully collect and send transaction to the to trace logger.'
+      debug '[Worker] Successfully collect and send transaction to the to trace logger.'
       begin
         @trace_logger.post(transactions)
       rescue ::Exception => e
-        debug 'Failed posting: '
-        debug e.inspect
-        debug e.backtrace.join("\n")
+        error '[Worker] Collect_and_send_transactions error:'
+        error e.inspect
+        error e.backtrace.join("\n")
         nil
       end
     end
@@ -98,7 +98,7 @@ module StackifyRubyAPM
       return if pending_transactions.empty?
       transactions = collect_batched_transactions
       payload = @serializers.errors.build_all([msg.error])
-      debug '@stackify_ruby [lib/worker.rb] error'
+      debug '[Worker] post_error()'
       # @trace_logger.post(payload, transactions[0])
     end
 

data/lib/stackify_ruby_apm.rb

@@ -15,10 +15,10 @@
 require 'stackify/log'
 require 'stackify/version'
 require 'stackify/util/dig'
-
 require 'stackify/agent'
+# Checks ruby version
+require (RUBY_VERSION.to_f >= 2.4) ? 'stackify/logger/logger_high_version' : 'stackify/logger/logger_lower_version'
 require 'stackify/config'
-require 'stackify/logger'
 require 'stackify/context'
 require 'stackify/instrumenter'
 require 'stackify/internal_error'
@@ -35,8 +35,6 @@ module StackifyRubyAPM
   # @param config [Config] An instance of Config
   # @return [Agent] The resulting [Agent]
   def self.start(config = {})
-    # debug "Starts the StackifyRubyAPM Agent self.start()"
-
     Agent.start config
   end
 
@@ -73,7 +71,6 @@ module StackifyRubyAPM
   # @yield [Transaction] Optional block encapsulating transaction
   # @return [Transaction] Unless block given
   def self.transaction(name = nil, type = nil, context: nil, &block)
-    # debug "@stackify_ruby [lib/stackify_ruby_apm.rb] loads self.transaction(name = nil, type = nil, context: nil, &block)"
     return (block_given? ? yield : nil) unless agent
 
     agent.transaction(name, type, context: context, &block)
@@ -105,7 +102,6 @@ module StackifyRubyAPM
   # @param rack_env [Rack::Env] A Rack env
   # @return [Context] The built context
   def self.build_context(rack_env)
-    # debug "@stackify_ruby [lib/stackify_ruby_apm.rb] self.build_context(rack_env)"
     agent && agent.build_context(rack_env)
   end
 

data/run-test.sh

@@ -0,0 +1,75 @@
+#!/bin/bash
+
+function startContainers() {
+  echo "Starting up containers..."
+  docker-compose up -d -V --remove-orphans --force-recreate
+}
+
+function waitForContainers() {
+  echo 'Waiting for container startup 10s...'
+  sleep 5
+  echo 'Waiting for container startup 5s...'
+  sleep 5
+}
+
+function stopContainers() {
+  echo "Stopping Containers..."
+  docker-compose down --remove-orphans
+
+  # delete volumes
+  echo "Delete Volumes..."
+  docker volume rm  stackify-ruby-apm_postgresdata &> /dev/null
+  docker volume rm  stackify-ruby-apm_mysqldata &> /dev/null
+  docker volume rm  stackify-ruby-apm_mongodata &> /dev/null
+  docker volume rm  stackify-ruby-apm_mongodata_config &> /dev/null
+  echo "Deleted Volumes"
+}
+
+function rspec_on_multiple_versions(){
+  # test against multiple ruby versions
+  set -e
+
+  RUBY_VERSIONS=('2.0.0-p648' '2.1.10' '2.2.10' '2.3.7' '2.4.0' '2.5.1' '2.6.0-preview3')
+  # BUNDLER ERROR
+  # '2.0.0-p648' 2.1.10
+
+  for ver in "${RUBY_VERSIONS[@]}"
+  do
+    if ! rbenv versions | grep -w $ver; then
+      # remove stale rbenv shim before rehashing
+      SHIM=/home/$USER/.rbenv/shims/.rbenv-shim
+      if [ -f $SHIM ]; then
+        rm $SHIM
+      fi
+
+      rbenv install --verbose $ver
+      rbenv rehash
+      rbenv local $ver
+      gem install bundler -v '~> 1.16'
+    fi
+
+    rbenv local $ver
+    rbenv exec bundle update
+
+    echo "====================================================="
+    echo "$ver: Start Test"
+    echo "====================================================="
+
+    if ! bundle exec rspec spec/ --format documentation --fail-fast; then
+      echo ">>>Unit Test Error on Version: $ver<<<"
+      stopContainers
+      exit 1
+    else 
+      echo "====================================================="
+      echo "$ver: End Test"
+      echo "====================================================="
+    fi
+  done
+}
+
+
+startContainers
+waitForContainers
+
+rspec_on_multiple_versions
+stopContainers