pampa 2.0.12 → 2.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efa42c22ec0a02a9ae9e1ff633d6b034606a78f944f842cf782b13adeb59242e
-  data.tar.gz: 8efad57c243fc4de08f64d3fd6935d8393fb965cdfe2174749e466d2f571aa4a
+  metadata.gz: 0137672f5c0b7c0cd2be75ddf221d84d65d824c8ba4bdf87b5cfd369bf9eef14
+  data.tar.gz: 7d8bb53cfd11c3d37b69b8408c544f1718fc0178f130f5f16785771e84af9ac9
 SHA512:
-  metadata.gz: '08d7f6166b24bcc2abd501bf62f6acae0d60aefe1283b14bbea5f079bd3a9a6b38307cb80d3dd626a49a5652093d9120793274d4816e9e7a4380c039f95a4ae8'
-  data.tar.gz: 6ec308ec2f54ca6e81c7e3b2089d60fc1fd2c88e36f97ad8dad8dab7231eaf2c2cb62a8d3ed6000d03615315ddbd2fe364b722edd725437b8652427fd5f8dd95
+  metadata.gz: '00540329934fd5d5d22cae40967fee37ba4eba39a4383d324999da4902ea0a8e83c489a320820102ec3c8175a37fdace4a2147b0be490ec22e6c8380ab29f1a2'
+  data.tar.gz: 4efb7d405e0aa5d6a7c6f8b613b83fe14511d2f15a14f9338c48da4676204631a0c99fc34491474571c164779ad730e5820b397f2dc93a3abb3ff5bee6ec1851

data/lib/pampa.rb

@@ -9,6 +9,11 @@ module BlackStack
     module Pampa
         # activate this flag if you want to add pampa nodes to blackstack-deployer.
         @@integrate_with_blackstack_deployer = false 
+        # setup custom locations for config and worker files.
+        @@config_filename = "config.rb"
+        @@worker_filename = "worker.rb"
+        # setu the directory where the worker.rb file will be lauched, and the log files will be stored.
+        @@working_directory = "$HOME/pampa"
         # arrays of workers, nodes, and jobs.
         @@nodes = []
         @@jobs = []
@@ -17,7 +22,43 @@ module BlackStack
         @@logger = BlackStack::DummyLogger.new(nil)
         # Connection string to the database. Example: mysql2://user:password@localhost:3306/database
         @@connection_string = nil
-        
+
+        # @@integrate_with_blackstack_deployer
+        def self.integrate_with_blackstack_deployer()
+            @@integrate_with_blackstack_deployer
+        end
+
+        def self.set_integrate_with_blackstack_deployer(b)
+            @@integrate_with_blackstack_deployer = b
+        end
+
+        # @@config_filename
+        def self.config_filename()
+            @@config_filename
+        end
+
+        def self.set_config_filename(s)
+          @@config_filename = s
+        end
+
+        # @@worker_filename
+        def self.worker_filename()
+          @@worker_filename
+        end
+
+        def self.set_worker_filename(s)
+          @@worker_filename = s
+        end
+
+        ## @@working_directory
+        def self.working_directory()
+          @@working_directory
+        end
+
+        def self.set_working_directory(s)
+          @@working_directory = s
+        end
+
         # define a filename for the log file.
         def self.set_log_filename(s)
             @@log_filename = s
@@ -33,15 +74,6 @@ module BlackStack
           @@logger = l
         end
 
-        # @@integrate_with_blackstack_deployer
-        def self.integrate_with_blackstack_deployer()
-            @@integrate_with_blackstack_deployer
-        end
-
-        def self.set_integrate_with_blackstack_deployer(b)
-            @@integrate_with_blackstack_deployer = b
-        end
-
         # return the log filename.
         def self.log_filename()
             @@log_filename
@@ -297,10 +329,10 @@ module BlackStack
 
         # connect the nodes via ssh.
         # kill all Ruby processes except this one.
-        # rename any existing folder ~/pampa to ~/pampa.<current timestamp>.
-        # create a new folder ~/pampa.
-        # build the file ~/pampa/config.rb in the remote node.
-        # copy the file ~/pampa/worker.rb to the remote node.
+        # rename any existing folder $HOME/pampa to $HOME/pampa.<current timestamp>.
+        # create a new folder $HOME/pampa.
+        # build the file $HOME/pampa/config.rb in the remote node.
+        # copy the file $HOME/pampa/worker.rb to the remote node.
         # run the number of workers specified in the configuration of the Pampa module.
         # return an array with the IDs of the workers.
         #
@@ -308,7 +340,7 @@ module BlackStack
         # - config: relative path of the configuration file. Example: '../config.rb'
         # - worker: relative path of the worker.rb file. Example: '../worker.rb'
         # 
-        def self.deploy(config_filename='./config.rb', worker_filename='./worker.rb')
+        def self.deploy()
             # validate: the connection string is not nil
             raise "The connection string is nil" if @@connection_string.nil?
             # validate: the connection string is not empty
@@ -326,33 +358,33 @@ module BlackStack
                     l.done
                     # kill all ruby processes except this one
                     l.logs("Killing all Ruby processes except this one... ")
-                    `ps ax | grep ruby | grep -v grep | grep -v #{Process.pid} | cut -b3-7 | xargs -t kill;`
+                    node.exec("ps ax | grep ruby | grep -v grep | grep -v #{Process.pid} | cut -b3-7 | xargs -t kill;", false);
                     l.done
                     # rename any existing folder ~/code/pampa to ~/code/pampa.<current timestamp>.
                     l.logs("Renaming old folder... ")
-                    `mv ~/pampa ~/pampa.#{Time.now().to_i.to_s}`
+                    node.exec("mv #{BlackStack::Pampa.working_directory} #{BlackStack::Pampa.working_directory}.#{Time.now().to_i.to_s}", false);
                     l.done
                     # create a new folder ~/code. - ignore if it already exists.
                     l.logs("Creating new folder... ")
-                    `mkdir ~/pampa`
+                    node.exec("mkdir #{BlackStack::Pampa.working_directory}", false);
                     l.done
-                    # build the file ~/pampa/config.rb in the remote node. - Be sure the BlackStack::Pampa.to_hash.to_s don't have single-quotes (') in the string.
+                    # build the file $HOME/pampa/config.rb in the remote node. - Be sure the BlackStack::Pampa.to_hash.to_s don't have single-quotes (') in the string.
                     l.logs("Building config file... ")
-                    s = "echo \"#{File.read(config_filename)}\" > ~/pampa/config.rb"                    
-                    `#{s}`
+                    s = "echo \"#{File.read(config_filename)}\" > #{BlackStack::Pampa.working_directory}/#{BlackStack::Pampa.config_filename}"                    
+                    node.exec("#{s}", false);
                     l.done
-                    # copy the file ~/pampa/worker.rb to the remote node. - Be sure the script don't have single-quotes (') in the string.
+                    # copy the file $HOME/pampa/worker.rb to the remote node. - Be sure the script don't have single-quotes (') in the string.
                     l.logs("Copying worker file... ")
-                    s = "echo \"#{File.read(worker_filename)}\" > ~/pampa/worker.rb"
-                    `#{s}`
+                    s = "echo \"#{File.read(worker_filename)}\" > #{BlackStack::Pampa.working_directory}/#{BlackStack::Pampa.worker_filename}"
+                    node.exec("#{s}", false);
                     l.done
                     # run the number of workers specified in the configuration of the Pampa module.
                     node.workers.each { |worker|
                         # run the worker
                         # add these parameters for debug: debug=yes pampa=~/code/pampa/lib/pampa.rb
                         l.logs "Running worker #{worker.id}... "
-                        s = "nohup ruby worker.rb id=#{worker.id} config=~/pampa/config.rb >/dev/null 2>&1 &" 
-                        `#{s}`
+                        s = "nohup ruby #{BlackStack::Pampa.worker_filename} id=#{worker.id} config=#{BlackStack::Pampa.working_directory}/#{BlackStack::Pampa.config_filename} >/dev/null 2>&1 &" 
+                        node.exec("#{s}", false);
                         l.done
                     }
                     # disconnect the node
@@ -368,7 +400,7 @@ module BlackStack
         # run the number of workers specified in the configuration of the Pampa module.
         # return an array with the IDs of the workers.
         # 
-        def self.start(config_filename='~/pampa/config.rb', worker_filename='~/pampa/worker.rb')
+        def self.start()
           # validate: the connection string is not nil
           raise "The connection string is nil" if @@connection_string.nil?
           # validate: the connection string is not empty
@@ -386,15 +418,23 @@ module BlackStack
                   l.done
                   # kill all ruby processes except this one
                   l.logs("Killing all Ruby processes except this one... ")
-                  `ps ax | grep ruby | grep -v grep | grep -v #{Process.pid} | cut -b3-7 | xargs -t kill;`
+                  node.exec("ps ax | grep ruby | grep -v grep | grep -v #{Process.pid} | cut -b3-7 | xargs -t kill;", true);
                   l.done
                   # run the number of workers specified in the configuration of the Pampa module.
                   node.workers.each { |worker|
                       # run the worker
                       # add these parameters for debug: debug=yes pampa=~/code/pampa/lib/pampa.rb
+                      # run a bash command that sources the .profile file and runs the ruby script in the background, returning immediatelly.
+
                       l.logs "Running worker #{worker.id}... "
-                      s = "nohup ruby #{worker_filename} id=#{worker.id} config=#{config_filename} >/dev/null 2>&1 &" 
-                      `#{s}`
+
+                      # write bash command to initialize bash file
+                      s = "echo \"source $HOME/.profile; cd #{BlackStack::Pampa.working_directory}; nohup ruby #{worker_filename} id=#{worker.id} config=#{self.config_filename} >/dev/null 2>&1 &\" > #{BlackStack::Pampa.working_directory}/worker.sh"
+                      node.exec(s, false);
+                    
+                      s = "nohup bash #{BlackStack::Pampa.working_directory}/worker.sh >/dev/null 2>&1 &"
+                      node.exec(s, false);
+
                       l.done
                   }
                   # disconnect the node
@@ -411,7 +451,7 @@ module BlackStack
         # Parameters:
         # - config: relative path of the configuration file. Example: '../config.rb'
         # 
-        def self.stop(config_filename='./config.rb')
+        def self.stop()
             # validate: the connection string is not nil
             raise "The connection string is nil" if @@connection_string.nil?
             # validate: the connection string is not empty
@@ -429,7 +469,7 @@ module BlackStack
                     l.done
                     # kill all ruby processes except this one
                     l.logs("Killing all Ruby processes except this one... ")
-                    `ps ax | grep ruby | grep -v grep | grep -v #{Process.pid} | cut -b3-7 | xargs -t kill;`
+                    node.exec("ps ax | grep ruby | grep -v grep | grep -v #{Process.pid} | cut -b3-7 | xargs -t kill;", false);
                     l.done
                     # disconnect the node
                     l.logs("Disconnecting... ")
@@ -439,10 +479,43 @@ module BlackStack
             } # @@nodes.each do |node|            
         end
 
+        # get the node by `node_name`
+        # connect the nodes via ssh.
+        # get how many minutes the worker wrote the log file
+        # close the connection
+        def self.log_minutes_ago(node_name, worker_id)
+            # get the node
+            n = self.nodes.select { |n| n.name == node_name }.first
+            return nil if !n
+            # connect the node
+            n.connect()
+            # get the time of the last time the worker wrote the log file
+            s = n.exec("cat #{BlackStack::Pampa.working_directory}/worker.#{worker_id}.log | tail -n 1 | cut -b1-19", false).to_s.strip
+            # run bash command to get the difference in minutes beteen now and the last time the worker wrote the log file
+            s = n.exec("echo \"$(($(date +%s) - $(date -d '#{s}' +%s))) / 60\" | bc", false).to_s.strip
+            # disconnect the node
+            n.disconnect
+            # return the number of minutes
+            s
+        end # log_minutes_ago
+
+        # get the node usage of CPU, RAM, DISK, and NETWORK
+        # return a hash with the usage of CPU, RAM, DISK, and NETWORK
+        #
+        # sudo apt install sysstat
+        #
+        def self.node_usage(node_name)
+            ret = {}
+            # get the node
+            n = self.nodes.select { |n| n.name == node_name }.first
+            return nil if !n
+            n.usage
+        end # node_usage
+
         # stub worker class
         class Worker
             # name to identify uniquely the worker
-            attr_accessor :id, :assigned_job, :attached
+            attr_accessor :id, :assigned_job, :attached, :node
             # return an array with the errors found in the description of the job
             def self.descriptor_errors(h)
                 errors = []
@@ -471,6 +544,10 @@ module BlackStack
             def detach()
                 self.attached = false
             end
+            # get the latest n lines of the log of this worker
+            def tail(n=10)
+              self.node.tail("#{BlackStack::Pampa.working_directory}/worker.#{self.id}.log", n)
+            end
         end
 
         # stub node class
@@ -500,7 +577,9 @@ module BlackStack
                 self.max_workers = h[:max_workers]
                 self.workers = []
                 self.max_workers.times do |i|
