stackify-api-ruby 1.2.4 → 1.3.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6e7d47c5f5d7eba2a6326a4efdc6823d57aec456a946bc3eefd7694a29a8078
-  data.tar.gz: d2b022c023a0593391e7e190ca1e5784cdb56c4afacd010fa73d40fa581f9189
+  metadata.gz: ae96dffa800668cd0f8ab55fc62232c43951fbe5bf9700992698ece32bbbf006
+  data.tar.gz: 7e44e75717ecb342cdb632766708bb765793df1a92b534e689d59079c43d2bbd
 SHA512:
-  metadata.gz: 5d3ac89a398d1bf3192c6ed4a4cf8ab27e0523f67839ce17ff3d2fe41243bce977fe4d46a8dd8a23d684603aaf2dc6cc0ede38877ae16456c83b4d2693ce1af6
-  data.tar.gz: 61f4ded1b2cef4c418333adcfe893b999b637acc7a055a08b0c3664f95637414b21510718bd9f3a86f9e037f8dec241eeb2fb9c5b8f32afb5a924aaf46dcaac4
+  metadata.gz: 032502e0aff449fa9ad239f282751ee0699cffcca713f14dff414eaac255cbabba348bcbabc5f5800be8aadecd787c1a7ba9d92620a86cb41ee7f579a1f6d56b
+  data.tar.gz: 8e93149a91583a7f9accc6d6ba1e87767ea8daa96049fc25941b89b27f4a1c459e4d6cce050126306b8097d979b993b5ddfe0c984191b7f503a6bc3af50948a3

data/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

data/Gemfile.lock

@@ -1,24 +1,62 @@
 PATH
   remote: .
   specs:
-    stackify-api-ruby (1.1.0)
+    stackify-api-ruby (1.3.0.beta1)
       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

data/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:

data/lib/core_ext/core_ext.rb

@@ -1,3 +1,2 @@
 require 'json'
 require 'core_ext/object'
-require 'core_ext/fixnum'

data/lib/stackify-api-ruby.rb

@@ -2,8 +2,6 @@ require 'stackify/version'
 require 'stackify/utils/methods'
 require 'core_ext/core_ext' unless defined? Rails
 
-require 'google/protobuf'
-require 'proto/stackify-agent.rb'
 
 module Stackify
 
@@ -14,7 +12,6 @@ module Stackify
 
   autoload :Backtrace,            'stackify/utils/backtrace'
   autoload :MsgObject,            'stackify/utils/msg_object'
-  autoload :ProtobufLogObject,    'stackify/utils/protobuf_log_object'
   autoload :Configuration,        'stackify/utils/configuration'
   autoload :HttpClient,           'stackify/http_client'
   autoload :Authorizable,         'stackify/authorization/authorizable'
@@ -40,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
 
@@ -51,6 +49,10 @@ module Stackify
       @config ||= Stackify::Configuration.new
     end
 
+    def rum
+      @rum ||= Stackify::Rum.new(configuration)
+    end
+
     def setup
       @workers = []
       yield(configuration) if block_given?
@@ -123,7 +125,7 @@ module Stackify
 
     def run
       Stackify::Utils.is_api_enabled
-      Stackify.internal_log :info, "Stackify.run() transportType = #{Stackify.configuration.transport} | API version: #{Stackify::VERSION}"
+      Stackify.internal_log :info, "Stackify.run() transportType: #{Stackify.configuration.transport} | API version: #{Stackify::VERSION} | Ruby version: #{RUBY_VERSION}"
       if Stackify.configuration.api_enabled
         if Stackify.is_valid?
           # check transport types

data/lib/stackify/agent_base_sender.rb

@@ -1,5 +1,5 @@
 #
-# This class will handle the sending of protobuf message to agent
+# This class will handle the sending of log group message to agent
 #
 module Stackify
   class AgentBaseSender < Worker
@@ -23,28 +23,27 @@ module Stackify
     def send_logs_task attempts = nil, msgs
       properties[:attempts] = attempts if attempts
       Stackify::ScheduleTask.new properties do
-        data = create_log_group msgs
+        data = gather_and_pack_data(msgs).to_json
         send_request data
       end
     end
 
