stackify-ruby-apm 1.0.1 → 1.1.0

data/docker/stackify-ruby-test

@@ -0,0 +1,28 @@
+ARG from_version
+
+FROM stackify-ruby-${from_version}:latest
+
+ARG version
+
+RUN mkdir -p /usr/local/stackify/stackify-ruby-apm/log
+RUN mkdir /build
+COPY . /build/
+
+RUN /bin/bash --login -c "\
+    echo $version && \
+    rvm use ruby-$version && \
+    ruby -v && \
+    gem install bundler -v '~> 1.16' && \
+    gem install tzinfo-data && \
+    cd build && \
+    ls -l && \
+    bundle install \
+    "
+CMD /bin/bash --login -c "\
+        echo $version && \
+        echo ${version} && \
+        rvm use ruby-$version && \
+        ruby -v && \
+        cd build && \
+        bundle exec rspec spec/ --format documentation --fail-fast \
+        "

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

@@ -1,20 +1,21 @@
 # frozen_string_literal: true
-#
+
 # The Agent interacts with the Web Application and Profiler.
 # It is also responsible in requesting the instrumenter to build the transactions and spans.
-#
-
-require 'stackify/naively_hashable'
-require 'stackify/context_builder'
-require 'stackify/error_builder'
-require 'stackify/stacktrace_builder'
-require 'stackify/error'
-require 'stackify/trace_logger'
-require 'stackify/spies'
-require 'stackify/serializers'
-require 'stackify/worker'
+
+require 'stackify_apm/naively_hashable'
+require 'stackify_apm/context_builder'
+require 'stackify_apm/error_builder'
+require 'stackify_apm/stacktrace_builder'
+require 'stackify_apm/error'
+require 'stackify_apm/trace_logger'
+require 'stackify_apm/spies'
+require 'stackify_apm/serializers'
+require 'stackify_apm/worker'
+require 'stackify_apm/util/trace_log_watcher'
 
 module StackifyRubyAPM
+  # @api private
   class Agent
     include Log
 
@@ -24,24 +25,29 @@ module StackifyRubyAPM
       @instance
     end
 
+    # rubocop:disable Metrics/CyclomaticComplexity
     def self.start(config)
       return @instance if @instance
+
       config = Config.new(config) unless config.is_a?(Config)
       pid = $PID || Process.pid
       host_name = config.hostname || `hostname`
       date_now = Time.now
-      current_trace_file = config.log_trace_path + host_name.squish! + "#" + pid.to_s.squish! + ".log"
+      current_trace_file = config.log_trace_path + squish(host_name) + '#' + squish(pid.to_s) + '.log'
 
-      if(ENV['STACKIFY_RUBY_ENV'] != 'rspec')
+      if ENV['STACKIFY_RUBY_ENV'] != 'rspec'
         config.tracer_logger = StackifyLogger.new(current_trace_file, config.filenum_rotate, config.logger_byte_size)
-        config.logtime_created =  date_now.strftime("%H:%M")
-      end  
-      
+        config.logtime_created = date_now.strftime('%H:%M')
+        Util::TraceLogWatcher.delete_trace_logs(config)
+      end
+
       LOCK.synchronize do
         return @instance if @instance
+
         @instance = new(config).start
       end
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def self.stop
       LOCK.synchronize do
@@ -59,7 +65,7 @@ module StackifyRubyAPM
     end
 
     def self.running?
-      !!@instance
+      !@instance.nil?
     end
 
     def initialize(config)
@@ -89,14 +95,13 @@ module StackifyRubyAPM
       spies_name = ''
       config.enabled_spies.each do |lib|
         spies_name = spies_name + ', ' + lib.inspect.to_s
-        require "stackify/spies/#{lib}"
+        require "stackify_apm/spies/#{lib}"
       end
       debug '[Agent] Loaded spies:' + spies_name
       self
     end
 
     # queues
-
     # Stores transaction in queue
     #
     def enqueue_transaction(transaction)
@@ -151,11 +156,8 @@ module StackifyRubyAPM
         exception,
         handled: handled
       )
-      current_error =  @error_serializer.build(error)
-      if current_transaction
-        current_transaction.add_exception(current_error)
-      end
-
+      current_error = @error_serializer.build(error)
+      current_transaction.add_exception(current_error) if current_transaction
     end
 
     def report_message(message, backtrace: nil, **attrs)
@@ -167,6 +169,16 @@ module StackifyRubyAPM
       enqueue_error error
     end
 
+    # This method will strip and remove garbage character and multiple spaces.
+
+    def self.squish(str)
+      str = str.gsub(/\A[[:space:]]+/, '')
+      str = str.gsub(/[[:space:]]+\z/, '')
+      str = str.gsub(/[[:space:]]+/, ' ')
+      str = str.strip.gsub(/\s+/, '')
+      str
+    end
+
     private
 
     def boot_worker
