Merge pull request #40 from homiedopie/feature/LNX-330-rum-v2

LNX-330 - Initial commit for RUMv2 support

Author: homiedopie

Gemfile

@@ -1,4 +1,11 @@
-source 'https://rubygems.org'
+group :test do
+    if ENV['STACKIFY_RUBY_TEST']
+        gem 'stackify-ruby-apm', '~> 1.15', source: ENV['STACKIFY_RUBY_TEST_REPO']
+    else
+        gem 'stackify-ruby-apm', '~> 1.15'
+    end
+end
 
+source 'https://rubygems.org'
 # Specify your gem's dependencies in stackify.gemspec
 gemspec

Gemfile.lock

@@ -1,24 +1,62 @@
 PATH
   remote: .
   specs:
-    stackify-api-ruby (1.1.0)
+    stackify-api-ruby (1.2.10)
       faraday (~> 0.8)
+      net_http_unix (~> 0.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    faraday (0.15.4)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    et-orbi (1.2.4)
+      tzinfo
+    faraday (0.17.4)
       multipart-post (>= 1.2, < 3)
-    multipart-post (2.0.0)
+    fugit (1.5.0)
+      et-orbi (~> 1.1, >= 1.1.8)
+      raabro (~> 1.4)
+    multipart-post (2.1.1)
+    net_http_unix (0.2.2)
+    raabro (1.4.0)
     rake (0.9.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rufus-scheduler (3.8.0)
+      fugit (~> 1.1, >= 1.1.6)
+    stackify-ruby-apm (1.15.1)
+      concurrent-ruby (~> 1.0)
+      faraday (~> 0.8)
+      net_http_unix (~> 0.2)
+      rufus-scheduler (~> 3.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    tzinfo-data (1.2021.1)
+      tzinfo (>= 1.0.0)
 
 PLATFORMS
   ruby
+  x86-mingw32
 
 DEPENDENCIES
   bundler (~> 1.6)
   rake (~> 0)
+  rspec (~> 3.0)
   stackify-api-ruby!
+  stackify-ruby-apm (~> 1.15)
+  tzinfo-data
 
 BUNDLED WITH
-   1.17.3
+   1.17.13

README.md

@@ -124,6 +124,23 @@ We can configure every metric with settings:
 
 Note, "autoreport_last_value_if_nothing_reported" property has influence only on "average" metric.
 
+### **Real User Monitoring (RUM)**
+
+Real user monitoring injects a script tag containing the [RUM JS](https://stackify.com/retrace-real-user-monitoring/) that is responsible for capturing information about the http requests on the browser. This approach is manual and needs to be configured.
+
+#### RUM - Setup
+
+```ruby
+# Configuration - Standard API
+Stackify.setup do |config|
+  ...
+  config.rum_key = "YourRumKey"
+end
+
+# Use this to apply on views
+Stackify.rum.insert_rum_script
+```
+
 ## Troubleshooting
 
 If there are problems, you can enable internal logging of the stackify-api-ruby project. Uncomment out the config.logger and config.logger.level lines in the 'config/initializers/stackify.rb' file:

lib/stackify-api-ruby.rb

@@ -37,6 +37,7 @@ module Stackify
   autoload :StringException,      'stackify/error'
   autoload :ErrorsGovernor,       'stackify/errors_governor'
   autoload :Metrics,              'stackify/metrics/metrics'
+  autoload :Rum,                  'stackify/rum'
 
   include Authorizable
 
@@ -48,6 +49,10 @@ def configuration
       @config ||= Stackify::Configuration.new
     end
 
+    def rum
+      @rum ||= Stackify::Rum.new(configuration)
+    end
+
     def setup
       @workers = []
       yield(configuration) if block_given?

lib/stackify/rum.rb

@@ -0,0 +1,72 @@
+$apmLoaded = false
+
+begin
+  require 'stackify-ruby-apm'
+  $apmLoaded = true
+rescue LoadError
+end
+
+module Stackify
+  class Rum
+    def initialize(config)
+      @config = config
+    end
+
+    def insert_rum_script()
+      return StackifyRubyAPM.inject_rum_script if Rum.apm_loaded && defined?(StackifyRubyAPM) && StackifyRubyAPM.respond_to?(:inject_rum_script)
+
+      return '' unless @config
+
+      config = @config
+
+      return '' if config.rum_script_url.to_s.empty? || config.rum_key.to_s.empty?
+
+      transaction_id = get_transaction_id().to_s
+      return '' if transaction_id.empty?
+
+      reporting_url = get_reporting_url().to_s
+      return '' if reporting_url.empty?
+
+      environment_name = defined?(config.env) ? config.env.to_s : 'Development'
+      return '' if environment_name.empty?
+
+      application_name = defined?(config.app_name) ? config.app_name.to_s : ''
+      return '' if application_name.empty?
+
+      rum_settings = {
+        "ID" => transaction_id
+      }
+
+      if !environment_name.empty?
+        rum_settings["Env"] = Base64.strict_encode64(environment_name.encode('utf-8'))
+      end
+
+      if !application_name.empty?
+        rum_settings["Name"] = Base64.strict_encode64(application_name.strip.encode('utf-8'))
+      end
+
+      if !reporting_url.empty?
+        rum_settings["Trans"] = Base64.strict_encode64(reporting_url.encode('utf-8'))
+      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
+
+    def self.apm_loaded
+      $apmLoaded
+    end
+    
+    def get_reporting_url
+      ''
+    end
+    
+    def get_transaction_id
+      ''
+    end
+  end
+end

lib/stackify/utils/configuration.rb

@@ -5,7 +5,8 @@ class Configuration
     attr_accessor :api_key, :app_name, :app_location, :env, :log_level, :logger,
                   :proxy, :mode, :base_api_url, :api_enabled, :transport, :errors, :http_endpoint, :stdout_output, :buffered_logger
 
-    attr_reader :send_interval, :flood_limit, :queue_max_size, :agent_log_url, :unix_socket_path, :http_endpoint
+    attr_reader :send_interval, :flood_limit, :queue_max_size, :agent_log_url, :unix_socket_path, :http_endpoint,
+                :rum_key, :rum_script_url
 
     def initialize
       @base_api_url = 'https://api.stackify.com'
@@ -27,6 +28,11 @@ def initialize
       @http_endpoint = get_env 'STACKIFY_TRANSPORT_HTTP_ENDPOINT', 'https://localhost:10601'
       @stdout_output = false
       @buffered_logger = false
+      @default_rum_script_url = 'https://stckjs.stackify.com/stckjs.js'
+      @default_rum_key = ''
+
+      self.rum_key = get_env 'RETRACE_RUM_KEY', @default_rum_key
+      self.rum_script_url = get_env 'RETRACE_RUM_SCRIPT_URL', @default_rum_script_url
     end
 
     def get_env env_key, default
@@ -52,6 +58,28 @@ def validate_transport_type
       @errors << 'Transport should be one of these values: [agent_socket, agent_http, default]. Should be a String.'
     end
 
+    def rum_script_url=(rum_script_url)
+      if rum_script_url.empty?
+        @rum_script_url = @default_rum_script_url
+        return
+      end
+
+      if validate_rum_script_url(rum_script_url)
+        @rum_script_url = rum_script_url
+      end
+    end
+
+    def rum_key=(rum_key)
+      if rum_key.empty?
+        @rum_key = @default_rum_key
+        return
+      end
+
+      if validate_rum_key(rum_key)
+        @rum_key = rum_key
+      end
+    end
+
     private
 
     def validate_config_types
@@ -110,5 +138,27 @@ def validate_mode
       return true if MODES.has_value? @mode
       @errors << 'Mode should be one of these values: [:both, :logging, :metrics]'
     end
+
+    def validate_rum_script_url(rum_script_url)
+      result = false
+      if rum_script_url.is_a?(String) && !rum_script_url.empty?
+        result = rum_script_url =~ /^((((https?|ftps?|gopher|telnet|nntp):\/\/)|(mailto:|news:))(%[0-9A-Fa-f]{2}|[\-\(\)_\.!~*';\/?:@&=+$,A-Za-z0-9])+)([\)\.!';\/?:,][\[:blank:|:blank:\]])?$/
+      end
+      if !result
+        @errors << 'RUM Script URL is in invalid format.'
+      end
+      result
+    end
+
+    def validate_rum_key(rum_key)
+      result = false
+      if rum_key.is_a?(String) && !rum_key.empty?
+        result = rum_key =~ %r{^[A-Za-z0-9_-]+$}
+      end
+      if !result
+        @errors << 'RUM Key is in invalid format.'
+      end
+      result
+    end
   end
 end