stackify-api-ruby 1.0.15 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd19881ee793a2b23b9137218fd184427d9a9502efd1b81ba2064f23626d1228
-  data.tar.gz: 9c3757c006c8f013afb097cf8a0cb7e016f1b1314375dfacfe3bd2d87403a9c8
+  metadata.gz: 371cb99e1d47ff1680b37a4e4a8b69a992787ef047c3973e923bb08032486239
+  data.tar.gz: 379714698256d7614a12b1e07e996e5a0256f868df5db33e103ec136fd8eec01
 SHA512:
-  metadata.gz: bee61b9d0b9b18a3ad4db32dd6b7680b3e6c7db50979cdf1a8f9f222c97465c295474f05c757c734fa26b2082a4e5cbdf541083173c295d0bb48071bc64f04db
-  data.tar.gz: 87ac37dd7b3ec51fc91f79eadad7316c587e25ee2e55844a974437cd4ad731c9ece070178ff51366f6132696cc93bd21c2cdb5eaa8c92df46d8b586ef265415d
+  metadata.gz: f7aff04aee12c3a8346c39fb32f34965f360e969e960607053685c3081b2a27a333e4e7842d87f486d3ddb2341b49f18107276c96d8090d1b90e6ea258b766ab
+  data.tar.gz: 7e2d3a430f5794f6e29689255adc9be0dd36b4bddc9504507161c1a0d0edd4699bfa1df675c803f0bc1c4bd4090d2b080bf78886837f89f0b84d74e7f673f050

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stackify-api-ruby (1.0.15)
+    stackify-api-ruby (1.1.0)
       faraday (~> 0.8)
 
 GEM

data/lib/core_ext/core_ext.rb

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

data/lib/proto/stackify-agent.rb

