arkaan 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cabcdc8b6578cb29eb81b8ba62909b2a11ebcca1b8e162e8a19364f333f2fdf1
-  data.tar.gz: a8eb6aa1e2c7018adde2531ec96e0597a988ed69f4dc681ec3036e82117a83dc
+  metadata.gz: bde2ac4f9badeeff70fa6534caafb6080a2d0d1f0f1a1a8166ad8b8607bb6bd7
+  data.tar.gz: 95b9406a7be27cf571956a25f15714e3738d23ce2f57bbf9d22ca4cdcaf41faa
 SHA512:
-  metadata.gz: e7a947e5433212e24033c4a1641b2f1d699bb9e7ab9f2964c2adfba0e4e4135100b53daa058411172777f9c7d7991c31c56a86eb09293390891f61855cf68cd8
-  data.tar.gz: 5199e13d68f411c928199f6bb80c08844487ed3e1a6817cfa779b6f9c2f64c4df5beb7d497752da1d48c3d7d52616d93e6d25f0d203dda0847273224ba363e8f
+  metadata.gz: fd2894fdb157d26cbe7b1421566da14cb9f72ee9ca0033bd6e4c2c308f60985c1e09893f4040de08ec45642dae5b0cf36bb71fe1a2c5b83735d82c9354ce5dc7
+  data.tar.gz: fca967434233e4f426ed12a52de45892f555d03ea8288ed2184607ea8392dece9ab517c574996c30b6288b48c44b697dfca6642c2724b37e8013582482624f55

data/lib/arkaan/monitoring.rb

@@ -5,6 +5,7 @@ module Arkaan
     autoload :Action   , 'arkaan/monitoring/action'
     autoload :Gateway  , 'arkaan/monitoring/gateway'
     autoload :Instance , 'arkaan/monitoring/instance'
+    autoload :Results  , 'arkaan/monitoring/results'
     autoload :Route    , 'arkaan/monitoring/route'
     autoload :Service  , 'arkaan/monitoring/service'
     autoload :Vigilante, 'arkaan/monitoring/vigilante'

data/lib/arkaan/monitoring/instance.rb

@@ -27,6 +27,8 @@ module Arkaan
       #   @return [Arkaan::Monitoring::Action] the actions that has been performed on the service.
       embeds_many :actions, class_name: 'Arkaan::Monitoring::Action', inverse_of: :instance
 
