stackify-api-ruby 1.0.15 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd19881ee793a2b23b9137218fd184427d9a9502efd1b81ba2064f23626d1228
-  data.tar.gz: 9c3757c006c8f013afb097cf8a0cb7e016f1b1314375dfacfe3bd2d87403a9c8
+  metadata.gz: 000465ac09f10d108d71cf5b9441315f01aa42d81b6ff90ce31c053724688536
+  data.tar.gz: 6b151709a6b4e297b3e1655b1de68297a43d65af1866abf034d64f16df04b438
 SHA512:
-  metadata.gz: bee61b9d0b9b18a3ad4db32dd6b7680b3e6c7db50979cdf1a8f9f222c97465c295474f05c757c734fa26b2082a4e5cbdf541083173c295d0bb48071bc64f04db
-  data.tar.gz: 87ac37dd7b3ec51fc91f79eadad7316c587e25ee2e55844a974437cd4ad731c9ece070178ff51366f6132696cc93bd21c2cdb5eaa8c92df46d8b586ef265415d
+  metadata.gz: e42e021203b70b6d43535ea43163b42af23ba4528ef0e7a2a377223541ca3122d0773034e66ad0b6e58b77d9b43ea355456efbcad97b9d2432cf134ab3fcf6c3
+  data.tar.gz: ff51578f76cea1ceed8d89e78570237e2ef0b67266a1f9f92c0f866edd727925ae0a5c0c98c3af662643980a062120e3baef8ffb3cad08cce3310cf91c9015d0

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/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,14 +2,19 @@ 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
 
   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']
 
   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'
@@ -24,7 +29,10 @@ module Stackify
   autoload :AddMsgWorker,         'stackify/workers/add_msg_worker'
   autoload :MsgsQueue,            'stackify/msgs_queue'
   autoload :LoggerClient,         'stackify/logger_client'
+  autoload :UnixSocketClient,     'stackify/unix_socket_client'
+  autoload :TransportSelector,    'stackify/transport_selector'
   autoload :LogsSender,           'stackify/logs_sender'
+  autoload :UnixSocketSender,     'stackify/unix_socket_sender'
   autoload :LoggerProxy,          'stackify/logger_proxy'
   autoload :StackifiedError,      'stackify/error'
   autoload :StringException,      'stackify/error'
@@ -44,6 +52,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 +62,6 @@ module Stackify
         end
         raise msg
       end
-
     end
 
     def msgs_queue
@@ -64,8 +72,16 @@ module Stackify
       @logger_client ||= Stackify::LoggerClient.new
     end
 
-    def logs_sender
-      @logs_sender ||= Stackify::LogsSender.new
+    def unix_socket_client
+      @unix_socket_client ||= Stackify::UnixSocketClient.new
+    end
+
+    def get_transport
+      @logger_client.get_transport
+    end
+
+    def send_unix_socket
+      @unix_socket ||= Stackify::UnixSocketSender.new
     end
 
     def logger
@@ -105,24 +121,43 @@ module Stackify
 
     def run
       Stackify::Utils.is_api_enabled
+      Stackify.internal_log :debug, "Stackify.run = #{Stackify.configuration.transport}"
       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
+            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/logger_client.rb

@@ -3,35 +3,21 @@ module Stackify
 
     def initialize
       @@errors_governor = Stackify::ErrorsGovernor.new
+      @@transport = Stackify::TransportSelector.new(Stackify.configuration.transport).transport
     end
 
     def log level, msg, call_trace
-      Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
-        if acceptable?(level, msg) && Stackify.working?
-          worker = Stackify::AddMsgWorker.new
-          task = log_message_task level, msg, call_trace
-          worker.async_perform ScheduleDelay.new, task
-        end
-      end
+      task = log_message_task level, msg, call_trace
+      @@transport.log level, msg, call_trace, task
     end
 
     def log_exception level= :error, ex