@@ -0,0 +1,102 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: stackify-agent.proto
+
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "stackify.LogGroup" do
+    optional :environment, :string, 1
+    optional :server_name, :string, 2
+    optional :application_name, :string, 3
+    optional :application_location, :string, 4
+    optional :logger, :string, 5
+    optional :platform, :string, 6
+    repeated :logs, :message, 7, "stackify.LogGroup.Log"
+    optional :container, :message, 8, "stackify.LogGroup.Container"
+    optional :kubernetes, :message, 9, "stackify.LogGroup.Kubernetes"
+  end
+  add_message "stackify.LogGroup.Container" do
+    optional :image_id, :string, 1
+    optional :image_repository, :string, 2
+    optional :image_tag, :string, 3
+    optional :container_id, :string, 4
+    optional :container_name, :string, 5
+  end
+  add_message "stackify.LogGroup.Kubernetes" do
+    optional :pod_name, :string, 1
+    optional :pod_namespace, :string, 2
+    optional :cluster_name, :string, 3
+  end
+  add_message "stackify.LogGroup.Log" do
+    optional :message, :string, 1
+    optional :data, :string, 2
+    optional :thread_name, :string, 3
+    optional :date_millis, :int64, 4
+    optional :level, :string, 5
+    optional :transaction_id, :string, 6
+    optional :source_method, :string, 7
+    optional :source_line, :int32, 8
+    optional :id, :string, 9
+    repeated :tags, :string, 10
+    optional :error, :message, 11, "stackify.LogGroup.Log.Error"
+  end
+  add_message "stackify.LogGroup.Log.Error" do
+    optional :environment_detail, :message, 1, "stackify.LogGroup.Log.Error.EnvironmentDetail"
+    optional :date_millis, :int64, 2
+    optional :error_item, :message, 3, "stackify.LogGroup.Log.Error.ErrorItem"
+    optional :web_request_detail, :message, 4, "stackify.LogGroup.Log.Error.WebRequestDetail"
+    map :server_variables, :string, :string, 5
+    optional :customer_name, :string, 6
+    optional :username, :string, 7
+  end
+  add_message "stackify.LogGroup.Log.Error.EnvironmentDetail" do
+    optional :device_name, :string, 1
+    optional :application_name, :string, 2
+    optional :application_location, :string, 3
+    optional :configured_application_name, :string, 4
+    optional :configured_environment_name, :string, 5
+  end
+  add_message "stackify.LogGroup.Log.Error.ErrorItem" do
+    optional :message, :string, 1
+    optional :error_type, :string, 2
+    optional :error_type_code, :string, 3
+    map :data, :string, :string, 4
+    optional :source_method, :string, 5
+    repeated :stacktrace, :message, 6, "stackify.LogGroup.Log.Error.ErrorItem.TraceFrame"
+    optional :inner_error, :message, 7, "stackify.LogGroup.Log.Error.ErrorItem"
+  end
+  add_message "stackify.LogGroup.Log.Error.ErrorItem.TraceFrame" do
+    optional :code_filename, :string, 1
+    optional :line_number, :int32, 2
+    optional :method, :string, 3
+  end
+  add_message "stackify.LogGroup.Log.Error.WebRequestDetail" do
+    optional :user_ip_address, :string, 1
+    optional :http_method, :string, 2
+    optional :request_protocol, :string, 3
+    optional :request_url, :string, 4
+    optional :request_url_root, :string, 5
+    optional :referral_url, :string, 6
+    map :headers, :string, :string, 7
+    map :cookies, :string, :string, 8
+    map :querystring, :string, :string, 9
+    map :post_data, :string, :string, 10
+    map :session_data, :string, :string, 11
+    optional :post_data_raw, :string, 12
+    optional :mvc_action, :string, 13
+    optional :mvc_controller, :string, 14
+    optional :mvc_area, :string, 15
+  end
+end
+
+module Stackify
+  LogGroup = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup").msgclass
+  LogGroup::Container = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Container").msgclass
+  LogGroup::Kubernetes = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Kubernetes").msgclass
+  LogGroup::Log = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Log").msgclass
+  LogGroup::Log::Error = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Log.Error").msgclass
+  LogGroup::Log::Error::EnvironmentDetail = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Log.Error.EnvironmentDetail").msgclass
+  LogGroup::Log::Error::ErrorItem = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Log.Error.ErrorItem").msgclass
+  LogGroup::Log::Error::ErrorItem::TraceFrame = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Log.Error.ErrorItem.TraceFrame").msgclass
+  LogGroup::Log::Error::WebRequestDetail = Google::Protobuf::DescriptorPool.generated_pool.lookup("stackify.LogGroup.Log.Error.WebRequestDetail").msgclass
+end

data/lib/stackify-api-ruby.rb

@@ -2,11 +2,13 @@ require 'stackify/version'
 require 'stackify/utils/methods'
 require 'core_ext/core_ext' unless defined? Rails
 
+
 module Stackify
 
   INTERNAL_LOG_PREFIX = '[Stackify]'.freeze
   STATUSES = { working: 'working', terminating: 'terminating', terminated: 'terminated'}
   MODES = { logging: :logging, metrics: :metrics, both: :both }
+  TRANSPORT = [DEFAULT = 'default', UNIX_SOCKET = 'agent_socket', AGENT_HTTP = 'agent_http']
 
   autoload :Backtrace,            'stackify/utils/backtrace'
   autoload :MsgObject,            'stackify/utils/msg_object'
@@ -24,7 +26,12 @@ module Stackify
   autoload :AddMsgWorker,         'stackify/workers/add_msg_worker'
   autoload :MsgsQueue,            'stackify/msgs_queue'
   autoload :LoggerClient,         'stackify/logger_client'
+  autoload :AgentClient,          'stackify/agent_client'
+  autoload :TransportSelector,    'stackify/transport_selector'
   autoload :LogsSender,           'stackify/logs_sender'
+  autoload :AgentBaseSender,      'stackify/agent_base_sender'
+  autoload :UnixSocketSender,     'stackify/unix_socket_sender'
+  autoload :AgentHTTPSender,      'stackify/agent_http_sender'
   autoload :LoggerProxy,          'stackify/logger_proxy'
   autoload :StackifiedError,      'stackify/error'
   autoload :StringException,      'stackify/error'