-    # create_log_group() This function will create a log group protobuf object
-    # @msgs {Object} Protobuf message
-    # return {Object} Return an object
-    def create_log_group msgs
-      # @details {Object} it will return the properties based in Stackify.setup() configuration
-      details = Stackify::Utils.get_app_settings
-      log_group = Stackify::LogGroup.new
-      msgs.each do |msg|
-        log_group.logs << msg
-      end
-      log_group.environment = details['env'].to_s
-      log_group.server_name = details['server_name'].to_s
-      log_group.application_name = details['app_name'].to_s
-      log_group.application_location = details['app_location'].to_s
-      log_group.logger = 'Ruby logger'
-      log_group.platform = 'ruby'
-      log_group
+    def gather_and_pack_data msgs
+      details = Stackify::EnvDetails.instance.auth_info
+      {
+        'CDID' => details['DeviceID'],
+        'CDAppID' => details['DeviceAppID'],
+        'Logger' => 'Rails logger',
+        'AppName' => details['AppName'],
+        'AppNameID' => details['AppNameID'],
+        'Env' => details['Env'],
+        'EnvID' => details['EnvID'],
+        'AppEnvID' => details['AppEnvID'],
+        'ServerName' => details['DeviceName'],
+        'Msgs' => msgs,
+        'AppLoc' => details['AppLocation'],
+        'Platform' => 'Ruby'
+      }
     end
 
     def send_request log_group

data/lib/stackify/agent_client.rb

@@ -36,11 +36,11 @@ module Stackify
     end
 
     def has_error msg
-      !msg.error.nil?
+      !msg['Ex'].nil?
     end
 
     def get_epoch msg
-      msg.date_millis
+      msg['EpochMs']
     end
 
     def send_logs msgs, attempts = 3
@@ -59,16 +59,16 @@ module Stackify
             e
           end
           ex = StackifiedError.new(ex, binding())
-          Stackify.msgs_queue << Stackify::ProtobufLogObject.new(level, ex.message, caller[0], trans_id, log_uuid, ex).to_obj
+          Stackify.msgs_queue << Stackify::MsgObject.new(level, ex.message, caller[0], trans_id, log_uuid, ex).to_h
         else
-          Stackify.msgs_queue << Stackify::ProtobufLogObject.new(level, msg, caller[0], trans_id, log_uuid).to_obj
+          Stackify.msgs_queue << Stackify::MsgObject.new(level, msg, caller[0], trans_id, log_uuid).to_h
         end
       end
     end
 
     def log_exception_task level, ex, trans_id=nil, log_uuid=nil
       Stackify::ScheduleTask.new ({limit: 1}) do
-        Stackify.msgs_queue << Stackify::ProtobufLogObject.new(level, ex.message, caller[0], trans_id, log_uuid, ex).to_obj
+        Stackify.msgs_queue << Stackify::MsgObject.new(level, ex.message, caller[0], trans_id, log_uuid, ex).to_h
       end
     end
 

data/lib/stackify/agent_http_sender.rb

@@ -3,27 +3,25 @@ require 'faraday'
 require 'ostruct'
 
 #
-# This class will handle the sending of protobuf message to agent using http request
+# This class will handle the sending of log messages to agent using http request
 #
 module Stackify
   class AgentHTTPSender < AgentBaseSender
 
     HEADERS = {
-      'Content-Type' => 'application/x-protobuf'
+      'Content-Type' => 'application/json'
     }
 
     # send_request() This function will post an http request
-    # @msgs {Object} Protobuf message
+    # @msgs {Object} log group message
     # return {Object} Return an object {status, message}
     def send_request log_group
       begin
-        # Convert data into binary and send it to agent
-        message = Stackify::LogGroup.encode(log_group)
         conn = Faraday.new(proxy: Stackify.configuration.proxy, ssl: { verify: false })
         @response = conn.post do |req|
           req.url URI(Stackify.configuration.http_endpoint + Stackify.configuration.agent_log_url)
           req.headers = HEADERS
-          req.body = message
+          req.body = log_group
         end
         if @response.try(:status) == 200
           Stackify.internal_log :debug, "[AgentHTTPSender]: Successfully send message via http request."

data/lib/stackify/authorization/authorizable.rb

@@ -11,7 +11,11 @@ module Stackify::Authorizable
     @@auth_client = nil
 
     def authorize attempts=3