-      if ex.is_a?(Stackify::StackifiedError)
-        Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
-          if acceptable?(level, ex.message) && Stackify.working?
-            if @@errors_governor.can_send? ex
-              worker = Stackify::AddMsgWorker.new
-              task = log_exception_task level, ex
-              worker.async_perform ScheduleDelay.new, task
-            else
-              Stackify.internal_log :warn,
-              "LoggerClient: logging of exception with message \"#{ex.message}\" is skipped - flood_limit is exceeded"
-            end
-          end
-        end
-      else
-        Stackify.log_internal_error 'LoggerClient: log_exception should get StackifiedError object'
-      end
+      task = log_exception_task level, ex
+      @@transport.log_exception level, ex, task
+    end
+
+    def get_transport
+      @@transport
     end
 
     private
@@ -52,39 +38,11 @@ module Stackify
     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
+      @@transport.log_message_task level, msg, call_trace, trans_id, log_uuid
     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
-
-    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)
+      @@transport.log_exception_task level, ex, trans_id, log_uuid
     end
   end
-
 end

data/lib/stackify/logs_sender.rb

@@ -3,13 +3,102 @@ module Stackify
 
     LOGS_URI = URI("#{Stackify.configuration.base_api_url}/Log/Save")
 
+    def initialize
+      @@errors_governor = Stackify::ErrorsGovernor.new
+    end
+
+    def log level, msg, call_trace, task
+      Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
+        if acceptable?(level, msg) && Stackify.working?
+          worker = Stackify::AddMsgWorker.new
+          worker.async_perform ScheduleDelay.new, task
+        end
+      end
+    end
+
+    def log_exception level= :error, ex, task
+      if ex.is_a?(Stackify::StackifiedError)
+        Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
+          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,
+              "LoggerClient: logging of exception with message \"#{ex.message}\" is skipped - flood_limit is exceeded"
+            end
+          end
+        end
+      else
+        Stackify.log_internal_error 'LoggerClient: log_exception should get StackifiedError object'
+      end
+    end
+
+    def has_error msg
+      !msg['Ex'].nil?
+    end
+
+    def get_epoch msg
+      msg['EpochMs']
+    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
+
     def send_logs msgs, attempts = 3
       worker = Stackify::LogsSenderWorker.new
       task = send_logs_task attempts, msgs
       worker.async_perform ScheduleDelay.new, task
     end
 
-  private
+    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
 
     def properties
       {

data/lib/stackify/msgs_queue.rb

@@ -34,7 +34,7 @@ module Stackify
         Stackify.internal_log :info, '[MsgsQueue] All remained logs are going to be sent'
         Stackify.shutdown_all
         if self.length > 0
-          Stackify.logs_sender.send_logs(pop_all)
+          Stackify.get_transport.send_logs(pop_all)
           Stackify.status = Stackify::STATUSES[:terminated]
         end
       end
@@ -47,7 +47,12 @@ module Stackify
         Stackify.internal_log :debug, "[MsgsQueue] add_msg() Newly created worker <#{@worker.name}>"
       end
       self.synchronize do
-        Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
+        case Stackify.configuration.transport
+        when Stackify::DEFAULT
+          Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
+            old_push(msg)
+          end
+        when Stackify::UNIX_SOCKET
           old_push(msg)
         end
       end
@@ -109,13 +114,13 @@ module Stackify
           if length > 0
             msg = pop
             chunk << msg
-            chunk_weight += (msg['Ex'].nil? ? LOG_SIZE : ERROR_SIZE)
-            break if msg['EpochMs'] > started_at || CHUNK_MIN_WEIGHT > 50
+            chunk_weight += Stackify.get_transport.has_error(msg) ? ERROR_SIZE : LOG_SIZE
+            break if Stackify.get_transport.get_epoch(msg) > started_at || CHUNK_MIN_WEIGHT > 50
           else
             break
           end
         end
-        Stackify.logs_sender.send_logs(chunk) if chunk.length > 0
+        Stackify.get_transport.send_logs(chunk) if chunk.length > 0
         chunk_weight
       end
     end

data/lib/stackify/transport_selector.rb

@@ -0,0 +1,17 @@
+module Stackify
+  class TransportSelector
+
+    attr_reader :transport
+
+    def initialize type
+      case type
+      when Stackify::DEFAULT
+        Stackify::Utils.do_only_if_authorized_and_mode_is_on Stackify::MODES[:logging] do
+          @transport = Stackify::LogsSender.new
+        end
+      when Stackify::UNIX_SOCKET
+        @transport = Stackify::UnixSocketClient.new
+      end
+    end
+  end
+end

data/lib/stackify/unix_socket_client.rb

@@ -0,0 +1,97 @@
+module Stackify
+  class UnixSocketClient
+
+    def initialize
+      Stackify.internal_log :info, '[UnixSocketClient]: initialize()'
+      @@errors_governor = Stackify::ErrorsGovernor.new
+      @@sender = Stackify::UnixSocketSender.new
+    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,
+            "UnixSocketClient: logging of exception with message \"#{ex.message}\" is skipped - flood_limit is exceeded"
+          end
+        end
+      else
+        Stackify.log_internal_error 'UnixSocketClient: log_exception should get StackifiedError object'
+      end
+    end
+
+    def has_error msg
+      !msg.error.nil?
+    end
+
+    def get_epoch msg
+      msg.date_millis
+    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::ProtobufLogObject.new(level, ex.message, caller[0], trans_id, log_uuid, ex).to_obj
+        else
+          Stackify.msgs_queue << Stackify::ProtobufLogObject.new(level, msg, caller[0], trans_id, log_uuid).to_obj
+        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
+      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/unix_socket_sender.rb

@@ -0,0 +1,79 @@
+require 'net_http_unix'
+require 'ostruct'
+
+#
+# This class will handle the sending of protobuf message to unix domain socket
+#
+module Stackify
+  class UnixSocketSender < 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 = create_log_group msgs
+        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']
+      log_group.server_name = details['server_name']
+      log_group.application_name = details['app_name']
+      log_group.application_location = details['app_location']
+      log_group.logger = 'Ruby logger'
+      log_group.platform = 'ruby'
+      log_group
+    end
+
+    # send_request() This function will send http request via unix domain socket
+    # @msgs {Object} Protobuf 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.unix_socket_url)
+        req.set_content_type('application/x-protobuf')
+        req.body = message
+        response = client.request(req)
+        Stackify.internal_log :debug, "[UnixSocketSender] status_code = #{response.code}"
+        if response.code.to_i == 200
+          Stackify.internal_log :debug, "[UnixSocketSender]: Successfully send message via unix domain socket."
+          return OpenStruct.new({status: 200, msg: 'OK'})
+        else
+          Stackify.internal_log :debug, "[UnixSocketSender] Sending failed."
+          return OpenStruct.new({status: 500, msg: 'Not OK'})
+        end
+      rescue => exception
+        Stackify.log_internal_error "[UnixSocketSender] send_logs() Error: #{exception}"
+        return OpenStruct.new({status: 500, msg: exception})
+      end
+    end
+  end
+end

data/lib/stackify/utils/configuration.rb

@@ -3,14 +3,16 @@ module Stackify
   class Configuration
 
     attr_accessor :api_key, :app_name, :app_location, :env, :log_level, :logger,
-                  :proxy, :mode, :base_api_url, :api_enabled
+                  :proxy, :mode, :base_api_url, :api_enabled, :transport, :errors
 
-    attr_reader :errors, :send_interval, :flood_limit, :queue_max_size
+    attr_reader :send_interval, :flood_limit, :queue_max_size, :unix_socket_path, :unix_socket_url
 
     def initialize
       @base_api_url = 'https://api.stackify.com'
       @errors = []
+      @app_name = ''
       @api_key = ''
+      @transport = 'default'
       @env = :production
       @flood_limit = 100
       @queue_max_size = 10000
@@ -20,14 +22,25 @@ module Stackify
       @mode = MODES[:both]
       @logger = Logger.new(STDOUT)
       @logger.level = Logger::UNKNOWN
+      @unix_socket_path = '/usr/local/stackify/stackify.sock'
+      @unix_socket_url = '/log'
     end
 
     def is_valid?
-      @errors = []
-      validate_mode if validate_config_types
+      case Stackify.configuration.transport
+      when Stackify::DEFAULT
+        validate_default_transport
+      when Stackify::UNIX_SOCKET
+        validate_unix_domain_socket_transport
+      end
       @errors.empty?
     end
 
+    def validate_transport_type
+      return true if ['agent_socket', 'default'].include? @transport
+      @errors << 'Transport should be one of these values: [agent_socket, default]. Should be a String.'
+    end
+
     private
 
     def validate_config_types
@@ -36,6 +49,27 @@ module Stackify
       validate_mode_type
     end
 
+    # Perform validation if transport type is default
+    # Required parameters are: env, app_name, api_key, log_level
+    def validate_default_transport
+      validate_app_name &&
+      validate_transport_type &&
+      validate_api_key &&
+      validate_env &&
+      validate_log_level &&
+      validate_mode_type
+    end
+
+    # Perform validation if transport type is agent_socket
+    # Required parameters are: env, app_name, log_level
+    def validate_unix_domain_socket_transport
+      validate_env &&
+      validate_transport_type &&
+      validate_app_name &&
+      validate_log_level &&
+      validate_mode_type
+    end
+
     def validate_mode_type
       return true if @mode.is_a? Symbol
       @errors << 'Mode should be a Symbol'
@@ -43,7 +77,17 @@ module Stackify
 
     def validate_api_key
       return true if  @api_key.is_a?(String) && !@api_key.empty?
-      @errors << 'API_KEY should be a String and not empty'
+      @errors << 'Api_key should be a String and not empty'
+    end
+
+    def validate_app_name
+      return true if  @app_name.is_a?(String) && !@app_name.empty?
+      @errors << 'App_name should be a String and not empty'
+    end
+
+    def validate_env
+      return true if  @env.is_a?(Symbol) && !@env.empty?
+      @errors << 'Env should be a Symbol and not empty'
     end
 
     def validate_log_level

data/lib/stackify/utils/methods.rb

@@ -33,4 +33,13 @@ module Stackify::Utils
     found = exclude.select{|e| e =~ /#{cmd}/i}
     Stackify.configuration.api_enabled = false if found.count > 0
   end
+
+  def self.get_app_settings
+    @env = {
+      'env' => Stackify.configuration.env,
+      'app_name' => Stackify.configuration.app_name,
+      'server_name' => Socket.gethostname,
+      'app_location' => Stackify.configuration.app_location || Dir.pwd
+    }
+  end
 end

data/lib/stackify/utils/protobuf_log_object.rb

@@ -0,0 +1,85 @@
+module Stackify
+  class ProtobufLogObject
+    def initialize level, msg, caller_str, trans_id=nil, log_uuid=nil, ex=nil
+      @level, @msg, @caller_str, @ex = level, msg, caller_str, ex, @trans_id = trans_id,
+      @log_uuid = log_uuid
+    end
+
+    # Create a LogMsgGroup Protobuf Object
+    def to_obj
+      begin
+        log = Stackify::LogGroup::Log.new
+        log.message = @msg
+        log.thread_name = Thread.current.object_id.to_s
+        log.date_millis = (Time.now.to_f * 1000).to_i
+        log.level = @level.to_s.upcase!
+        log.source_method = Stackify::Backtrace.method_name(@caller_str).to_s
+        log.source_line = Stackify::Backtrace.line_number(@caller_str).to_i
+        log.transaction_id = @trans_id unless @trans_id.nil?
+        log.id = @log_uuid unless @log_uuid.nil?
+        if @ex.try(:to_h)
+          ex = @ex.try(:to_h)
+          log_error = Stackify::LogGroup::Log::Error.new
+          log_error.date_millis = ex['OccurredEpochMillis'].to_i
+          if ex['EnvironmentDetail']
+            env = ex['EnvironmentDetail']
+            env_detail = Stackify::LogGroup::Log::Error::EnvironmentDetail.new
+            env_detail.device_name = env['DeviceName'].to_s
+            env_detail.application_name = env['AppName'].to_s
+            env_detail.application_location = env['AppLocation'].to_s
+            env_detail.configured_application_name = env['ConfiguredAppName'].to_s
+            env_detail.configured_environment_name = env['ConfiguredEnvironmentName'].to_s
+            log_error.environment_detail = env_detail
+          end
+          if ex['Error']
+            err = ex['Error']
+            error_item = Stackify::LogGroup::Log::Error::ErrorItem.new
+            error_item.message = err['Message'].to_s
+            error_item.error_type = err['ErrorType'].to_s
+            error_item.error_type_code = err['ErrorTypeCode'].to_s
+            if err['Data']
+              map_data = Google::Protobuf::Map.new(:string, :string)
+              err['Data'].each { |key, value| map_data["#{key}"] = value }
+              error_item.data = map_data
+            end
+            error_item.inner_error = err['InnerError']
+            error_item.source_method = err['SourceMethod'].to_s
+            if err['StackTrace']
+              stack = err['StackTrace']
+              stack.each do |stk|
+                trace_frame = Stackify::LogGroup::Log::Error::ErrorItem::TraceFrame.new
+                trace_frame.code_filename = stk['CodeFileName'].to_s
+                trace_frame.line_number = stk['LineNum'].to_i
+                trace_frame.method = stk['Method'].to_s
+                error_item.stacktrace.push(trace_frame)
+              end
+            end
+            log_error.error_item = error_item
+          end
+          if ex['WebRequestDetail']
+            req_details = ex['WebRequestDetail']
+            web_request = Stackify::LogGroup::Log::Error::WebRequestDetail.new
+            web_request.user_ip_address = req_details['UserIPAddress'].to_s
+            web_request.http_method = req_details['HttpMethod'].to_s
+            web_request.request_url = req_details['RequestUrl'].to_s
+            web_request.request_url_root = req_details['RequestUrlRoot'].to_s
+            web_request.referral_url = req_details['ReferralUrl'].to_s
+            web_request.post_data_raw = req_details['PostDataRaw'].to_s
+            log_error.web_request_detail = web_request
+          end
+          if !ex['ServerVariables'].empty?
+            map_server_vars = Google::Protobuf::Map.new(:string, :string)
+            ex['ServerVariables'].each { |key, value| map_server_vars["#{key.to_s}"] = value.to_s }
+            log_error.server_variables = map_server_vars
+          end
+
+          log.error = log_error
+        end
+        log
+      rescue => exception
+        Stackify.internal_log :info, "[ProtobufLogObject] Error: "
+        Stackify.internal_log :info, exception
+      end
+    end
+  end
+end

data/lib/stackify/version.rb

@@ -1,3 +1,3 @@
 module Stackify
-  VERSION = '1.0.15'
+  VERSION = '1.1.0'
 end

data/lib/stackify/workers/logs_sender_worker.rb

@@ -3,6 +3,8 @@ module Stackify
 
     def initialize name = 'LogsSender worker'
       super
+      @name = name
+      @name += " ##{self.id}"
       @type = :logs_send
     end
 

data/stackify-api-ruby.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 0'
   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.0.15
+  version: 1.1.0
 platform: ruby
 authors:
 - Stackify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: google-protobuf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net_http_unix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: Stackify Logs and Metrics API for Ruby
 email:
 - support@stackify.com
@@ -71,6 +99,7 @@ files:
 - lib/core_ext/object.rb
 - lib/generators/stackify/stackify_generator.rb
 - lib/generators/stackify/templates/stackify.rb
+- lib/proto/stackify-agent.rb
 - lib/stackify-api-ruby.rb
 - lib/stackify/authorization/authorizable.rb
 - lib/stackify/authorization/authorization_client.rb
@@ -94,10 +123,14 @@ files:
 - lib/stackify/schedule_delay.rb
 - lib/stackify/schedule_task.rb
 - lib/stackify/scheduler.rb
+- lib/stackify/transport_selector.rb
+- lib/stackify/unix_socket_client.rb
+- lib/stackify/unix_socket_sender.rb
 - lib/stackify/utils/backtrace.rb
 - lib/stackify/utils/configuration.rb
 - lib/stackify/utils/methods.rb
 - lib/stackify/utils/msg_object.rb
+- lib/stackify/utils/protobuf_log_object.rb
 - lib/stackify/version.rb
 - lib/stackify/workers/add_msg_worker.rb
 - lib/stackify/workers/auth_worker.rb