@@ -44,6 +51,7 @@ module Stackify
     def setup
       @workers = []
       yield(configuration) if block_given?
+      configuration.validate_transport_type
       if configuration.is_valid?
         @status = STATUSES[:working]
       else
@@ -53,7 +61,6 @@ module Stackify
         end
         raise msg
       end
-
     end
 
     def msgs_queue
@@ -64,8 +71,16 @@ module Stackify
       @logger_client ||= Stackify::LoggerClient.new
     end
 
-    def logs_sender
-      @logs_sender ||= Stackify::LogsSender.new
+    def agent_client
+      @agent_client ||= Stackify::AgentClient.new
+    end
+
+    def get_transport
+      @logger_client.get_transport
+    end
+
+    def send_unix_socket
+      @unix_socket ||= Stackify::UnixSocketSender.new
     end
 
     def logger
@@ -105,24 +120,42 @@ module Stackify
 
     def run
       Stackify::Utils.is_api_enabled
+      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?
-          at_exit { make_remained_job }
-           t1 = Thread.new { Stackify.authorize }
-          case Stackify.configuration.mode
-          when MODES[:both]
-            t2 = start_logging
-            t3 = start_metrics
-          when MODES[:logging]
-            t2 = start_logging
-          when MODES[:metrics]
-            t3 = start_metrics
+          # check transport types
+          case Stackify.configuration.transport
+          when Stackify::DEFAULT
+            if Stackify.is_valid?
+              at_exit { make_remained_job }
+              t1 = Thread.new { Stackify.authorize }
+              case Stackify.configuration.mode
+              when MODES[:both]
+                t2 = start_logging
+                t3 = start_metrics
+              when MODES[:logging]
+                t2 = start_logging
+              when MODES[:metrics]
+                t3 = start_metrics
+              end
+              t1.join
+              t3.join if t3
+            else
+              Stackify.log_internal_error "Stackify is not properly configured! Errors: #{Stackify.configuration.errors}"
+            end
+          when Stackify::UNIX_SOCKET, Stackify::AGENT_HTTP
+            case Stackify.configuration.mode
+            when MODES[:logging]
+              start_logging
+            when MODES[:both]
+              start_logging
+              start_metrics
+            when MODES[:metrics]
+              start_metrics
+            end
+          else
+            Stackify.log_internal_error "Stackify is not properly configured! Errors: #{Stackify.configuration.errors}"
           end
-
-          t1.join
-          t3.join if t3
-        else
-          Stackify.log_internal_error "Stackify is not properly configured! Errors: #{Stackify.configuration.errors}"
         end
       end
     end

data/lib/stackify/agent_base_sender.rb

@@ -0,0 +1,53 @@
+#
+# This class will handle the sending of log group message to agent
+#
+module Stackify
+  class AgentBaseSender < Worker
+
+    # send_logs() Function to put the msg in the Worker
+    def send_logs msgs, attempts = 3
+      worker = Stackify::LogsSenderWorker.new('UnixSocketSender worker')
+      task = send_logs_task attempts, msgs
+      worker.async_perform ScheduleDelay.new, task
+    end
+
+    private
+
+    def properties
+      {
+        success_condition: lambda { |result| result.try(:status) == 200 },
+        limit: 1
+      }.dup
+    end
+
+    def send_logs_task attempts = nil, msgs
+      properties[:attempts] = attempts if attempts
+      Stackify::ScheduleTask.new properties do
+        data = gather_and_pack_data(msgs).to_json
+        send_request data
+      end
+    end
+
+    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
+      raise NotImplementedError
+    end
+  end
+end

data/lib/stackify/agent_client.rb

@@ -0,0 +1,102 @@
+module Stackify
+  class AgentClient
+
+    def initialize
+      Stackify.internal_log :info, '[AgentClient]: initialize()'
+      @@errors_governor = Stackify::ErrorsGovernor.new
+      case Stackify.configuration.transport
+        when Stackify::UNIX_SOCKET
+          @@sender = Stackify::UnixSocketSender.new
+        when Stackify::AGENT_HTTP
+          @@sender = Stackify::AgentHTTPSender.new
+        end
+    end
+
+    def log level, msg, call_trace, task
+      if acceptable?(level, msg) && Stackify.working?
+        worker = Stackify::AddMsgWorker.new
+        worker.async_perform ScheduleDelay.new, task
+      end
+    end
+
+    def log_exception level= :error, ex, task
+      if ex.is_a?(Stackify::StackifiedError)
+        if acceptable?(level, ex.message) && Stackify.working?
+          if @@errors_governor.can_send? ex
+            worker = Stackify::AddMsgWorker.new
+            worker.async_perform ScheduleDelay.new, task
+          else
+            Stackify.internal_log :warn,
+            "AgentClient: logging of exception with message \"#{ex.message}\" is skipped - flood_limit is exceeded"
+          end
+        end
+      else
+        Stackify.log_internal_error 'AgentClient: log_exception should get StackifiedError object'
+      end
+    end
+
+    def has_error msg
+      !msg['Ex'].nil?
+    end
+
+    def get_epoch msg
+      msg['EpochMs']
+    end
+
+    def send_logs msgs, attempts = 3
+      @@sender.send_logs msgs, attempts
+    end
+
+    def log_message_task level, msg, call_trace, trans_id=nil, log_uuid=nil
+      Stackify::ScheduleTask.new ({limit: 1}) do
+        if %w(error fatal).include?(level)
+          ex = if ruby_exception?(msg) && msg.class != Class
+            msg.set_backtrace(call_trace)
+            msg
+          else
+            e = StringException.new(msg)
+            e.set_backtrace(call_trace)
+            e
+          end
+          ex = StackifiedError.new(ex, binding())
+          Stackify.msgs_queue << Stackify::MsgObject.new(level, ex.message, caller[0], trans_id, log_uuid, ex).to_h
+        else
+          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::MsgObject.new(level, ex.message, caller[0], trans_id, log_uuid, ex).to_h
+      end
+    end
+
+    private
+
+    def acceptable? level, msg
+      Stackify.is_valid? && is_correct_log_level?(level) &&
+        is_not_internal_log_message?(msg)
+    end
+
+    def is_not_internal_log_message? msg
+      msg.try(:index, ::Stackify::INTERNAL_LOG_PREFIX).nil?
+    end
+
+    def is_correct_log_level? level
+      config_level = Logger.const_get Stackify.configuration.log_level.to_s.upcase
+      current_level = Logger.const_get level.to_s.upcase
+      current_level >= config_level
+    end
+
+    def ruby_exception? klass
+      klass = klass.class == Class ? klass : klass.class
+      klasses = [klass]
+      while klass != Object do
+        klasses << klass.superclass
+        klass = klass.superclass
+      end
+      klasses.include?(Exception)
+    end
+  end
+end

data/lib/stackify/agent_http_sender.rb

@@ -0,0 +1,39 @@
+require 'uri'
+require 'faraday'
+require 'ostruct'
+
+#
+# This class will handle the sending of log messages to agent using http request
+#
+module Stackify
+  class AgentHTTPSender < AgentBaseSender
+
+    HEADERS = {
+      'Content-Type' => 'application/json'
+    }
+
+    # send_request() This function will post an http request
+    # @msgs {Object} log group message
+    # return {Object} Return an object {status, message}
+    def send_request log_group
+      begin
+        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 = log_group
+        end
+        if @response.try(:status) == 200
+          Stackify.internal_log :debug, "[AgentHTTPSender]: Successfully send message via http request."
+          return OpenStruct.new({status: 200, msg: 'OK'})
+        else
+          Stackify.internal_log :debug, "[AgentHTTPSender] Sending failed."
+          return OpenStruct.new({status: 500, msg: 'Not OK'})
+        end
+      rescue => exception
+        Stackify.log_internal_error "[AgentHTTPSender] send_logs() Error: #{exception}"
+        return OpenStruct.new({status: 500, msg: exception})
+      end
+    end
+  end
+end

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