stackify-ruby-apm 1.14.8 → 1.16.0.beta1

data/lib/stackify_apm/spies/sequel.rb

@@ -29,8 +29,8 @@ module StackifyRubyAPM
         ::Sequel::Database.class_eval do
           alias_method 'log_connection_yield_without_apm', 'log_connection_yield'
 
-          def log_connection_yield(sql, *args, &block)
-            return log_connection_yield_without_apm(sql, *args, &block) unless StackifyRubyAPM.current_transaction
+          def log_connection_yield(sql, *args, **kwargs, &block)
+            return log_connection_yield_without_apm(sql, *args, **kwargs, &block) unless StackifyRubyAPM.current_transaction
 
             name = summarize sql
             db_adapter = ''

data/lib/stackify_apm/spies/sidekiq.rb

@@ -12,7 +12,7 @@ module StackifyRubyAPM
         Sidekiq::Processor.class_eval do
           alias_method 'process_without_apm', 'process'
 
-          def process(work, *args, &block)
+          def process(work, *args, **kwargs, &block)
             ret = nil
             begin
               job = nil
@@ -24,7 +24,7 @@ module StackifyRubyAPM
               job_hash = JSON.parse job
               name = job_hash["class"]
               transaction = StackifyRubyAPM.transaction name, 'TASK'
-              ret = process_without_apm(work, *args, &block)
+              ret = process_without_apm(work, *args, **kwargs, &block)
             rescue StackifyRubyAPM::InternalError
               raise # Don't report StackifyRubyAPM errors
             rescue StandardError => e

data/lib/stackify_apm/spies/sinatra.rb

@@ -11,11 +11,12 @@ module StackifyRubyAPM
         ::Sinatra::Base.class_eval do
           alias_method 'dispatch_without_apm!', 'dispatch!'
           alias_method 'compile_template_without_apm', 'compile_template'
+          alias_method 'route_eval_without_apm', 'route_eval'
 
           # Sets transaction name from Sinatra env's route name
           #
-          def dispatch!(*args, &block)
-            dispatch_without_apm!(*args, &block).tap do
+          def dispatch!(*args, **kwargs, &block)
+            dispatch_without_apm!(*args, **kwargs, &block).tap do
               next unless (transaction = StackifyRubyAPM.current_transaction)
               next unless (route = env['sinatra.route'])
 
@@ -25,14 +26,23 @@ module StackifyRubyAPM
 
           # Tilt engine template
           #
-          def compile_template(engine, data, opts, *args, &block)
+          def compile_template(engine, data, opts, *args, **kwargs, &block)
             opts[:__stackify_apm_template_name] =
               case data
               when Symbol then data.to_s
               else format('Inline %s', engine)
               end
 
-            compile_template_without_apm(engine, data, opts, *args, &block)
+            compile_template_without_apm(engine, data, opts, *args, **kwargs, &block)
+          end
+
+          def route_eval(*args, **kwargs, &block)
+            if defined?(StackifyRubyAPM.current_transaction)
+              if env.key?('sinatra.route')
+                StackifyRubyAPM.current_transaction.name = env['sinatra.route']
+              end
+            end
+            route_eval_without_apm(*args, **kwargs, &block)
           end
         end
       end

data/lib/stackify_apm/spies/sucker_punch.rb

@@ -12,14 +12,14 @@ module StackifyRubyAPM
         SuckerPunch::Job::ClassMethods.class_eval do
           alias_method '__run_perform_without_elastic_apm', '__run_perform'
 
-          def __run_perform(*args)
+          def __run_perform(*args, **kwargs)
             ret = nil
             begin
               name = "#{to_s}.perform"
               ctx = StackifyRubyAPM::Context.new
               ctx.category = 'SuckerPunch::Job'
               transaction = StackifyRubyAPM.transaction name, 'TASK', context: ctx
-              ret = __run_perform_without_elastic_apm(*args)
+              ret = __run_perform_without_elastic_apm(*args, **kwargs)
             rescue StackifyRubyAPM::InternalError
               raise # Don't report StackifyRubyAPM errors
             rescue StandardError => e

data/lib/stackify_apm/spies/tilt.rb

@@ -15,13 +15,13 @@ module StackifyRubyAPM
         ::Tilt::Template.class_eval do
           alias_method 'render_without_apm', 'render'
 
-          def render(*args, &block)
+          def render(*args, **kwargs, &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)
+              render_without_apm(*args, **kwargs, &block)
             end
           end
         end

data/lib/stackify_apm/util.rb

@@ -35,6 +35,92 @@ module StackifyRubyAPM
       obj[i] = val.to_s
       ary.push(obj)
     end
+
+    URL_ID_REGEX = /^(\d+)$/
+    URL_GUID_REGEX = /^(?i)(\b[A-F0-9]{8}(?:-[A-F0-9]{4}){3}-[A-F0-9]{12}\b)$/
+    URL_EMAIL_REGEX = /^((([!#$%&'*+\-\/=?^_`{|}~\w])|([!#$%&'*+\-\/=?^_`{|}~\w][!#$%&'*+\-\/=?^_`{|}~\.\w]{0,}[!#$%&'*+\-\/=?^_`{|}~\w]))[@]\w+([-.]\w+)*\.\w+([-.]\w+)*)$/
+    URL_IP_REGEX = /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/
+
+    def self.maskReportingUrl(url)
+      parts = url.split('/', -1)
+
+      if (!parts.length)
+        return '/'
+      end
+
+      maskedParts = []
+      parts.each do |part|
+        maskedParts.push(maskString(part))
+      end
+
+      maskedUrl = maskedParts.join('/')
+
+      if (maskedUrl.length == 1)
+        return maskedUrl
+      end
+
+      if maskedUrl.end_with?('/')
+        trimmedUrl = maskedUrl.slice(0, maskedUrl.length-1)
+        if (!trimmedUrl.length)
+          return '/'
+        end
+
+        return trimmedUrl
+      end
+
+      maskedUrl
+    end
+
+    def self.maskString(string)
+      return '{id}' if string =~ URL_ID_REGEX
+      return '{guid}' if string =~ URL_GUID_REGEX
+      return '{email}' if string =~ URL_EMAIL_REGEX
+      return '{ip}' if string =~ URL_IP_REGEX
+
+      if string.include? ';'
+        string_index = string.index(';');
+        return '' if (string_index <= 0)
+        return string[0..string.index(';')-1]  if (string_index)
+      end
+
+      # Default
+      string
+    end
+
+    def self.fileExists?(dir_name)
+      # Ruby 3.2 changed File.exists to File.exist.
+      if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3.2")
+        return File.exists?(dir_name)
+      else
+        return File.exist?(dir_name)
+      end
+    end
+
+    def self.checkOrCreateFolder(dir_name)
+      if (dir_name.to_s.empty?)
+        return false
+      end
+
+      if (!fileExists?(dir_name))
+        umask = File.umask
+        File.umask(0)
+        FileUtils.mkdir_p(dir_name)
+        File.chmod(0777, dir_name)
+        File.umask(umask)
+      end
+
+      if (!fileExists?(dir_name))
+        puts "Util::Stackify Profiler unable to find [" + dir_name + "]"
+        return false
+      end
+
+      if (!File.writable?(dir_name))
+        puts "Util::Stackify Profiler unable to access/write [" + dir_name + "]"
+        return false
+      end
+
+      return true
+    end
   end
 end
 require 'stackify_apm/util/inspector'

data/lib/stackify_apm/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Sets the version of the APM
+# Sets the version of the APM:
 module StackifyRubyAPM
-  VERSION = '1.14.8'.freeze
+  VERSION = '1.16.0.beta1'.freeze
 end

data/lib/stackify_ruby_apm.rb

@@ -50,22 +50,67 @@ module StackifyRubyAPM
   end
 
   def self.inject_rum_script
-    config = StackifyRubyAPM::Config.new
-    client_id = config.client_id
-    device_id = config.device_id
-    client_rundomain = config.client_run_domain
-    transaction_id = defined?(StackifyRubyAPM.current_transaction.id) ? StackifyRubyAPM.current_transaction.id : nil
+    transaction = defined?(StackifyRubyAPM.current_transaction) ? StackifyRubyAPM.current_transaction : nil
+    return '' unless transaction
+
+    transaction_id = defined?(transaction.id) ? transaction.id : nil
     inject_flag = false
 
-    if client_id && device_id
-      inject_flag = true if check_isdomain(client_rundomain)
+    config = nil
+    if defined?(agent.config)
+      config = agent.config
+    end
+
+    return '' unless config
+
+    if transaction_id
+      inject_flag = true
+    end
+
+    return '' unless inject_flag
+
+    return '' if config.rum_script_url.to_s.empty? || config.rum_key.to_s.empty?
+
+    rum_settings = {
+      "ID" => transaction_id
+    }
+
+    if defined?(config.environment_name)
+      environment_name = 'Development'
+      if !config.environment_name.to_s.empty?
+        environment_name = config.environment_name
+      end
+
+      rum_settings["Env"] = Base64.strict_encode64(environment_name.encode('utf-8'))
+    end
+
+    application_name = config.application_name
+    return '' if application_name.to_s.empty?
+
+    rum_settings["Name"] = Base64.strict_encode64(application_name.strip.encode('utf-8'))
+
+    if defined?(transaction.name) && !transaction.name.to_s.empty?
+      reporting_url = Util.maskReportingUrl(transaction.name)
+
+      if defined?(transaction.context.request.method) && !transaction.context.request.nil? && !transaction.context.request.method.nil?
+        reporting_url = "#{transaction.context.request.method}-#{reporting_url}"
+      end
+
+      rum_settings["Trans"] = Base64.strict_encode64(reporting_url.encode('utf-8'))
     end
 
-    return unless inject_flag
-    data_request_id = "V2|#{transaction_id}|#{client_id}|#{device_id}"
     @rum_script_injected = true
-    "<script src=\"#{config.rum_script_src}\" data-host=\"#{client_rundomain}\" data-requestId=\"#{data_request_id}\"
-    data-a=\"#{config.application_name}\" data-e=\"#{config.environment_name}\" data-enableInternalLogging=\"#{config.debug_logging}\" type=\"text/javascript\" async></script>"
+
+    if defined?(transaction.context)
+      transaction.context.rum = true
+    end
+
+    rum_content = "<script type=\"text/javascript\">(window.StackifySettings || (window.StackifySettings = #{rum_settings.to_json}))</script><script src=\"#{config.rum_script_url}\" data-key=\"#{config.rum_key}\" async></script>"
+    if rum_content.respond_to?(:html_safe)
+      rum_content.html_safe
+    else
+      rum_content
+    end
   end
 
   # Run the custom instrument

data/stackify-ruby-apm.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path('lib', File.dirname(__FILE__))
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'stackify_apm/version'
 
@@ -13,6 +13,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'http://www.stackify.com'
   spec.license       = 'Stackify'
 
+  # Set the minimum Ruby version required
+  spec.required_ruby_version = '>= 3.0.0'
+
   git_tracked_files = `git ls-files -z`.split("\x0")
   gem_ignored_files = `git ls-files -i -X .gemignore -z`.split("\x0")
   spec.files = git_tracked_files - gem_ignored_files
@@ -22,10 +25,13 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # rails
-  if RUBY_VERSION > '2.5'
+  if RUBY_VERSION > '2.9'
+    spec.add_development_dependency  'rails', '~> 6.1'
+  elsif RUBY_VERSION > '2.5'
     spec.add_development_dependency  'rails', '~> 5.0'
   else
     spec.add_development_dependency  'rails', '~> 4.0'
+    spec.add_development_dependency 'sprockets', '~> 3.0'
   end
 
   # bigdecimal
@@ -33,32 +39,63 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency  'bigdecimal'
   end
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  if RUBY_PLATFORM == 'i386-mingw32'
+    spec.add_development_dependency 'tzinfo-data'
+  end
+
+  if RUBY_VERSION > '2.9'
+    spec.add_development_dependency 'bundler', '~> 2.4.12'
+  else
+    spec.add_development_dependency 'bundler', '~> 1.16'
+  end
+
+  if RUBY_VERSION > '2.9'
+    spec.add_development_dependency 'rake'
+    spec.add_development_dependency 'rspec', '3.9.0'
+    spec.add_development_dependency 'curb', '1.0.3'
+    spec.add_development_dependency 'pg'
+    spec.add_development_dependency 'sqlite3'
+  else
+    spec.add_development_dependency 'rake', '~> 10.0'
+    spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'curb', '0.9.8'
+    spec.add_development_dependency 'pg', '~> 0.20'
+    spec.add_development_dependency 'sqlite3', '1.3.13'
+    spec.add_development_dependency('delegate_matcher', '~> 0.4') # for testing
+  end
+
+
   spec.add_development_dependency 'activerecord'
-  spec.add_development_dependency 'curb', '0.9.8'
   spec.add_development_dependency 'fakeredis'
   spec.add_development_dependency 'http'
   spec.add_development_dependency 'httpclient'
   spec.add_development_dependency 'mongo'
   spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'pg', '~> 0.20'
+
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'sequel'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'sinatra-activerecord'
-  spec.add_development_dependency 'sqlite3', '1.3.13'
+
   spec.add_development_dependency 'stackify-api-ruby'
   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('net_http_unix', '~> 0.2')
-  spec.add_dependency('rufus-scheduler', '~> 3.0')
-end
+  if RUBY_VERSION > '2.9'
+    spec.add_dependency('concurrent-ruby')
+    spec.add_dependency('delegate_matcher')
+    spec.add_dependency('faraday')
+    spec.add_dependency('net_http_unix')
+    spec.add_dependency('rufus-scheduler')
+  else
+    spec.add_dependency('concurrent-ruby', '~> 1.0')
+    spec.add_dependency('delegate_matcher', '~> 0.4')
+    spec.add_dependency('faraday', '~> 0.8')
+    spec.add_dependency('net_http_unix', '~> 0.2')
+    spec.add_dependency('rufus-scheduler', '~> 3.0')
+  end
+
+end