stackify-ruby-apm 1.6.1 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8ec4ca9ae4465f5108ab76f8759bdd94702f0b46c7a44a2c510314cff8e7f44
-  data.tar.gz: 4b95a706746da817c8aab319fadb72392f6806e9795c23cfe4b4558bd9660b56
+  metadata.gz: ca22a5a75e1ae02e39bea7fa1330da6530c522cf33f3e82f4aec4aec2515ef79
+  data.tar.gz: 3ce816108dfed9e9abdd268b127b5795a41be911da28d16afcc0262e369847f7
 SHA512:
-  metadata.gz: 5ba374e64587fc878524e7e47a003099e24cb444ca6fea2fdfed114339d2c64ed241b02abfbf2bd0c5f69cb87fdb50a37e456350b719d2c402b50a7d8cc874f0
-  data.tar.gz: e58a7a2206c39b3c15c896267f64aa3c91a6775c0fee17267012724a184c41f6486d295f3f50bfa82821075f95b72c754f5986b48ab84ba8da3e1b78bf0fbc65
+  metadata.gz: e9a115fe042f1f9b3021af173ba229ba2bfab15c5685bf57cf851e6292089252f321966c7cf85622942ef853750961641980a38db8452b07e79a17c17a5bc79d
+  data.tar.gz: 2ce4459279a1661b6ef016ccc33ddf5d9b01d9e2a1eea94e732be98101699920e5ba068d226d2711ac0c754014b6c0607c4b5c441ac476aa72edf8ff39c67ea0

data/lib/stackify_apm/config.rb

@@ -19,6 +19,10 @@ module StackifyRubyAPM
       environment_name: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
       already_instrumented_flag: false,
       rum_auto_injection: false,
+      rum_enabled: false,
+      rum_cookie_max_age: 0,
+      rum_cookie_path: '/',
+      rum_cookie_name: '.Stackify.Rum',
       instrument: true,
       debug_logging: false,
       log_path: StackifyRubyAPM::Util.host_os == 'WINDOWS' ? 'C:\ProgramData\Stackify\Ruby\log\stackify-ruby-apm-1.log' : '/usr/local/stackify/stackify-ruby-apm/log/stackify-ruby-apm-1.log',
@@ -58,6 +62,7 @@ module StackifyRubyAPM
       'STACKIFY_APM_ENVIRONMENT_NAME' => 'environment_name',
       'STACKIFY_APM_RUM_SCRIPT_SRC' => 'rum_script_src',
       'STACKIFY_APM_RUM_AUTO_INJECTION' => 'rum_auto_injection',
+      'STACKIFY_APM_RUM_ENABLED' => 'rum_enabled',
       'STACKIFY_ALREADY_INSTRUMENTED_FLAG' => 'already_instrumented_flag',
       'STACKIFY_APM_DEBUG_LOGGING' => 'debug_logging',
       'STACKIFY_APM_INSTRUMENT' => [:bool, 'instrument'],
@@ -77,13 +82,12 @@ module StackifyRubyAPM
 
     def initialize(options = {})
       set_defaults
-
       set_from_args(options)
       set_from_config_file
       set_from_env
 
       yield self if block_given?
-      build_logger if ENV['STACKIFY_RUBY_ENV'] == 'rspec'
+      debug_logger
       StackifyRubyAPM::Util.host_os == 'WINDOWS' ? load_stackify_props_windows : load_stackify_props
     end
 
@@ -92,6 +96,10 @@ module StackifyRubyAPM
     attr_accessor :environment_name
     attr_accessor :rum_script_src
     attr_accessor :rum_auto_injection
+    attr_accessor :rum_enabled
+    attr_accessor :rum_cookie_max_age
+    attr_accessor :rum_cookie_path
+    attr_accessor :rum_cookie_name
     attr_accessor :already_instrumented_flag
     attr_accessor :rum_script_injected
     attr_accessor :instrument
@@ -203,8 +211,8 @@ module StackifyRubyAPM
     end
 
     def debug_logger
-      debuger_logpath = log_path == '-' ? $stdout : log_path
-      logger = StackifyLogger.new(debuger_logpath, debugger_filenum_rotate, debugger_byte_size)
+      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
@@ -265,8 +273,8 @@ module StackifyRubyAPM
     # 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)
+      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

data/lib/stackify_apm/middleware.rb

@@ -50,18 +50,19 @@ module StackifyRubyAPM
 
         if okay_to_modify?
           @configuration.already_instrumented_flag = true
-          if StackifyRubyAPM.rum_script_inject
-            resp
+          if @configuration.rum_auto_injection
+            response_string = response_manupulate.adjust_pagehtml_response
+          end
+          if response_string
+            response = Rack::Response.new(response_string, @rack_status, @rack_headers)
+            response.set_cookie(@configuration.rum_cookie_name, value: transaction.id, path: @configuration.rum_cookie_path, max_age: @configuration.rum_cookie_max_age) if @configuration.rum_enabled
+            resp = response.finish
+          elsif @configuration.rum_enabled
+            response = Rack::Response.new @rack_body, @rack_status, @rack_headers
+            response.set_cookie(@configuration.rum_cookie_name, value: transaction.id, path: @configuration.rum_cookie_path, max_age: @configuration.rum_cookie_max_age)
+            resp = response.finish
           else
-            if @configuration.rum_auto_injection
-              response_string = response_manupulate.call_manipulate
-            end
-            if response_string
-              response = Rack::Response.new(response_string, @rack_status, @rack_headers)
-              resp = response.finish
-            else
-              resp
-            end
+            resp
           end
         else
           resp

data/lib/stackify_apm/response_manipulator.rb

@@ -4,9 +4,11 @@
 # This class will manupulate the html page d: e.g., call(env)
 #
 #
+
 module StackifyRubyAPM
   # an abstraction for manipulating the HTML we capture in the middleware
   class ResponseManipulator
+    include Log
     attr_reader :rack_response, :jsfile_to_inject
     attr_reader :rack_status, :rack_headers, :rack_body, :Rack_flagger
     attr_reader :env
@@ -32,31 +34,13 @@ module StackifyRubyAPM
       @config = config
     end
 
-    def call_manipulate
-      if check_rumscript_variable
-        adjust_pagehtml_response(true)
-      else
-        adjust_pagehtml_response
-      end
-    end
-
-    def check_rumscript_variable
-      response = @rack_body
-      source = gather_source(response)
-      close_old_response(response)
-      return false unless source
-
-      return true if source.include?(RUM_SCRIPT_VARIABLE)
-      false
-    end
-
     def rebuild_rack_response
       [rack_status, rack_headers, rack_body]
     end
 
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/PerceivedComplexity
-    def adjust_pagehtml_response(rum_variable_script = false)
+    def adjust_pagehtml_response
       response = @rack_body
       source = gather_source(response)
       close_old_response(response)
@@ -71,8 +55,10 @@ module StackifyRubyAPM
         if StackifyRubyAPM.check_isdomain(client_rundomain)
           inject_flag = true
         else
-          info 'Error: Stackify Client RUM Domain is invalid.'
+          info 'RUM Injection Error: Client RUM Domain is invalid.'
         end
+      else
+        info 'RUM Injection Error: No Device ID and/or Client ID found.'
       end
 
       return unless inject_flag
@@ -96,7 +82,6 @@ module StackifyRubyAPM
         source = source[0...insertion_index] <<
                  jsfile_to_inject <<
                  source[insertion_index..-1]
-        source = source.sub('[RUM_SCRIPT_VARIABLE]', '') if rum_variable_script
       end
       source
     end

data/lib/stackify_apm/version.rb

@@ -2,5 +2,5 @@
 
 # Sets the version of the APM
 module StackifyRubyAPM
-  VERSION = '1.6.1'.freeze
+  VERSION = '1.7.1'.freeze
 end

data/lib/stackify_ruby_apm.rb

@@ -25,7 +25,7 @@ require 'stackify_apm/config'
 require 'stackify_apm/context'
 require 'stackify_apm/instrumenter'
 require 'stackify_apm/internal_error'
-# require 'stackify_apm/util'
+require 'stackify_apm/response_manipulator'
 require 'stackify_apm/middleware'
 require 'stackify_apm/instrumenter_helper'
 
@@ -34,6 +34,7 @@ require 'stackify_apm/railtie' if defined?(::Rails::Railtie)
 
 # Start medoule for StackifyRubyAPM Agent
 module StackifyRubyAPM
+  include Log
   # Starts the StackifyRubyAPM Agent
   #
   # @param config [Config] An instance of Config
@@ -48,15 +49,10 @@ module StackifyRubyAPM
     device_id = config.device_id
     client_rundomain = config.client_run_domain
     transaction_id = defined?(StackifyRubyAPM.current_transaction.id) ? StackifyRubyAPM.current_transaction.id : nil
-
     inject_flag = false
 
     if client_id && device_id
-      if check_isdomain(client_rundomain)
-        inject_flag = true
-      else
-        info 'Error: Stackify Client RUM Domain is invalid.'
-      end
+      inject_flag = true if check_isdomain(client_rundomain)
     end
 
     return unless inject_flag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackify-ruby-apm
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.1
 platform: ruby
 authors:
 - Stackify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-06 00:00:00.000000000 Z
+date: 2019-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler