vmpooler 0.13.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b49b7d743482ad4e81ac6cae5e2d3b3d4c8a15e27024c41afc8938ae3374fe
-  data.tar.gz: 6eea091a71b41ac346fae2098633a0e448bcfbad8c357f84bbf17bf8716a16d2
+  metadata.gz: 3a97df538d5070e9eb9854084473c50efdd3b18427dc6909e6bfadaeea0f329e
+  data.tar.gz: 930c7c450fcee1429d18a8b72a48cd9c199d659bdb430a5ef5933eb6911cc1ca
 SHA512:
-  metadata.gz: 9b47704b269da351657da3246a6c31be8ecb6aaa20e5a4ab40f69656cccdd7c1ee94bd8661eb159e5654c270cf990afd78ec6964f7efbadca362a325bad47e83
-  data.tar.gz: a9481fb784e7d2f525a6c7089d8699a89e2694d43e2952c152358de3d057c3ef174a157452556b01651d6dc631de8e67120b46116c78c692bfd718a8dc008ddb
+  metadata.gz: a9706740f3aca1a51fecc17550a1d75275849148c658622ca05f9f177dd1bfd8e84ba681701c9074215057e65854026395e765d5b346305772f572a4f6bf6a9e
+  data.tar.gz: e1e8f8687342676d40d75c5771b62a28b8f865208882d8ae0d7f0548f218cc6134cce5e53190c46197d56892eda687e1798a5e7c91f35b27510fa84bd9eb1f68

data/bin/vmpooler

@@ -11,33 +11,38 @@ redis_connection_pool_size = config[:redis]['connection_pool_size']
 redis_connection_pool_timeout = config[:redis]['connection_pool_timeout']
 logger_file = config[:config]['logfile']
 
-metrics = Vmpooler.new_metrics(config)
+logger = Vmpooler::Logger.new logger_file
+metrics = Vmpooler::Metrics.init(logger, config)
 
 torun_threads = []
 if ARGV.count == 0
-  torun = ['api', 'manager']
+  torun = %i[api manager]
 else
   torun = []
-  torun << 'api' if ARGV.include? 'api'
-  torun << 'manager' if ARGV.include? 'manager'
+  torun << :api if ARGV.include? 'api'
+  torun << :manager if ARGV.include? 'manager'
   exit(2) if torun.empty?
 end
 
-if torun.include? 'api'
+if torun.include? :api
   api = Thread.new do
-    thr = Vmpooler::API.new
     redis = Vmpooler.new_redis(redis_host, redis_port, redis_password)
-    thr.helpers.configure(config, redis, metrics)
-    thr.helpers.execute!
+    Vmpooler::API.execute(torun, config, redis, metrics, logger)
   end
   torun_threads << api
+elsif metrics.respond_to?(:setup_prometheus_metrics)
+  # Run the cut down API - Prometheus Metrics only.
+  prometheus_only_api = Thread.new do
+    Vmpooler::API.execute(torun, config, nil, metrics, logger)
+  end
+  torun_threads << prometheus_only_api
 end
 
-if torun.include? 'manager'
+if torun.include? :manager
   manager = Thread.new do
     Vmpooler::PoolManager.new(
       config,
-      Vmpooler.new_logger(logger_file),
+      logger,
       Vmpooler.redis_connection_pool(redis_host, redis_port, redis_password, redis_connection_pool_size, redis_connection_pool_timeout, metrics),
       metrics
     ).execute!

data/lib/vmpooler.rb

@@ -15,7 +15,7 @@ module Vmpooler
   require 'timeout'
   require 'yaml'
 
-  %w[api graphite logger pool_manager statsd dummy_statsd generic_connection_pool].each do |lib|
+  %w[api metrics logger pool_manager generic_connection_pool].each do |lib|
     require "vmpooler/#{lib}"
   end
 
@@ -84,6 +84,7 @@ module Vmpooler
     parsed_config[:config]['experimental_features'] = ENV['EXPERIMENTAL_FEATURES'] if ENV['EXPERIMENTAL_FEATURES']
     parsed_config[:config]['purge_unconfigured_folders'] = ENV['PURGE_UNCONFIGURED_FOLDERS'] if ENV['PURGE_UNCONFIGURED_FOLDERS']
     parsed_config[:config]['usage_stats'] = ENV['USAGE_STATS'] if ENV['USAGE_STATS']
+    parsed_config[:config]['request_logger'] = ENV['REQUEST_LOGGER'] if ENV['REQUEST_LOGGER']
 
     parsed_config[:redis] = parsed_config[:redis] || {}
     parsed_config[:redis]['server'] = ENV['REDIS_SERVER'] || parsed_config[:redis]['server'] || 'localhost'
@@ -166,7 +167,8 @@ module Vmpooler
   def self.redis_connection_pool(host, port, password, size, timeout, metrics)
     Vmpooler::PoolManager::GenericConnectionPool.new(
       metrics: metrics,
-      metric_prefix: 'redis_connection_pool',
+      connpool_type: 'redis_connection_pool',
+      connpool_provider: 'manager',
       size: size,
       timeout: timeout
     ) do
@@ -180,20 +182,6 @@ module Vmpooler
     Redis.new(host: host, port: port, password: password)
   end
 
-  def self.new_logger(logfile)
-    Vmpooler::Logger.new logfile
-  end
-
-  def self.new_metrics(params)
-    if params[:statsd]
-      Vmpooler::Statsd.new(params[:statsd])
-    elsif params[:graphite]
-      Vmpooler::Graphite.new(params[:graphite])
-    else
-      Vmpooler::DummyStatsd.new
-    end
-  end
-
   def self.pools(conf)
     conf[:pools]
   end

data/lib/vmpooler/api.rb

@@ -2,51 +2,58 @@
 
 module Vmpooler
   class API < Sinatra::Base
-    def initialize
-      super
+    # Load API components
+    %w[helpers dashboard reroute v1 request_logger].each do |lib|
+      require "vmpooler/api/#{lib}"
     end
+    # Load dashboard components
+    require 'vmpooler/dashboard'
 
-    not_found do
-      content_type :json
+    def self.execute(torun, config, redis, metrics, logger)
+      self.settings.set :config, config
+      self.settings.set :redis, redis unless redis.nil?
+      self.settings.set :metrics, metrics
+      self.settings.set :checkoutlock, Mutex.new
 
-      result = {
-        ok: false
-      }
+      # Deflating in all situations
+      # https://www.schneems.com/2017/11/08/80-smaller-rails-footprint-with-rack-deflate/
+      use Rack::Deflater
 
-      JSON.pretty_generate(result)
-    end
+      # not_found clause placed here to fix rspec test issue.
+      not_found do
+        content_type :json
 
-    # Load dashboard components
-    begin
-      require 'dashboard'
-    rescue LoadError
-      require File.expand_path(File.join(File.dirname(__FILE__), 'dashboard'))
-    end
+        result = {
+          ok: false
+        }
 
-    use Vmpooler::Dashboard
+        JSON.pretty_generate(result)
+      end
 
-    # Load API components
-    %w[helpers dashboard reroute v1].each do |lib|
-      begin
-        require "api/#{lib}"
-      rescue LoadError
-        require File.expand_path(File.join(File.dirname(__FILE__), 'api', lib))
+      if metrics.respond_to?(:setup_prometheus_metrics)
+        # Prometheus metrics are only setup if actually specified
+        # in the config file.
+        metrics.setup_prometheus_metrics(torun)
+
+        # Using customised collector that filters out hostnames on API paths
+        require 'vmpooler/metrics/promstats/collector_middleware'
+        require 'prometheus/middleware/exporter'
+        use Vmpooler::Metrics::Promstats::CollectorMiddleware, metrics_prefix: "#{metrics.metrics_prefix}_http"
+        use Prometheus::Middleware::Exporter, path: metrics.endpoint
       end
-    end
 
-    use Vmpooler::API::Dashboard
-    use Vmpooler::API::Reroute
-    use Vmpooler::API::V1
+      if torun.include? :api
+        # Enable API request logging only if required
+        use Vmpooler::API::RequestLogger, logger: logger if config[:config]['request_logger']
 
-    def configure(config, redis, metrics)
-      self.settings.set :config, config
-      self.settings.set :redis, redis
-      self.settings.set :metrics, metrics
-      self.settings.set :checkoutlock, Mutex.new
-    end
+        use Vmpooler::Dashboard
+        use Vmpooler::API::Dashboard
+        use Vmpooler::API::Reroute
+        use Vmpooler::API::V1
+      end
 
-    def execute!
-      self.settings.run!
+      # Get thee started O WebServer
+      self.run!
     end
   end
 end

data/lib/vmpooler/api/helpers.rb

@@ -13,7 +13,7 @@ module Vmpooler
       def valid_token?(backend)
         return false unless has_token?
 
-        backend.exists('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN']) ? true : false
+        backend.exists?('vmpooler__token__' + request.env['HTTP_X_AUTH_TOKEN']) ? true : false
       end
 
       def validate_token(backend)

data/lib/vmpooler/api/request_logger.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Vmpooler
+  class API
+    class RequestLogger
+      attr_reader :app
+
+      def initialize(app, options = {})
+        @app = app
+        @logger = options[:logger]
+      end
+
+      def call(env)
+        status, headers, body = @app.call(env)
+        @logger.log('s', "[ ] API: Method: #{env['REQUEST_METHOD']}, Status: #{status}, Path: #{env['PATH_INFO']}, Body: #{body}")
+        [status, headers, body]
+      end
+    end
+  end
+end

data/lib/vmpooler/api/v1.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'vmpooler/util/parsing'
+
 module Vmpooler
   class API
   class V1 < Sinatra::Base
@@ -334,9 +336,10 @@ module Vmpooler
     end
 
     def too_many_requested?(payload)
-      payload&.each do |_poolname, count|
+      payload&.each do |poolname, count|
         next unless count.to_i > config['max_ondemand_instances_per_request']
 
+        metrics.increment('ondemandrequest_fail.toomanyrequests.' + poolname)
         return true
       end
       false
@@ -357,9 +360,10 @@ module Vmpooler
       request_id ||= generate_request_id
       result['request_id'] = request_id
 
-      if backend.exists("vmpooler__odrequest__#{request_id}")
+      if backend.exists?("vmpooler__odrequest__#{request_id}")
         result['message'] = "request_id '#{request_id}' has already been created"
         status 409
+        metrics.increment('ondemandrequest_generate.duplicaterequests')
         return result
       end
 
@@ -383,6 +387,7 @@ module Vmpooler
 
       result['domain'] = config['domain'] if config['domain']
       result[:ok] = true
+      metrics.increment('ondemandrequest_generate.success')
       result
     end
 
@@ -804,6 +809,7 @@ module Vmpooler
 
     post "#{api_prefix}/ondemandvm/?" do
       content_type :json
+      metrics.increment('api_vm.post.ondemand.requestid')
 
       need_token! if Vmpooler::API.settings.config[:auth]
 
@@ -819,12 +825,12 @@ module Vmpooler
           else
             result[:bad_templates] = invalid
             invalid.each do |bad_template|
-              metrics.increment('ondemandrequest.invalid.' + bad_template)
+              metrics.increment('ondemandrequest_fail.invalid.' + bad_template)
             end
             status 404
           end
         else
-          metrics.increment('ondemandrequest.invalid.unknown')
+          metrics.increment('ondemandrequest_fail.invalid.unknown')
           status 404
         end
       rescue JSON::ParserError
@@ -841,6 +847,7 @@ module Vmpooler
     post "#{api_prefix}/ondemandvm/:template/?" do
       content_type :json
       result = { 'ok' => false }
+      metrics.increment('api_vm.delete.ondemand.template')
 
       need_token! if Vmpooler::API.settings.config[:auth]
 
@@ -853,12 +860,12 @@ module Vmpooler
         else
           result[:bad_templates] = invalid
           invalid.each do |bad_template|
-            metrics.increment('ondemandrequest.invalid.' + bad_template)
+            metrics.increment('ondemandrequest_fail.invalid.' + bad_template)
           end
           status 404
         end
       else
-        metrics.increment('ondemandrequest.invalid.unknown')
+        metrics.increment('ondemandrequest_fail.invalid.unknown')
         status 404
       end
 
@@ -867,6 +874,7 @@ module Vmpooler
 
     get "#{api_prefix}/ondemandvm/:requestid/?" do
       content_type :json
+      metrics.increment('api_vm.get.ondemand.request')
 
       status 404
       result = check_ondemand_request(params[:requestid])
@@ -877,6 +885,7 @@ module Vmpooler
     delete "#{api_prefix}/ondemandvm/:requestid/?" do
       content_type :json
       need_token! if Vmpooler::API.settings.config[:auth]
+      metrics.increment('api_vm.delete.ondemand.request')
 
       status 404
       result = delete_ondemand_request(params[:requestid])
@@ -887,6 +896,7 @@ module Vmpooler
     post "#{api_prefix}/vm/?" do
       content_type :json
       result = { 'ok' => false }
+      metrics.increment('api_vm.post.vm.checkout')
 
       payload = JSON.parse(request.body.read)
 
@@ -974,11 +984,14 @@ module Vmpooler
 
       if request_hash['status'] == 'ready'
         result['ready'] = true
-        platform_parts = request_hash['requested'].split(',')
-        platform_parts.each do |platform|
-          pool_alias, pool, _count = platform.split(':')
-          instances = backend.smembers("vmpooler__#{request_id}__#{pool_alias}__#{pool}")
-          result[pool_alias] = { 'hostname': instances }
+        Parsing.get_platform_pool_count(request_hash['requested']) do |platform_alias, pool, _count|
+          instances = backend.smembers("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
+
+          if result.key?(platform_alias)
+            result[platform_alias][:hostname] = result[platform_alias][:hostname] + instances
+          else
+            result[platform_alias] = { 'hostname': instances }
+          end
         end
         result['domain'] = config['domain'] if config['domain']
         status 200
@@ -989,14 +1002,19 @@ module Vmpooler
         result['message'] = 'The request has been deleted'
         status 200
       else
-        platform_parts = request_hash['requested'].split(',')
-        platform_parts.each do |platform|
-          pool_alias, pool, count = platform.split(':')
-          instance_count = backend.scard("vmpooler__#{request_id}__#{pool_alias}__#{pool}")
-          result[pool_alias] = {
-            'ready': instance_count.to_s,
-            'pending': (count.to_i - instance_count.to_i).to_s
-          }
+        Parsing.get_platform_pool_count(request_hash['requested']) do |platform_alias, pool, count|
+          instance_count = backend.scard("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
+          instances_pending = count.to_i - instance_count.to_i
+
+          if result.key?(platform_alias) && result[platform_alias].key?(:ready)
+            result[platform_alias][:ready] = (result[platform_alias][:ready].to_i + instance_count).to_s
+            result[platform_alias][:pending] = (result[platform_alias][:pending].to_i + instances_pending).to_s
+          else
+            result[platform_alias] = {
+              'ready': instance_count.to_s,
+              'pending': instances_pending.to_s
+            }
+          end
         end
       end
 
@@ -1017,12 +1035,11 @@ module Vmpooler
       else
         backend.hset("vmpooler__odrequest__#{request_id}", 'status', 'deleted')
 
-        platforms.split(',').each do |platform|
-          pool_alias, pool, _count = platform.split(':')
-          backend.smembers("vmpooler__#{request_id}__#{pool_alias}__#{pool}")&.each do |vm|
+        Parsing.get_platform_pool_count(platforms) do |platform_alias, pool, _count|
+          backend.smembers("vmpooler__#{request_id}__#{platform_alias}__#{pool}")&.each do |vm|
             backend.smove("vmpooler__running__#{pool}", "vmpooler__completed__#{pool}", vm)
           end
-          backend.del("vmpooler__#{request_id}__#{pool_alias}__#{pool}")
+          backend.del("vmpooler__#{request_id}__#{platform_alias}__#{pool}")
         end
         backend.expire("vmpooler__odrequest__#{request_id}", 129_600_0)
       end
@@ -1034,6 +1051,7 @@ module Vmpooler
     post "#{api_prefix}/vm/:template/?" do
       content_type :json
       result = { 'ok' => false }
+      metrics.increment('api_vm.get.vm.template')
 
       payload = extract_templates_from_query_params(params[:template])
 
@@ -1057,6 +1075,7 @@ module Vmpooler
 
     get "#{api_prefix}/vm/:hostname/?" do
       content_type :json
+      metrics.increment('api_vm.get.vm.hostname')
 
       result = {}
 
@@ -1129,6 +1148,7 @@ module Vmpooler
 
     delete "#{api_prefix}/vm/:hostname/?" do
       content_type :json
+      metrics.increment('api_vm.delete.vm.hostname')
 
       result = {}
 
@@ -1146,8 +1166,9 @@ module Vmpooler
 
           status 200
           result['ok'] = true
+          metrics.increment('delete.success')
         else
-          metrics.increment('delete.srem.failed')
+          metrics.increment('delete.failed')
         end
       end
 
@@ -1156,6 +1177,7 @@ module Vmpooler
 
     put "#{api_prefix}/vm/:hostname/?" do
       content_type :json
+      metrics.increment('api_vm.put.vm.modify')
 
       status 404
       result = { 'ok' => false }
@@ -1164,7 +1186,7 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      if backend.exists('vmpooler__vm__' + params[:hostname])
+      if backend.exists?('vmpooler__vm__' + params[:hostname])
         begin
           jdata = JSON.parse(request.body.read)
         rescue StandardError
@@ -1232,6 +1254,7 @@ module Vmpooler
 
     post "#{api_prefix}/vm/:hostname/disk/:size/?" do
       content_type :json
+      metrics.increment('api_vm.post.vm.disksize')
 
       need_token! if Vmpooler::API.settings.config[:auth]
 
@@ -1240,7 +1263,7 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      if ((params[:size].to_i > 0 )and (backend.exists('vmpooler__vm__' + params[:hostname])))
+      if ((params[:size].to_i > 0 )and (backend.exists?('vmpooler__vm__' + params[:hostname])))
         result[params[:hostname]] = {}
         result[params[:hostname]]['disk'] = "+#{params[:size]}gb"
 
@@ -1255,6 +1278,7 @@ module Vmpooler
 
     post "#{api_prefix}/vm/:hostname/snapshot/?" do
       content_type :json
+      metrics.increment('api_vm.post.vm.snapshot')
 
       need_token! if Vmpooler::API.settings.config[:auth]
 
@@ -1263,7 +1287,7 @@ module Vmpooler
 
       params[:hostname] = hostname_shorten(params[:hostname], config['domain'])
 
-      if backend.exists('vmpooler__vm__' + params[:hostname])
+      if backend.exists?('vmpooler__vm__' + params[:hostname])
         result[params[:hostname]] = {}
 
         o = [('a'..'z'), ('0'..'9')].map(&:to_a).flatten
@@ -1280,6 +1304,7 @@ module Vmpooler
 
     post "#{api_prefix}/vm/:hostname/snapshot/:snapshot/?" do
       content_type :json
+      metrics.increment('api_vm.post.vm.disksize')
 
       need_token! if Vmpooler::API.settings.config[:auth]