-                    self.workers << BlackStack::Pampa::Worker.new({:id => "#{self.name}.#{(i+1).to_s}", :node => self.to_hash})
+                    new_worker = BlackStack::Pampa::Worker.new({:id => "#{self.name}.#{(i+1).to_s}", :node => self.to_hash})
+                    new_worker.node = self
+                    self.workers << new_worker
                 end
             end # def self.create(h)
             # returh a hash descriptor of the node
@@ -569,6 +648,8 @@ module BlackStack
             # stretch assignation/unassignation of workers
             attr_accessor :max_pending_tasks
             attr_accessor :max_assigned_workers
+            # tags in order to choose on which nodes the job will be executed
+            attr_accessor :tags
 
             # return a hash descriptor of the job
             def to_hash()
@@ -596,6 +677,7 @@ module BlackStack
                     :processing_function => self.processing_function.to_s,
                     :max_pending_tasks => self.max_pending_tasks,
                     :max_assigned_workers => self.max_assigned_workers,
+                    :tags => self.tags
                 }
             end
 
@@ -631,6 +713,7 @@ module BlackStack
               self.processing_function = h[:processing_function]
               self.max_pending_tasks = h[:max_pending_tasks]
               self.max_assigned_workers = h[:max_assigned_workers]
+              self.tags = h[:tags].nil? ? [] : ( h[:tags].is_a?(Array) ? h[:tags] : [h[:tags].to_s] )
             end
             
             # returns an array of tasks pending to be processed by the worker.
@@ -785,6 +868,66 @@ module BlackStack
               #      
               return i
             end
+
+            # reporting method: idle
+            # reutrn the number of idle tasks.
+            # if the numbr if idle tasks is higher than `max_tasks_to_show` then it returns `max_tasks_to_show`+.
+            def idle(max_tasks_to_show=25)
+                j = self
+                ret = j.selecting(max_tasks_to_show).size
+                ret = ret >= max_tasks_to_show ? "#{ret.to_label}+" : ret.to_label
+                ret
+            end # def idle
+
+            # reporting method: running
+            # return the number of running tasks.
+            # if the numbr if running tasks is higher than `max_tasks_to_show` then it returns `max_tasks_to_show`+.
+            def running(max_tasks_to_show=25)
+                j = self
+                ret = 0
+                BlackStack::Pampa::nodes.each { |n|
+                    n.workers.each { |w|
+                        ret += j.occupied_slots(w).size
+                        break if ret>=max_tasks_to_show
+                    }
+                }
+                ret = ret >= max_tasks_to_show ? "#{max_tasks_to_show}+" : ret.to_label
+                ret
+            end # def idle
+
+            # reporting method: running
+            # return the number of running tasks.
+            # if the numbr if running tasks is higher than `max_tasks_to_show` then it returns `max_tasks_to_show`+.
+            def failed(max_tasks_to_show=25)
+                j = self
+                q = "
+                    SELECT * 
+                    FROM #{j.table.to_s} 
+                    WHERE COALESCE(#{j.field_success.to_s},true)=false
+                    --AND #{j.field_end_time.to_s} IS NULL
+                    --AND COALESCE(#{j.field_times.to_s},0) >= #{j.max_try_times.to_i}
+                    LIMIT #{max_tasks_to_show}
+                "
+                ret = DB[q].all.size
+                ret = ret >= max_tasks_to_show ? "#{ret.to_label}+" : ret.to_label
+                ret
+            end # def idle
+
+            # reporting method: error_descriptions
+            # return an array of hashes { :id, :error_description } with the tasks that have an the success flag in false, error description.
+            # if the numbr if running tasks is higher than `max_tasks_to_show` then it returns `max_tasks_to_show` errors.
+            def error_descriptions(max_tasks_to_show=25)
+                j = self
+                q = "
+                    SELECT #{j.field_primary_key.to_s} as id, #{j.field_error_description.to_s} as description 
+                    FROM #{j.table.to_s} 
+                    WHERE COALESCE(#{j.field_success.to_s},true)=false
+                    --AND #{j.field_end_time.to_s} IS NULL
+                    --AND COALESCE(#{j.field_times.to_s},0) >= #{j.max_try_times.to_i}
+                    LIMIT #{max_tasks_to_show}
+                "
+                DB[q].all
+            end
         end # class Job
     end # module Pampa
 end # module BlackStack

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pampa
 version: !ruby/object:Gem::Version
-  version: 2.0.12
+  version: 2.0.14
 platform: ruby
 authors:
 - Leandro Daniel Sardi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2022-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel