r7insight 2.7.6 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 99fdb5e8d382903830d4fe7a900265680ffe2043
-  data.tar.gz: 23aa014dea96d8c561bcea19df816e1b8aacc688
+  metadata.gz: 1a2c177685e8729322134332c2600df2f39128bc
+  data.tar.gz: 60f673c54746ce17be74ed6519b60940646d11d0
 SHA512:
-  metadata.gz: dde6bee24ffa5e36aad3c0ef2116fa03b9750bf4de2e116243cf2b2fbcd684eff878d1fa7df95c2560f81c5044ed39159c45a3e17772435e27b23be43d387775
-  data.tar.gz: 7965e50f8d28da7ff37a55d9bafa2e0e4f8338043ce4e05a2fc196b7ae0640242c6b617301097e00b08f00a3de829b7ae213dad9fbd4f248bfcea4622bfefa4d
+  metadata.gz: bc374752238269cf845c8d624389c9e37b37323bb6ceab803afe3ade0246c5194333aeec9b68da18e5d57b3c25dc0a93db7714c438a0579aed00fe8581c78838
+  data.tar.gz: 13b808f2ada9e6e8385cb9331febba3aa496956261a9854833c7d4dbbf2ad16a890fab590ff2e225feef23d692bb1b60ed70b0a261578f4d38cd96c5e70444b3

data/.gitignore

@@ -50,3 +50,10 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+
+# IDEs
+.vscode
+.idea
+
+# ruby plugins
+.rakeTasks

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+  - 2.6.5
+  - 2.5
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+script:
+  - make test
+

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing to r7insight_ruby
+
+:+1::tada: Thanks for taking the time to contribute! :tada::+1:
+
+## Requirements
+
+In order to work on this repository you will require:
+- ruby version `2.6.5`
+- bundle version `2.0.2`
+- gem version `3.0.6`
+- rvm version `1.29.9`
+
+## Workflow
+
+- Fork repository in GitHub
+- Clone your repository fork
+- Implement functionality
+- `make test` for testing
+- Add extra tests and documentation if required
+- Push into your fork and create a pull request into the main Rapid7 repository
+- Once pull request is approved `make bump-(major|minor|patch)` for bumping versions (use [SemVer](https://semver.org/))
+- Push again into the branch
+- Pull request should get approved and merged
+
+### Deployment information for Rapid7 developers
+- Pull down the merged master which includes the Pull request changes
+- `make build`
+- `gem push r7insight<VERSION>.gem`
+- Create a new release in GitHub with the correct version tag
+
+JetBrains RubyMine was used to develop this gem.  

data/Gemfile

@@ -1,3 +1,5 @@
 source 'https://rubygems.org'
 
+ruby '>= 2.5.0'
+
 gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    r7insight (3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    concurrent-ruby (1.1.5)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.12.2)
+    rake (13.0.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 6.0.0)
+  bundler (~> 2.0.0)
+  minitest (~> 5.12.2)
+  r7insight!
+  rake (~> 13.0.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2014 Logentries
+Copyright (c) 2019 Rapid7
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,34 @@
+.PHONY: test build bump-major bump-minor bump-patch help
+.DEFAULT_GOAL := help
+
+test: ## Run the unit tests
+	bundle exec rake --trace
+
+build: ## Build the ruby gem
+	gem build r7insight.gemspec
+
+bump-major: ## Bump the major version (1.0.0 -> 2.0.0)
+	@which bump || (echo "You do not have 'bump' installed or in your PATH.\n" \
+		"Please run 'gem install bump'\n" "GitHub: https://github.com/gregorym/bump" && false)
+	@bump major
+
+bump-minor: ## Bump the minor version (0.1.0 -> 0.2.0)
+	@which bump || (echo "You do not have 'bump' installed or in your PATH.\n" \
+		"Please run 'gem install bump'\n" "GitHub: https://github.com/gregorym/bump" && false)
+	@bump minor
+
+bump-patch: ## Bump the patch version (0.0.1 -> 0.0.2)
+	@which bump || (echo "You do not have 'bump' installed or in your PATH.\n" \
+		"Please run 'gem install bump'\n" "GitHub: https://github.com/gregorym/bump" && false)
+	@bump patch
+
+help: ## Shows help
+	@IFS=$$'\n' ; \
+    help_lines=(`fgrep -h "##" ${MAKEFILE_LIST} | fgrep -v fgrep | sed -e 's/\\$$//'`); \
+    for help_line in $${help_lines[@]}; do \
+        IFS=$$'#' ; \
+        help_split=($$help_line) ; \
+        help_command=`echo $${help_split[0]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \
+        help_info=`echo $${help_split[2]} | sed -e 's/^ *//' -e 's/ *$$//'` ; \
+        printf "%-30s %s\n" $$help_command $$help_info ; \
+    done

data/README.md

@@ -1,8 +1,8 @@
-Logging to InsightOps in Ruby
-=============================
+Logging to Rapid7 Insight Platform in Ruby
+==========================================
 
 [![Build Status](https://travis-ci.org/rapid7/r7insight_ruby.svg?branch=master)](https://travis-ci.org/rapid7/r7insight_ruby)
-This is a Rapid7 library for logging from Ruby platforms to InsightOps, including Heroku.
+This is a library for logging from Ruby platforms to the Rapid7 Insight Platform, including Heroku.
 
 It is available on github <https://github.com/rapid7/r7insight_ruby/> and rubygems
 <http://rubygems.org/>.
@@ -15,13 +15,12 @@ Example
     Rails.logger.warn("warning message")
     Rails.logger.debug("debug message")
 
-
 Howto
 -----
 
-You must first register your account details with Rapid7 InsightOps.
+You must first register your account on the Rapid7 Insight Platform.
 
-Once you have logged in to InsightOps, create a new host with a name of your choice.
+Once you have logged into the platform, create a new host with a name of your choice.
 Inside this host, create a new logfile, selecting `Token TCP` (or `Plain TCP/UDP` if using UDP)
 as the source type.
 
@@ -40,43 +39,51 @@ Then from the cmd line run the following command:
 
 This will install the gem on your local environment.
 
-The next step is to configure the default rails logger to use the insightops logger.  
+The next step is to configure the default rails logger to use the Rapid7 Insight Platform logger.  
+Ensure you add a `require` to load in the package:
 
+    require 'r7_insight.rb'
 
 In your environment configuration file ( for production : `config/environments/production.rb`), add the following:
 
-    Rails.logger = Le.new('LOG_TOKEN', 'REGION')
+    Rails.logger = R7Insight.new('LOG_TOKEN', 'REGION')
 
 If you want to keep logging locally in addition to sending logs to in, just add local parameter after the key.
 By default, this will write to the standard Rails log or to STDOUT if not using Rails:
 
-    Rails.logger = Le.new('LOG_TOKEN', 'REGION', :local => true)
+    Rails.logger = R7Insight.new('LOG_TOKEN', 'REGION', :local => true)
 
 You may specify the local log device by providing a filename (String) or IO object (typically STDOUT, STDERR, or an open file):
 
-    Rails.logger = Le.new('LOG_TOKEN', 'REGION', :local => 'log/my_custom_log.log')
+    Rails.logger = R7Insight.new('LOG_TOKEN', 'REGION', :local => 'log/my_custom_log.log')
 
-If you want the gem to use SSL when streaming logs to insightops, add the ssl parameter and set it to true:
+If you want the gem to use SSL when streaming logs to the Rapid7 Insight Platform, add the ssl parameter and set it to true:
 
-    Rails.logger = Le.new('LOG_TOKEN', 'REGION', :ssl => true)
+    Rails.logger = R7Insight.new('LOG_TOKEN', 'REGION', :ssl => true)
 
 If you want to print debug messages for the gem to a file called r7insightGem.log, add this:
 
-	Rails.logger = Le.new('LOG_TOKEN', 'REGION', :debug => true)
+	Rails.logger = R7Insight.new('LOG_TOKEN', 'REGION', :debug => true)
 
 If you want to use ActiveSupport::TaggedLogging logging, add this:
 
-    Rails.logger = Le.new('LOG_TOKEN', 'REGION', :tag => true)
+    Rails.logger = R7Insight.new('LOG_TOKEN', 'REGION', :tag => true)
 
 You can also specify the default level of the logger by adding a :
 
-    Rails.logger = Le.new('LOG_TOKEN', 'REGION', :log_level => Logger::<level>)
+    Rails.logger = R7Insight.new('LOG_TOKEN', 'REGION', :log_level => Logger::<level>)
 
-For the `LOG_TOKEN` argument, paste the token for the logfile you created earlier in the InsightOps UI or empty string for
+For the `LOG_TOKEN` argument, paste the token for the logfile you created earlier in the Rapid7 Insight UI or empty string for
 a UDP connection.
 
-For the `REGION` argument, provide the region of your account, e.g: 'eu', 'us'.
+For the `REGION` argument, provide the region of your account, e.g: 'eu', 'us' etc.
 
 Additionally, when connecting via UDP, be sure to specify a port using the udp_port parameter:
 
-    Rails.logger = Le.new('', 'REGION' :udp_port => 13287)
+    Rails.logger = R7Insight.new('', 'REGION' :udp_port => 13287)
+
+
+Contact Support
+------
+
+Please email our support team at support@rapid7.com if you need any help.

data/Rakefile

@@ -1,16 +1,18 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs = ['lib','test']
-  t.test_files = Dir.glob("test/**/*_spec.rb").sort
+  t.libs = %w[lib test]
+  t.test_files = Dir.glob('test/**/*_spec.rb').sort
   t.verbose = true
 end
 
-task :default => [:test]
-task :spec => [:test]
+task default: [:test]
+task spec: [:test]
 
-desc "Open an irb session preloaded with this library"
+desc 'Open an irb session preloaded with this library'
 task :console do
-  sh "irb -rubygems -I lib -r le.rb"
+  sh 'irb -rubygems -I lib -r r7_insight.rb'
 end

data/lib/{le.rb → r7_insight.rb}

@@ -1,11 +1,12 @@
-require File.join(File.dirname(__FILE__), 'le', 'host')
+# frozen_string_literal: true
 
-require 'logger'
-
-module Le
+require File.join(File.dirname(__FILE__), 'r7_insight', 'host')
 
-  def self.new(token, region, options={})
+require 'logger'
 
+# Rapid7 Insight Platform Ruby Logging functionality
+module R7Insight
+  def self.new(token, region, options = {})
     opt_local     = options[:local]                     || false
     opt_debug     = options[:debug]                     || false
     opt_ssl       = !options.include?(:ssl) ? true : options[:ssl]
@@ -13,21 +14,18 @@ module Le
     opt_log_level = options[:log_level]                 || Logger::DEBUG
 
     opt_datahub_enabled = options[:datahub_enabled]     || false
-    opt_datahub_endpoint = options[:datahub_endpoint]   || ['', 10000]
-    opt_datahub_ip = options[:datahub_ip]               || ''
-    opt_datahub_port    = options[:datahub_port]        || 10000
+    opt_datahub_endpoint = options[:datahub_endpoint]   || ['', 10_000]
     opt_host_id = options[:host_id] || ''
-    opt_host_name_enabled = options[:host_name_enabled] || false
-    opt_host_name = options[:host_name]                 || ''
     opt_custom_host = options[:custom_host]             || [false, '']
 
     opt_udp_port = options[:udp_port]                   || nil
     opt_use_data_endpoint = options[:data_endpoint]     || false
 
-    self.checkParams(token, region, opt_datahub_enabled, opt_udp_port)
+    check_params(token, region, opt_datahub_enabled, opt_udp_port)
 
-
-    host = Le::Host.new(token, region, opt_local, opt_debug, opt_ssl, opt_datahub_endpoint, opt_host_id, opt_custom_host, opt_udp_port, opt_use_data_endpoint)
+    host = R7Insight::Host.new(token, region, opt_local, opt_debug, opt_ssl,
+                               opt_datahub_endpoint, opt_host_id, opt_custom_host,
+                               opt_udp_port, opt_use_data_endpoint)
 
     if defined?(ActiveSupport::TaggedLogging) &&  opt_tag
       logger = ActiveSupport::TaggedLogging.new(Logger.new(host))
@@ -44,22 +42,15 @@ module Le
     logger
   end
 
-  def self.checkParams(token, region, opt_datahub_enabled, opt_udp_port)
-    # Check if the key is valid UUID format
+  def self.check_params(token, region, opt_datahub_enabled, opt_udp_port)
+    # test Token only when DataHub and UDP are not enabled
+    return unless !opt_datahub_enabled && !opt_udp_port
 
-    if (!opt_datahub_enabled && !opt_udp_port)  # test Token only when DataHub and UDP are not enabled
-      if (token =~ /\A(urn:uuid:)?[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}\z/i) == nil
-         puts "\nLE: It appears the LOGENTRIES_TOKEN you entered is invalid!\n"
-      else
-        (token="")
-      end
-
-      # This checks if region is valid. So far we have Europe and US
-      if !region
-        puts "\nLE: You need to specify region. Options: eu, us"
-      end
+    # Check if the key is valid UUID format
+    if (token =~ /\A(urn:uuid:)?[\da-f]{8}-([\da-f]{4}-){3}[\da-f]{12}\z/i).nil?
+      puts "\nLE: It appears the R7INSIGHT_TOKEN you entered is invalid!\n"
+    end
 
-   end
+    puts "\nLE: You need to specify region, such as 'eu'" unless region
   end
-
 end

data/lib/{le → r7_insight}/host.rb

@@ -1,15 +1,20 @@
-module Le
-  module Host
+# frozen_string_literal: true
 
-    def self.new(token, region, local, debug, ssl, datahub_endpoint, host_id, custom_host, udp_port, use_data_endpoint)
-      Le::Host::CONNECTION.new(token, region, local, debug, ssl, datahub_endpoint, host_id, custom_host, udp_port, use_data_endpoint)
+module R7Insight
+  # Rapid7 Insight Platform Logging Host
+  module Host
+    def self.new(token, region, local, debug, ssl, datahub_endpoint, host_id,
+                 custom_host, udp_port, use_data_endpoint)
+      R7Insight::Host::CONNECTION.new(token, region, local, debug, ssl,
+                                      datahub_endpoint, host_id, custom_host,
+                                      udp_port, use_data_endpoint)
     end
 
+    # Log formatter
     module InstanceMethods
       def formatter
         proc do |severity, datetime, _, msg|
-          message = "#{datetime} "
-          message << format_message(msg, severity)
+          "#{datetime} #{format_message(msg, severity)}"
         end
       end
 
@@ -19,7 +24,6 @@ module Le
         "severity=#{severity}, #{message_in.lstrip}"
       end
     end
-
   end
 end
 

data/lib/r7_insight/host/connection.rb

@@ -0,0 +1,300 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'openssl'
+require 'timeout'
+require 'uri'
+
+module R7Insight
+  module Host
+    # Class for connecting to the Rapid7 Insight Platform and handling the
+    # connection
+    class CONNECTION
+      DATA_ENDPOINT = '.data.logs.insight.rapid7.com'
+      DATA_PORT_UNSECURE = 80
+      DATA_PORT_SECURE = 443
+      API_SSL_PORT = 20_000
+      SHUTDOWN_COMMAND = 'DIE!DIE!' # magic shutdown command string for worker
+      SHUTDOWN_MAX_WAIT = 10 # max seconds to wait for queue shutdown clearing
+      SHUTDOWN_WAIT_STEP = 0.2 # sleep duration (seconds) while shutting down
+      CONNECTION_EXCEPTIONS = [
+        Timeout::Error,
+        Errno::EHOSTUNREACH,
+        Errno::ECONNREFUSED,
+        Errno::ECONNRESET,
+        Errno::ETIMEDOUT,
+        EOFError,
+        Errno::EPIPE
+      ].freeze
+
+      include R7Insight::Host::InstanceMethods
+      attr_accessor :token, :region, :queue, :started, :thread, :conn, :local,
+                    :debug, :ssl, :datahub_enabled, :datahub_ip, :datahub_port,
+                    :datahub_endpoint, :host_id, :host_name_enabled, :host_name,
+                    :custom_host, :udp_port, :use_data_endpoint
+
+      def initialize(token, region, local, debug, ssl, datahub_endpoint,
+                     host_id, custom_host, udp_port, use_data_endpoint)
+        if local
+          device = if local.class <= TrueClass
+                     if defined?(Rails)
+                       Rails.root.join('log', "#{Rails.env}.log")
+                     else
+                       STDOUT
+                     end
+                   else
+                     local
+                   end
+          @logger_console = Logger.new(device)
+        end
+
+        @region = region
+        @local = local.nil? || local == false ? false : true # Replace "!!"
+        @debug = debug
+        @ssl = ssl
+        @udp_port = udp_port
+        @use_data_endpoint = use_data_endpoint
+
+        @datahub_endpoint = datahub_endpoint
+        if !@datahub_endpoint[0].empty?
+          @datahub_enabled = true
+          @datahub_ip = (@datahub_endpoint[0]).to_s
+          @datahub_port = @datahub_endpoint[1]
+        else
+          @datahub_enabled = false
+        end
+
+        if @datahub_enabled && @ssl
+          puts("\n\nYou Cannot have DataHub and SSL enabled at the same time.
+ Please set SSL value to false in your environment.rb file or used Token-Based
+ logging by leaving the Datahub IP address blank. Exiting application. \n\n")
+          exit
+        end
+
+        # Check if region was specified
+        puts("\n\nYou need to specify a region, such as 'eu'") if region.empty?
+
+        # Check if DataHub is enabled
+        # If datahub is not enabled, set the token to the token's parameter
+        # If DH is enabled, make the token empty.
+        if !datahub_enabled
+          @token = token
+        else
+          @token = ''
+
+          # !NOTE THIS @datahub_port conditional MAY NEED TO BE CHANGED IF SSL
+          # CAN'T WORK WITH DH
+          @datahub_port = @datahub_port.empty? ? API_SSL_PORT : datahub_port
+          @datahub_ip = datahub_ip
+        end
+
+        @host_name_enabled = custom_host[0]
+        @host_name = custom_host[1]
+
+        if !host_id.empty?
+          @host_id = host_id
+          @host_id = "host_id=#{host_id}"
+        else
+          @host_id = ''
+        end
+
+        #  If no host name is given but required, assign the machine name
+        if @host_name_enabled
+          @host_name = Socket.gethostname if host_name.empty?
+
+          @host_name = "host_name=#{@host_name}"
+        end
+
+        @queue = Queue.new
+        @started = false
+        @thread = nil
+
+        init_debug if @debug
+        at_exit { shutdown! }
+      end
+
+      def init_debug
+        file_path = 'r7insightGem.log'
+        file_path = 'log/r7insightGem.log' if File.exist?('log/')
+        @debug_logger = Logger.new(file_path)
+      end
+
+      def dbg(message)
+        @debug_logger.add(Logger::Severity::DEBUG, message) if @debug
+      end
+
+      def write(message)
+        message = "#{message} #{host_id}" unless host_id.empty?
+        message = "#{message} #{host_name}" if host_name_enabled
+
+        @logger_console.add(Logger::Severity::UNKNOWN, message) if @local
+
+        @queue << if message.scan(/\n/).empty?
+                    "#{@token} #{message} \n"
+                  else
+                    "#{message.gsub(/^/, "#{@token} [#{random_message_id}]")}\n"
+                  end
+
+        if @started
+          check_async_thread
+        else
+          start_async_thread
+        end
+      end
+
+      def start_async_thread
+        @thread = Thread.new { run }
+        dbg 'R7Insight: Asynchronous socket writer started'
+        @started = true
+      end
+
+      def check_async_thread
+        @thread = Thread.new { run } unless @thread&.alive?
+      end
+
+      def close
+        dbg 'R7Insight: Closing asynchronous socket writer'
+        @started = false
+      end
+
+      def open_connection
+        dbg 'R7Insight: Reopening connection to R7Insight API server'
+
+        if @use_data_endpoint
+          host = @region + DATA_ENDPOINT
+
+          port = @ssl ? DATA_PORT_SECURE : DATA_PORT_UNSECURE
+        elsif @udp_port
+          host = @region + DATA_ENDPOINT
+          port = @udp_port
+        elsif @datahub_enabled
+          host = @datahub_ip
+          port = @datahub_port
+        else
+          host = @region + DATA_ENDPOINT
+          port = @ssl ? DATA_PORT_SECURE : DATA_PORT_UNSECURE
+        end
+
+        if @udp_port
+          @conn = UDPSocket.new
+          @conn.connect(host, port)
+        else
+          socket = TCPSocket.new(host, port)
+
+          if @ssl
+            cert_store = OpenSSL::X509::Store.new
+            cert_store.set_default_paths
+
+            ssl_context = OpenSSL::SSL::SSLContext.new
+            ssl_context.cert_store = cert_store
+
+            ssl_context.min_version = OpenSSL::SSL::TLS1_1_VERSION
+            ssl_context.max_version = OpenSSL::SSL::TLS1_3_VERSION
+            ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+            ssl_socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+            ssl_socket.hostname = host if ssl_socket.respond_to?(:hostname=)
+            ssl_socket.sync_close = true
+            Timeout.timeout(10) do
+              ssl_socket.connect
+            end
+            @conn = ssl_socket
+          else
+            @conn = socket
+          end
+        end
+
+        dbg 'R7Insight: Connection established'
+      end
+
+      def reopen_connection
+        close_connection
+        root_delay = 0.1
+        loop do
+          begin
+            open_connection
+            break
+          rescue *CONNECTION_EXCEPTIONS
+            dbg "R7Insight: Unable to connect to R7Insight due to timeout
+(#{$ERROR_INFO})"
+          rescue StandardError
+            dbg "R7Insight: Got exception in reopenConnection - #{$ERROR_INFO}"
+            raise
+          end
+          root_delay *= 2
+          root_delay = 10 if root_delay >= 10
+          wait_for = (root_delay + rand(root_delay)).to_i
+          dbg "R7Insight: Waiting for #{wait_for}ms"
+          sleep(wait_for)
+        end
+      end
+
+      def close_connection
+        begin
+          if @conn.respond_to?(:sysclose)
+            @conn.sysclose
+          elsif @conn.respond_to?(:close)
+            @conn.close
+          end
+        rescue StandardError
+          dbg "R7Insight: couldn't close connection, close with exception -
+ #{$ERROR_INFO}"
+        ensure
+          @conn = nil
+        end
+      end
+
+      def run
+        reopen_connection
+
+        loop do
+          data = @queue.pop
+          break if data == SHUTDOWN_COMMAND
+
+          loop do
+            begin
+              @conn.write(data)
+            rescue *CONNECTION_EXCEPTIONS
+              dbg "R7Insight: Connection timeout(#{$ERROR_INFO}), try to reopen
+connection"
+              reopen_connection
+              next
+            rescue StandardError
+              dbg "R7Insight: Got exception in run loop - #{$ERROR_INFO}"
+              raise
+            end
+            break
+          end
+        end
+
+        dbg 'R7Insight: Closing Asynchronous socket writer'
+
+        close_connection
+      end
+
+      private
+
+      def random_message_id
+        @random_message_id_sample_space ||= ('0'..'9').to_a.concat(('A'..'Z')
+                                                                       .to_a)
+        (0..5).map { @random_message_id_sample_space.sample }.join
+      end
+
+      # at_exit handler.
+      # Attempts to clear the queue and terminate the async worker cleanly
+      # before process ends.
+      def shutdown!
+        return unless @started
+
+        dbg "R7Insight: commencing shutdown, queue has #{queue.size} entries to clear"
+        queue << SHUTDOWN_COMMAND
+        SHUTDOWN_MAX_WAIT.div(SHUTDOWN_WAIT_STEP).times do
+          break if queue.empty?
+
+          sleep SHUTDOWN_WAIT_STEP
+        end
+        dbg "R7Insight: shutdown complete, queue is #{queue.empty? ? '' : 'not '}
+             empty with #{queue.size} entries"
+      end
+    end
+  end
+end