-      Stackify::EnvDetails.instance.set_rails_info
+      # Check if the ruby version is 2.0 we get the Rails info properties such as
+      # <Application root: e.g., /home/user/rails_app> which is required in authorization
+      if Gem::Version.new(RUBY_VERSION) <= Gem::Version.new('2.0')
+        Stackify::EnvDetails.instance.set_rails_info
+      end
       @@auth_lock.synchronize do
         return unless @@auth_client.nil?
         @@auth_client = Stackify::Authorizable::AuthorizationClient.new

data/lib/stackify/engine.rb

@@ -4,7 +4,32 @@ module Stackify
 
     if Rails.version > '3.1'
       initializer 'Stackify set up of logger', group: :all do
+        if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.0')
+          # check if the client app is using the ActiveSupport::Logger
+          is_activesupport_logger = ::Rails.logger.is_a?(ActiveSupport::Logger)
+        elsif Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('3.0')
+          Stackify::Utils.check_buffered_logger
+        end
+
+        # Check if the log output is STDOUT
+        Stackify::Utils.check_log_output
+
+        # Proxy the client Rails logger and write logs to its default log_path.
+        # At the same time, we send the log messages to the LoggerClient.
         ::Rails.logger = ::Stackify::LoggerProxy.new ::Rails.logger
+
+        if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('6.0')
+          set_console_logs ::Rails.logger
+        elsif Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.0')
+          if is_activesupport_logger && Stackify.configuration.stdout_output
+            set_console_logs ::Rails.logger
+          end
+          # Another checking if the client app is using the default logger and not STDOUT
+          if Stackify.configuration.stdout_output == false
+            set_console_logs ::Rails.logger
+          end
+        end
+
         Stackify.run
       end
 
@@ -14,6 +39,28 @@ module Stackify
         end
       end
 
+      def set_console_logs new_logger
+        if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('6.0')
+          ActiveSupport.on_load(:action_controller_base) do
+            logger = new_logger
+          end
+          ActiveSupport.on_load(:action_view) do
+            logger = new_logger
+          end
+          ActiveSupport.on_load(:active_record) do
+            logger = new_logger
+          end
+        else
+          # Handle the stdout logs from Action Controller
+          ActionController::Base.logger = new_logger
+
+          # Handle the stdout logs from Action View
+          ActionView::Base.logger = new_logger
+
+          # Handle the stdout logs from Active Record
+          ActiveRecord::Base.logger = new_logger
+        end
+      end
     end
 
   end

data/lib/stackify/error.rb

@@ -40,7 +40,7 @@ module Stackify
 
     def to_h
       env = Stackify::EnvDetails.instance
-      {
+      data = {
         'OccurredEpochMillis' => Time.now.to_f*1000,
         'Error' => {
           'InnerError' => @exception.try(:cause),
@@ -52,11 +52,20 @@ module Stackify
           'SourceMethod' => source_method,
         },
         'EnvironmentDetail' => env.auth_info,
-        'WebRequestDetail' => env.request_details.try{ |d| d.fetch('webrequest_details', '') },
-        'ServerVariables' => env.request_details.try{ |d| d.fetch('server_variables', '') },
         'CustomerName' => 'Customer',
         'UserName' => @context.fetch('user', '')
       }
+      web_request_details = env.request_details.try{ |d| d.fetch('webrequest_details', '') }
+      if web_request_details.nil?
+        data['WebRequestDetail'] = web_request_details
+      end
+
+      server_variables = env.request_details.try{ |d| d.fetch('server_variables', '') }
+      if server_variables.nil?
+        data['ServerVariables'] = server_variables
+      end
+
+      data
     end
 
   end

data/lib/stackify/logger_client.rb

@@ -12,7 +12,33 @@ module Stackify
       end
     end
 
-    def log level, msg, call_trace
+    # This function is responsible in displaying log messages based on the level criteria
+    # @param num_level [Integer]  level of the clients Rails.logger
+    # @param level [String]       level coming from array of levels(debug info warn error fatal unknown) that we are going to filter with num_level
+    #                             So we filter all logs from num_level up to this level
+    # @param msg [Integer]        log messages
+    # @param call_trace [Object]  return the current execution stack
+    def log num_level, level, msg, call_trace
+      display_log = true
+      log_appender = false
+      buffer_log = false
+      if defined? Rails
+        display_log = false if Stackify.configuration.stdout_output
+        log_appender = true if defined?(Logging)
+        buffer_log = true if Stackify.configuration.buffered_logger
+        unless buffer_log
+          if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.0')
+            if display_log && log_appender
+              puts msg if num_level <= Logger.const_get(level.upcase).to_i
+            elsif display_log && log_appender == false
+              puts msg if num_level <= Logger.const_get(level.upcase).to_i
+            end
+          end
+        end
+      else
+        puts msg if num_level <= Logger.const_get(level.upcase).to_i
+      end
+
       return if @@transport.nil?
       task = log_message_task level, msg, call_trace
       @@transport.log level, msg, call_trace, task

data/lib/stackify/logger_proxy.rb

@@ -1,14 +1,16 @@
+
 module Stackify
   class LoggerProxy < Object
 
     def initialize logger
-      @logger = logger
-      @logger.level = Logger.const_get(Stackify.configuration.log_level.to_s.upcase)
+      rails_logger  = logger
+      num_level     = logger.level
+      @logger       = rails_logger
       %w(debug info warn error fatal unknown).each do |level|
         stackify_logger = if level == 'debug'
-          -> (msg, caller) { Stackify.logger_client.log(level.downcase, msg, caller) unless msg.to_s.empty? }
+          -> (msg, caller) { Stackify.logger_client.log(num_level, level.downcase, msg, caller) unless msg.to_s.empty? }
         else
-          -> (msg, caller) { Stackify.logger_client.log(level.downcase, msg, caller) }
+          -> (msg, caller) { Stackify.logger_client.log(num_level, level.downcase, msg, caller) }
         end
         LoggerProxy.class_eval do
           define_method level.to_sym do |*args , &block|

data/lib/stackify/metrics/metrics_client.rb

@@ -1,6 +1,6 @@
 module Stackify::Metrics
   class MetricsClient
-
+    TEN_MINUTES = 600
     attr_reader :metrics_queue
 
     def initialize
@@ -57,7 +57,7 @@ module Stackify::Metrics
 
     def start_upload_metrics
       current_time = Stackify::Utils.rounded_current_time
-      purge_older_than = current_time - 10.minutes
+      purge_older_than = current_time - TEN_MINUTES
       #read everything up to the start of the current minute
       read_queued_metrics_batch current_time
       handle_zero_reports current_time
@@ -67,7 +67,7 @@ module Stackify::Metrics
       if first_50_metrics.length > 0
         #only getting metrics less than 10 minutes old to drop old data in case we get backed up
         #they are removed from the @aggregated_metrics in the upload function upon success
-        upload_aggregates(first_50_metrics.select { |_key, aggr| aggr.occurred_utc > current_time - 10.minutes })
+        upload_aggregates(first_50_metrics.select { |_key, aggr| aggr.occurred_utc > current_time - TEN_MINUTES })
       end
       @aggregate_metrics.delete_if { |_key, aggr| aggr.occurred_utc < purge_older_than }
     end

data/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

data/lib/stackify/unix_socket_sender.rb

@@ -2,22 +2,20 @@ require 'net_http_unix'
 require 'ostruct'
 
 #
-# This class will handle the sending of protobuf message to unix domain socket
+# This class will handle the sending of log messages to unix domain socket
 #
 module Stackify
   class UnixSocketSender < AgentBaseSender
 
     # send_request() This function will send http request via unix domain socket
-    # @msgs {Object} Protobuf message
+    # @msgs {Object} log group message
     # return {Object} Return an object {status, message}
     def send_request log_group
       begin
-        # Convert data into binary and send it to unix domain socket
-        message = Stackify::LogGroup.encode(log_group)
         client = NetX::HTTPUnix.new('unix://' + Stackify.configuration.unix_socket_path)
         req = Net::HTTP::Post.new(Stackify.configuration.agent_log_url)
-        req.set_content_type('application/x-protobuf')
-        req.body = message
+        req.set_content_type('application/json')
+        req.body = log_group
         response = client.request(req)
         Stackify.internal_log :debug, "[UnixSocketSender] status_code = #{response.code}"
         if response.code.to_i == 200

data/lib/stackify/utils/backtrace.rb

@@ -3,6 +3,7 @@ module Stackify::Backtrace
   ALL_TEXT_FROM_START_TO_FIRST_COLON_REGEXP = /\A([^:]+)/
   NUMBER_BETWEEN_TWO_COLONS_REGEXP = /:(\d+):/
   TEXT_AFTER_IN_BEFORE_END_REGEXP = /in\s`(\S+)'\z/
+  TEXT_AFTER_IN_BEFORE_END_REGEXP_ = /in\s(\S+)'\z/
 
   def self.line_number backtrace_str
     backtrace_str[NUMBER_BETWEEN_TWO_COLONS_REGEXP, 1]
@@ -10,7 +11,7 @@ module Stackify::Backtrace
 
   def self.method_name backtrace_str
     return nil unless backtrace_str
-    backtrace_str[TEXT_AFTER_IN_BEFORE_END_REGEXP, 1]
+    backtrace_str[TEXT_AFTER_IN_BEFORE_END_REGEXP, 1] || backtrace_str[TEXT_AFTER_IN_BEFORE_END_REGEXP_, 1]
   end
 
   def self.file_name backtrace_str

data/lib/stackify/utils/configuration.rb

@@ -3,9 +3,10 @@ module Stackify
   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
+                  :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'
@@ -25,6 +26,13 @@ module Stackify
       @agent_log_url = '/log'
       @unix_socket_path = '/usr/local/stackify/stackify.sock'
       @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
@@ -50,6 +58,28 @@ module Stackify
       @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
@@ -108,5 +138,27 @@ module Stackify
       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

data/lib/stackify/utils/methods.rb

@@ -46,4 +46,29 @@ module Stackify::Utils
       'app_location' => Stackify.configuration.app_location || Dir.pwd
     }
   end
-end
+
+  # Check if the app is running on rails and the logger output is using STDOUT
+  def self.check_log_output
+    if defined? Rails
+      if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('5.0')
+        Stackify.configuration.stdout_output = ActiveSupport::Logger.logger_outputs_to?(Rails.logger, STDOUT)
+      else
+        Stackify.configuration.stdout_output = self.logger_stdout
+      end
+    end
+  end
+
+  def self.logger_stdout
+    logdev = ::Rails.logger.instance_variable_get(:@logdev)
+    logger_source = logdev.dev if logdev.respond_to?(:dev)
+    sources = [$stdout]
+    found = sources.any? { |source| source == logger_source }
+  end
+
+  # Check if the rails version 3 and it's using the buffered logger
+  def self.check_buffered_logger
+    is_buffered_logger = false
+    is_buffered_logger = true if ::Rails.logger.is_a?(ActiveSupport::BufferedLogger)
+    Stackify.configuration.buffered_logger = is_buffered_logger
+  end
+end

data/lib/stackify/version.rb

@@ -1,3 +1,3 @@
 module Stackify
-  VERSION = '1.2.4'
+  VERSION = '1.3.0.beta1'
 end

data/lib/stackify/workers/logs_sender_worker.rb

@@ -3,6 +3,14 @@ module Stackify
 
     def initialize name = 'LogsSender worker'
       super
+      case Stackify.configuration.transport
+      when Stackify::DEFAULT
+        name = 'LogsSender worker'
+      when Stackify::UNIX_SOCKET
+        name = 'UnixSocketSender worker'
+      when Stackify::AGENT_HTTP
+        name = 'AgentHTTPSender worker'
+      end
       @name = name
       @name += " ##{self.id}"
       @type = :logs_send

data/spec/rum_spec.rb

@@ -0,0 +1,291 @@
+require 'spec_helper'
+require 'stackify-api-ruby'
+
+module Stackify
+    RSpec.describe 'Rum - APM not loaded - Normal' do
+        it 'returns rum script with complete information from ENV' do
+            ENV['RETRACE_RUM_KEY'] = 'test-key'
+            ENV['RETRACE_RUM_SCRIPT_URL'] = 'https://test.com/test.js'
+
+            config = Stackify::Configuration.new
+            config.app_name = 'test'
+            config.env = 'test-env'
+
+            rum = Stackify::Rum.new(config)
+            reporting_url = "test reporting url"
+            transaction_id = "123-id"
+            rum_script_url = 'https://test.com/test.js'
+
+            rum_settings = {
+                "ID" => '123-id',
+                "Env" => Base64.strict_encode64('test-env'.encode('utf-8')),
+                "Name" => Base64.strict_encode64('test'.strip.encode('utf-8')), # TODO: Add helper function
+                "Trans" => Base64.strict_encode64('test reporting url'.encode('utf-8'))
+            }
+
+            expected_rum_script = "<script type=\"text/javascript\">(window.StackifySettings || (window.StackifySettings = #{rum_settings.to_json()}))<\/script><script src=\"#{rum_script_url}\" data-key=\"#{config.rum_key}\" async></script>"
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq reporting_url
+            expect(rum.get_transaction_id).to eq transaction_id
+            expect(rum_script.to_s).not_to be_empty
+            expect(rum_script).to eq expected_rum_script
+
+            ENV.delete('RETRACE_RUM_KEY')
+            ENV.delete('RETRACE_RUM_SCRIPT_URL')
+        end
+
+        it 'returns rum script with complete information from Config' do
+            config = Stackify::Configuration.new
+            config.app_name = 'test'
+            config.env = 'test-env'
+            config.rum_script_url = 'https://test.com/test.js'
+            config.rum_key = 'asd'
+
+            rum = Stackify::Rum.new(config)
+            reporting_url = "test reporting url"
+            transaction_id = "123-id"
+            rum_script_url = 'https://test.com/test.js'
+            rum_key = 'asd'
+
+            rum_settings = {
+                "ID" => '123-id',
+                "Env" => Base64.strict_encode64('test-env'.encode('utf-8')),
+                "Name" => Base64.strict_encode64('test'.strip.encode('utf-8')), # TODO: Add helper function
+                "Trans" => Base64.strict_encode64('test reporting url'.encode('utf-8'))
+            }
+
+            expected_rum_script = "<script type=\"text/javascript\">(window.StackifySettings || (window.StackifySettings = #{rum_settings.to_json()}))<\/script><script src=\"#{rum_script_url}\" data-key=\"#{rum_key}\" async></script>"
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq reporting_url
+            expect(rum.get_transaction_id).to eq transaction_id
+            expect(rum_script.to_s).not_to be_empty
+            expect(rum_script).to eq expected_rum_script
+        end
+    end
+
+    RSpec.describe 'Rum - APM not loaded - Invalid' do
+        it 'returns rum script with invalid rum script url from Config' do
+            config = Stackify::Configuration.new
+            config.app_name = 'test'
+            config.env = 'test-env'
+            config.rum_script_url = 'test.js'
+            config.rum_key = 'asd'
+
+            rum = Stackify::Rum.new(config)
+            reporting_url = "test reporting url"
+            transaction_id = "123-id"
+            rum_script_url = 'https://stckjs.stackify.com/stckjs.js'
+            rum_key = 'asd'
+
+            rum_settings = {
+                "ID" => '123-id',
+                "Env" => Base64.strict_encode64('test-env'.encode('utf-8')),
+                "Name" => Base64.strict_encode64('test'.strip.encode('utf-8')), # TODO: Add helper function
+                "Trans" => Base64.strict_encode64('test reporting url'.encode('utf-8'))
+            }
+
+            expected_rum_script = "<script type=\"text/javascript\">(window.StackifySettings || (window.StackifySettings = #{rum_settings.to_json()}))<\/script><script src=\"#{rum_script_url}\" data-key=\"#{rum_key}\" async></script>"
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq reporting_url
+            expect(rum.get_transaction_id).to eq transaction_id
+            expect(rum_script.to_s).not_to be_empty
+            expect(rum_script).to eq expected_rum_script
+        end
+
+        it 'returns rum script with invalid rum key from Config' do
+            config = Stackify::Configuration.new
+            config.app_name = 'test'
+            config.env = 'test-env'
+            config.rum_script_url = 'test.js'
+            config.rum_key = '`asd'
+
+            rum = Stackify::Rum.new(config)
+            reporting_url = "test reporting url"
+            transaction_id = "123-id"
+            rum_script_url = 'https://stckjs.stackify.com/stckjs.js'
+            rum_key = 'asd'
+
+            rum_settings = {
+                "ID" => '123-id',
+                "Env" => Base64.strict_encode64('test-env'.encode('utf-8')),
+                "Name" => Base64.strict_encode64('test'.strip.encode('utf-8')), # TODO: Add helper function
+                "Trans" => Base64.strict_encode64('test reporting url'.encode('utf-8'))
+            }
+
+            expected_rum_script = "<script type=\"text/javascript\">(window.StackifySettings || (window.StackifySettings = #{rum_settings.to_json()}))<\/script><script src=\"#{rum_script_url}\" data-key=\"#{rum_key}\" async></script>"
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq reporting_url
+            expect(rum.get_transaction_id).to eq transaction_id
+            expect(rum_script.to_s).to be_empty
+            expect(rum_script).not_to eq expected_rum_script
+            expect(config.rum_key).to be_empty
+        end
+
+        it 'returns rum script with no app name' do
+            config = Stackify::Configuration.new
+            config.app_name = ''
+            config.env = 'test-env'
+            config.rum_script_url = 'test.js'
+            config.rum_key = '`asd'
+
+            rum = Stackify::Rum.new(config)
+
+            reporting_url = "test reporting url"
+            transaction_id = "123-id"
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq reporting_url
+            expect(rum.get_transaction_id).to eq transaction_id
+            expect(rum_script.to_s).to be_empty
+            expect(config.rum_key).to be_empty
+            expect(config.app_name).to be_empty
+        end
+
+        it 'returns rum script with no env' do
+            config = Stackify::Configuration.new
+            config.app_name = 'test'
+            config.rum_script_url = 'test.js'
+            config.rum_key = 'asd'
+
+            rum = Stackify::Rum.new(config)
+            reporting_url = "test reporting url"
+            transaction_id = "123-id"
+            rum_script_url = 'https://stckjs.stackify.com/stckjs.js'
+            rum_key = 'asd'
+
+            rum_settings = {
+                "ID" => '123-id',
+                "Env" => Base64.strict_encode64('production'.encode('utf-8')),
+                "Name" => Base64.strict_encode64('test'.strip.encode('utf-8')), # TODO: Add helper function
+                "Trans" => Base64.strict_encode64('test reporting url'.encode('utf-8'))
+            }
+
+            expected_rum_script = "<script type=\"text/javascript\">(window.StackifySettings || (window.StackifySettings = #{rum_settings.to_json()}))<\/script><script src=\"#{rum_script_url}\" data-key=\"#{rum_key}\" async></script>"
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq reporting_url
+            expect(rum.get_transaction_id).to eq transaction_id
+            expect(rum_script.to_s).not_to be_empty
+            expect(rum_script).to eq expected_rum_script
+            expect(config.env).to eq :production
+        end
+
+        it 'returns rum script with no transaction id' do
+            config = Stackify::Configuration.new
+            config.app_name = 'test'
+            config.env = 'test-env'
+            config.rum_script_url = 'test.js'
+            config.rum_key = 'asd'
+
+            rum = Stackify::Rum.new(config)
+
+            reporting_url = "test reporting url"
+            transaction_id = ""
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq reporting_url
+            expect(rum.get_transaction_id).to eq ""
+            expect(rum_script.to_s).to be_empty
+        end
+
+        it 'returns rum script with no reporting url' do
+            config = Stackify::Configuration.new
+            config.app_name = 'test'
+            config.env = 'test-env'
+            config.rum_script_url = 'test.js'
+            config.rum_key = 'asd'
+
+            rum = Stackify::Rum.new(config)
+
+            reporting_url = ""
+            transaction_id = "test-123"
+
+            allow(rum).to receive(:get_reporting_url).and_return(reporting_url)
+            allow(rum).to receive(:get_transaction_id).and_return(transaction_id)
+            allow(Rum).to receive(:apm_loaded).and_return(false)
+
+            rum_script = rum.insert_rum_script
+
+            expect(rum.get_reporting_url).to eq ""
+            expect(rum.get_transaction_id).to eq transaction_id
+            expect(rum_script.to_s).to be_empty
+        end
+    end
+
+    RSpec.describe 'Rum - APM loaded - Normal' do
+        it 'returns rum script with complete information from ENV' do
+            ENV['RETRACE_RUM_KEY'] = 'test-key'
+            ENV['RETRACE_RUM_SCRIPT_URL'] = 'https://test.com/test.js'
+            ENV['TZ'] = 'Europe/Paris' # For error
+
+            config = Stackify::Configuration.new
+            rum = Stackify::Rum.new(config)
+            reporting_url = "test reporting url"
+            transaction_id = "123-id"
+            rum_script_url = 'https://test.com/test.js'
+            rum_script = ""
+
+            StackifyRubyAPM.start
+            transaction = StackifyRubyAPM.transaction 'RUM Script Injection test' do
+                rum_script = rum.insert_rum_script
+            end.submit 200
+            StackifyRubyAPM.stop
+
+            rum_settings = {
+                "ID" => transaction.id(),
+                "Env" => Base64.strict_encode64('test'.encode('utf-8')),
+                "Name" => Base64.strict_encode64('Ruby Application'.strip.encode('utf-8')), # TODO: Add helper function
+                "Trans" => Base64.strict_encode64('RUM Script Injection test'.encode('utf-8'))
+            }
+
+            expected_rum_script = "<script type=\"text/javascript\">(window.StackifySettings || (window.StackifySettings = #{rum_settings.to_json()}))<\/script><script src=\"#{rum_script_url}\" data-key=\"#{config.rum_key}\" async></script>"
+
+            ENV.delete('TZ')
+            ENV.delete('RETRACE_RUM_KEY')
+            ENV.delete('RETRACE_RUM_SCRIPT_URL')
+
+            expect(rum_script.to_s).not_to be_empty
+            expect(rum_script).to eq expected_rum_script
+        end
+    end
+  end
+  

data/spec/spec_helper.rb

@@ -1,3 +1,12 @@
+ENV['RAILS_ENV'] = ENV['RACK_ENV'] = 'test'
+require 'bundler/setup'
+
+# auto-require default gems + gems under test
+Bundler.require :default, 'test'
+
+require 'logger'
+require 'stackify_ruby_apm'
+
 RSpec.configure do |config|
 
   config.filter_run :focus

data/stackify-api-ruby.gemspec

@@ -21,7 +21,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  if RUBY_PLATFORM == 'i386-mingw32'
+    spec.add_development_dependency 'tzinfo-data'
+  end
+
   spec.add_runtime_dependency 'faraday', '~> 0.8'
-  spec.add_runtime_dependency 'google-protobuf', '~> 3.0'
   spec.add_runtime_dependency 'net_http_unix', '~> 0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stackify-api-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.3.0.beta1
 platform: ruby
 authors:
 - Stackify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: google-protobuf
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: net_http_unix
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +95,6 @@ files:
 - README.md
 - Rakefile
 - lib/core_ext/core_ext.rb
-- lib/core_ext/fixnum.rb
 - lib/core_ext/object.rb
 - lib/generators/stackify/stackify_generator.rb
 - lib/generators/stackify/templates/stackify.rb
@@ -123,6 +122,7 @@ files:
 - lib/stackify/metrics/monitor.rb
 - lib/stackify/msgs_queue.rb
 - lib/stackify/rack/errors_catcher.rb
+- lib/stackify/rum.rb
 - lib/stackify/schedule_delay.rb
 - lib/stackify/schedule_task.rb
 - lib/stackify/scheduler.rb
@@ -139,6 +139,7 @@ files:
 - lib/stackify/workers/logs_sender_worker.rb
 - lib/stackify/workers/msgs_queue_worker.rb
 - lib/stackify/workers/worker.rb
+- spec/rum_spec.rb
 - spec/spec_helper.rb
 - stackify-api-ruby.gemspec
 homepage: http://www.stackify.com/
@@ -156,13 +157,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Stackify API for Ruby
 test_files:
+- spec/rum_spec.rb
 - spec/spec_helper.rb

data/lib/core_ext/fixnum.rb

@@ -1,17 +0,0 @@
-class Fixnum
-  SECONDS_IN_MINUTE = 60
-  SECONDS_IN_HOUR =  60 * SECONDS_IN_MINUTE
-  SECONDS_IN_DAY = 24 * SECONDS_IN_HOUR
-
-  def days
-    self * SECONDS_IN_DAY
-  end
-
-  def minutes
-    self * SECONDS_IN_MINUTE
-  end
-
-  def ago
-    Time.now - self
-  end
-end