@@ -174,20 +186,17 @@ module StackifyRubyAPM
 
       @worker_thread = Thread.new do
         Worker.new(
-            config,
-            messages,
-            pending_transactions,
-            trace_logger
+          config,
+          messages,
+          pending_transactions,
+          trace_logger
         ).run_forever
       end
     end
 
     def kill_worker
       messages << Worker::StopMsg.new
-
-      if @worker_thread && !@worker_thread.join(5) # 5 secs
-        raise 'Failed to wait for worker, not all messages sent'
-      end
+      raise 'Failed to wait for worker, not all messages sent' if @worker_thread && !@worker_thread.join(5) # 5 secs
 
       @worker_thread = nil
     end

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # The Config class sets the APM's default values.
 #
@@ -7,7 +8,6 @@ require 'logger'
 require 'yaml'
 require 'socket'
 module StackifyRubyAPM
-  # rubocop:disable Metrics/ClassLength
   # @api private
   class Config
     include Log
@@ -15,26 +15,26 @@ module StackifyRubyAPM
       config_file: 'config/stackify_apm.yml',
       environment_name: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
       instrument: true,
-
       log_path: '/usr/local/stackify/stackify-ruby-apm/log/stackify-ruby-apm.log',
       log_level: Logger::INFO,
-
       log_trace_path: '/usr/local/stackify/stackify-ruby-apm/log/',
 
       max_queue_size: 500, # Maximum queue length of transactions before sending transactions to the APM.
       flush_interval: 1, # interval with which transactions should be sent to the APM. Default value: 10 seconds
-      
+
       filter_exception_types: [],
-      
+
       tracer_logger: nil,
-      logger_byte_size: 50000000,
+      logger_byte_size: 50_000_000, # e.g, 50_000_000=50mb
       filenum_rotate: 20,
-      debugger_byte_size: 20000000,
+      debugger_byte_size: 20_000_000,
       debugger_filenum_rotate: 3,
       logtime_created: 0,
       http_status: nil,
       debug_transactions: false,
-      
+      trace_log_age_in_hour: 60 * 60, # e.g, 60*60=1hour, 60*2=2mins
+      check_trace_log_per_hour: '1h', # e.g, 1h=every 1hour, 2m=every 2mins
+
       source_lines_error_app_frames: 5,
       source_lines_span_app_frames: 5,
       source_lines_error_library_frames: 0,
@@ -94,6 +94,8 @@ module StackifyRubyAPM
     attr_accessor :filenum_rotate
     attr_accessor :debugger_byte_size
     attr_accessor :debugger_filenum_rotate
+    attr_accessor :trace_log_age_in_hour
+    attr_accessor :check_trace_log_per_hour
 
     attr_accessor :tracer_logger
     attr_accessor :logtime_created
@@ -118,8 +120,8 @@ module StackifyRubyAPM
     attr_accessor :root_path
     attr_accessor :http_status
 
-    attr_reader :clientId
-    attr_reader :deviceId
+    attr_reader :client_id
+    attr_reader :device_id
 
     def app=(app)
       case app_type?(app)
@@ -132,13 +134,15 @@ module StackifyRubyAPM
     end
 
     def app_type?(app)
-      if defined?(::Rails) && app.is_a?(Rails::Application)
-        return :rails
-      end
+      # if defined?(::Rails) && app.is_a?(Rails::Application)
+      #   return :rails
+      # end
+
+      return :rails if defined?(::Rails) && app.is_a?(Rails::Application)
+
       nil
     end
 
-   # rubocop:disable Metrics/MethodLength
     # available spies to use when framework is rails
     def available_spies
       %w[
@@ -147,26 +151,35 @@ module StackifyRubyAPM
         net_http
         httpclient
         redis
+        sequel
         tilt
         httprb
+        curb
+        curb/easy
+        curb/multi
+        stackify_logger
       ]
     end
-    # rubocop:enable Metrics/MethodLength
 
     def enabled_spies
       # check if the framework is rails or sinatra
-      sinatra_spies = %w[
+      sinatra_activerecord_spies = %w[
         sinatra
         sinatra_activerecord/mysql_adapter
         sinatra_activerecord/postgresql_adapter
         sinatra_activerecord/sqlite_adapter
       ]
-      if (defined?(::Sinatra::Base))
-        new_available_spies = available_spies + sinatra_spies
-      else
-        new_available_spies = available_spies
-      end  
-      
+
+      new_available_spies = if defined? ::Sinatra::Base
+                              if defined? ActiveRecord
+                                available_spies + sinatra_activerecord_spies
+                              else
+                                available_spies
+                              end
+                            else
+                              available_spies
+                            end
+
       new_available_spies - disabled_spies
     end
 
@@ -182,7 +195,7 @@ module StackifyRubyAPM
       assign(DEFAULTS)
     end
 
-    # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
     def set_from_env
       ENV_TO_KEY.each do |env_key, key|
         next unless (value = ENV[env_key])
@@ -201,30 +214,35 @@ module StackifyRubyAPM
         send("#{key}=", value)
       end
     end
-    # rubocop:enable Metrics/MethodLength, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
 
+    # rubocop:disable Naming/AccessorMethodName
     def set_from_args(options)
       assign(options)
     end
+    # rubocop:enable Naming/AccessorMethodName
 
     def set_from_config_file
       return unless File.exist?(config_file)
+
       assign(YAML.load_file(config_file) || {})
     end
 
-    def set_rails(app) # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Naming/AccessorMethodName
+    def set_rails(app)
       self.application_name ||= format_name(application_name || app.class.parent_name)
       self.logger ||= Rails.logger
 
       self.root_path = Rails.root.to_s
       self.view_paths = app.config.paths['app/views'].existent
     end
+    # rubocop:enable Naming/AccessorMethodName
 
     def build_logger
       debuger_logpath = log_path == '-' ? $stdout : log_path
       logger = StackifyLogger.new(debuger_logpath, debugger_filenum_rotate, debugger_byte_size)
       logger.level = log_level
-       self.logger = logger
+      self.logger = logger
     end
 
     def format_name(str)
@@ -232,26 +250,25 @@ module StackifyRubyAPM
     end
 
     def load_stackify_props
-      @clientId = nil
-      @deviceId = nil
+      @client_id = nil
+      @device_id = nil
       begin
-        warn "Reading the stackify.properties file"
-        IO.foreach(@stackify_properties_file) { |line|
+        info 'Reading the stackify.properties file'
+        IO.foreach(@stackify_properties_file) do |line|
           case line.downcase
           when /clientid=\d+/
-            @clientId = line.split('=')[1].strip
+            @client_id = line.split('=')[1].strip
           when /deviceid=\d+/
-            @deviceId = line.split('=')[1].strip
+            @device_id = line.split('=')[1].strip
           end
-        }
-        warn "stackify.properties: clientId=#{@clientId}, deviceId=#{@deviceId}"
+        end
+        info "stackify.properties: clientId=#{@client_id}, deviceId=#{@device_id}"
       rescue StandardError => e
-        warn "Error occured while reading the stackify.properties file."
-        warn e.inspect
+        info 'Error occured while reading the stackify.properties file.'
+        info e.inspect
       end
-      warn "No clientId found from stackify.properties file." if @clientId.nil?
-      warn "No deviceId found from stackify.properties file." if @deviceId.nil?
+      info 'No clientId found from stackify.properties file.' if @client_id.nil?
+      info 'No deviceId found from stackify.properties file.' if @device_id.nil?
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

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

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
-#
+
 # This class initializes the parameters and variables for the context of Transaction/Span
-#
 
-require 'stackify/context/request'
-require 'stackify/context/request/socket'
-require 'stackify/context/request/url'
-require 'stackify/context/response'
+require 'stackify_apm/context/request'
+require 'stackify_apm/context/request/socket'
+require 'stackify_apm/context/request/url'
+require 'stackify_apm/context/response'
 
 module StackifyRubyAPM
   # @api private

data/lib/{stackify → stackify_apm}/context/request/url.rb

@@ -25,17 +25,13 @@ module StackifyRubyAPM
         end
 
         attr_reader :protocol, :hostname, :port, :pathname, :search, :hash,
-          :full
+                    :full
 
         private
 
         def build_full_url(req)
           url = "#{req.scheme}://#{req.host}"
-
-          if req.port != SKIPPED_PORTS[req.scheme]
-            url += ":#{req.port}"
-          end
-
+          url += ":#{req.port}" if req.port != SKIPPED_PORTS[req.scheme]
           url + req.fullpath
         end
       end

data/lib/stackify_apm/context/response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module StackifyRubyAPM
+  class Context
+    # @api private
+    class Response
+      include NaivelyHashable
+
+      def initialize(
+        status_code,
+        headers: {},
+        headers_sent: true,
+        finished: true
+      )
+        @status_code = status_code
+        headers = make_xstackify_id_header(headers)
+        @headers = headers
+        @headers_sent = headers_sent
+        @finished = finished
+      end
+
+      attr_accessor :status_code, :headers, :headers_sent, :finished
+
+      def make_xstackify_id_header(headers)
+        return unless StackifyRubyAPM.agent.current_transaction && StackifyRubyAPM.agent.current_transaction.id
+        transaction_id = StackifyRubyAPM.agent.current_transaction.id
+        client_id = StackifyRubyAPM.agent.config.client_id
+        device_id = StackifyRubyAPM.agent.config.device_id
+        headers['X-StackifyID'] = "V1|#{transaction_id}|C#{client_id}|CD#{device_id}" if client_id && device_id
+      end
+    end
+  end
+end