+      has_many :heartbeats, class_name: 'Arkaan::Monitoring::Results::Heartbeat', inverse_of: :instance
+
       validates :url,
         presence: {message: 'required'},
         format: {with: /\A(https?:\/\/)((([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*)|(localhost:[0-9]{2,4})\/?)\z/, message: 'pattern', if: :url?}

data/lib/arkaan/monitoring/results.rb

@@ -0,0 +1,10 @@
+module Arkaan
+  module Monitoring
+    # The results module handle classes to make results for the vigilante runs.
+    # @author Vincent Courtois <courtois.vincent@outlook.com>
+    module Results
+      autoload :Report, 'arkaan/monitoring/results/report'
+      autoload :Heartbeat, 'arkaan/monitoring/results/heartbeat'
+    end
+  end
+end

data/lib/arkaan/monitoring/results/heartbeat.rb

@@ -0,0 +1,50 @@
+module Arkaan
+  module Monitoring
+    module Results
+      # A record is the result of the vigilante asking the health of one instance.
+      # @author Vincent Courtois <courtois.vincent@outlook.com>
+      class Heartbeat
+        include Mongoid::Document
+
+        # @!attribute [rw] status
+        #   @return [Integer] the HTTP status of the request made for this record.
+        field :status, type: Integer, default: 500
+        # @!attribute [rw] body
+        #   @return [Hash] the JSON parsed body from the heartbeat request.
+        field :body, type: Hash, default: {}
+        # @!attribute [rw] healthy
+        #   @return [Boolean] TRUE if the instance is deemed healthy, FALSE otherwise.
+        field :healthy, type: Boolean, default: false
+        # @!attribute [rw] started_at
+        #   @return [DateTime] the date at which the heartbeat request has started.
+        field :started_at, type: DateTime
+        # @!attribute [rw] ended_at
+        #   @return [DateTime] the date at which the request was terminated.
+        field :ended_at, type: DateTime
+
+        # @!attribute [rw] instance
+        #   @return [Arkaan::Monitoring::Instance] the instance on which the record has been done.
+        belongs_to :instance, class_name: 'Arkaan::Monitoring::Instance', inverse_of: :heartbeats
+
+        # @!attribute [rw] report
+        #   @return [Arkaan::Monitoring::Results::Report] the report made by the vigilante including this record.
+        belongs_to :report, class_name: 'Arkaan::Monitoring::Results::Report', inverse_of: :heartbeats
+
+        attr_readonly :healthy
+
+        def status=(status)
+          self[:status] = status
+          self[:healthy] = status == 200
+        end
+
+        def start!
+          self.started_at = DateTime.now
+        end
+
+        def end!
+          self.ended_at = DateTime.now
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/monitoring/results/report.rb

@@ -0,0 +1,46 @@
+module Arkaan
+  module Monitoring
+    module Results
+      # A report is the result of one call to the API on one instance status route.
+      # @author Vincent Courtois <courtoi.vincent@outlook.com>
+      class Report
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        field :started_at, type: DateTime
+        # @!attribute [rw] ended_at
+        #   @return [DateTime] the timestamp at which the report ends.
+        field :ended_at, type: DateTime
+        # @!attribute [rw] total
+        #   @return [Integer] the total number of services monitored.
+        field :total, type: Integer, default: 0
+        # @!attribute [rw] healthy
+        #   @return [Integer] the number of healthy services amongst all the monitored services.
+        field :healthy, type: Integer, default: 0
+
+        # @!attribute [rw] records
+        #   @return [Array<Arkaan::Monitoring::Results::Record>] the records linked to this report.
+        has_many :heartbeats, class_name: 'Arkaan::Monitoring::Results::Heartbeat', inverse_of: :report
+        # @!attribute [rw] vigilante
+        #   @return [Arkaan::Monitoring::Vigilante] the vigilante application that has created this report.
+        belongs_to :vigilante, class_name: 'Arkaan::Monitoring::Vigilante', inverse_of: :reports
+
+        def add_heartbeat(heartbeat)
+          self.heartbeats << heartbeat
+          self.total += 1
+          self.healthy += (heartbeat.healthy ? 1 : 0)
+          heartbeat.end!
+        end
+
+        def start!
+          self.started_at = DateTime.now
+        end
+
+        def end!
+          self.ended_at = DateTime.now
+          self.save!
+        end
+      end
+    end
+  end
+end

data/lib/arkaan/monitoring/vigilante.rb

@@ -10,8 +10,39 @@ module Arkaan
       # @!attribute [rw] token
       #   @return [String] the token the vigilante uses to identify himself in the services
       field :token, type: String
+      # @!attribute [rw] max_results
+      #   @return [Integer] the number of results the vigilante should be keeping at any time.
+      #     The oldest result should be erased to not go over the limit
+      field :max_results, type: Integer, default: 20
+
+      # @!attribute [rw] reports
+      #   @return [Array<Arkaan::monitoring::Results::Report>] the report generated by running this vigilante.
+      has_many :reports, class_name: 'Arkaan::Monitoring::Results::Report', inverse_of: :vigilante
 
       validates :token, presence: {message: 'required'}
+
+      validates :max_results, 
+        numericality: {greater_than: 0, message: 'minimum'}
+
+      # Adds a report to the collection of reports by eventually deleting the oldest one.
+      # @param report [Arkaan::Monitoring::Results::Report] the report to add to the vigilante,
+      #   added only if it does not exceed the max number of reports the vigilante can store.
+      def add_report(report)
+        erase_oldest_result if result_full?
+        reports << report
+      end
+
+      # Checks if the list of reports is already full, or if more can be added.
+      # @return [Boolean] TRUE if the number of reports already exceeds the max number.
+      def results_full?
+        reports.to_a.count >= max_results
+      end
+
+      # Erases the oldest results to keep only MAX - 1 results in the list.
+      def erase_oldest_result
+        limit = reports.count + 1 - vigilante.max_results
+        reports.sort_by(created_at: :asc).limit(limit).each(&:delete)
+      end
     end
   end
 end

data/lib/arkaan/version.rb

@@ -1,3 +1,3 @@
 module Arkaan
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: arkaan
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Vincent Courtois
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-07 00:00:00.000000000 Z
+date: 2019-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -330,6 +330,9 @@ files:
 - lib/arkaan/monitoring/action.rb
 - lib/arkaan/monitoring/gateway.rb
 - lib/arkaan/monitoring/instance.rb
+- lib/arkaan/monitoring/results.rb
+- lib/arkaan/monitoring/results/heartbeat.rb
+- lib/arkaan/monitoring/results/report.rb
 - lib/arkaan/monitoring/route.rb
 - lib/arkaan/monitoring/service.rb
 - lib/arkaan/monitoring/vigilante.rb