procon_bypass_man 0.2.2 → 0.2.3

data/lib/procon_bypass_man/procon/performance_measurement/span_queue.rb

@@ -0,0 +1,42 @@
+class ProconBypassMan::Procon::PerformanceMeasurement::SpanQueue
+  def initialize
+    @current_table = {} # 1つのスレッドからしか触らないのでlockはいらない
+    @measurement_collection_list = [] # main threadとjob worker threadから触るのでlockが必要
+  end
+
+  # @param [Array<PerformanceSpan>] spans
+  # bypassプロセスから呼ばれる. 実際に実行を行なっているのはmasterプロセス
+  def push(new_spans)
+    current_key = generate_bucket_key
+
+    if @current_table[current_key].nil?
+      if not @current_table.empty?
+        timestamp_key = @current_table.keys.first
+        spans = @current_table.values.first
+        # 本当ならmutexでlockする必要があるけど、正確性はいらないのでパフォーマンスを上げるためにlockしない
+        @measurement_collection_list.push(
+          ProconBypassMan::Procon::PerformanceMeasurement::MeasurementCollection.new(timestamp_key: timestamp_key, spans: spans)
+        )
+      end
+
+      @current_table = {}
+      @current_table[current_key] = []
+      @current_table[current_key].concat(new_spans)
+    else
+      @current_table[current_key].concat(new_spans)
+    end
+  end
+
+  # job workerから呼ばれる
+  # @return [ProconBypassMan::Procon::PerformanceMeasurement::MeasurementCollection]
+  def pop
+    @measurement_collection_list.pop
+  end
+
+  private
+
+  # 1分単位で次の値になる
+  def generate_bucket_key
+    Time.new.strftime("%Y-%m-%d %H:%M:00%:z")
+  end
+end

data/lib/procon_bypass_man/procon/performance_measurement/span_transfer_buffer.rb

@@ -0,0 +1,39 @@
+class ProconBypassMan::Procon::PerformanceMeasurement::SpanTransferBuffer
+  include Singleton
+
+  def initialize
+    @buff = []
+  end
+
+  # @param [Span]
+  # @return [void]
+  def push_and_run_block_if_buffer_over(value, &block)
+    push(value)
+    return unless buffer_over?
+
+    block.call(spans)
+    clear
+  end
+
+  private
+
+  def spans
+    @buff
+  end
+
+  def clear
+    @buff.clear
+  end
+
+  def push(value)
+    @buff << value
+  end
+
+  def buffer_over?
+    @buff.length > max_buffer
+  end
+
+  def max_buffer
+    200
+  end
+end

data/lib/procon_bypass_man/procon/performance_measurement.rb

@@ -0,0 +1,103 @@
+module ProconBypassMan::Procon::PerformanceMeasurement; end
+
+require 'benchmark'
+require 'procon_bypass_man/procon/performance_measurement/measurements_summarizer'
+require 'procon_bypass_man/procon/performance_measurement/span_queue'
+require 'procon_bypass_man/procon/performance_measurement/procon_performance_span_transfer_job'
+require 'procon_bypass_man/procon/performance_measurement/span_transfer_buffer'
+require 'procon_bypass_man/procon/performance_measurement/measurement_collection'
+require 'procon_bypass_man/procon/performance_measurement/queue_over_process'
+require 'procon_bypass_man/procon/performance_measurement/last_bypass_at'
+
+module ProconBypassMan::Procon::PerformanceMeasurement
+  class PerformanceSpan
+    attr_accessor :time_taken, :succeed, :interval_from_previous_succeed, :gc_count, :gc_time
+    attr_reader :write_error_count, :read_error_count, :write_time, :read_time
+
+    def initialize
+      @write_error_count = 0
+      @read_error_count = 0
+      @time_taken = 0.0
+      @succeed = nil
+      @interval_from_previous_succeed = nil
+      @custom_metric = {}
+      @write_time = 0.0
+      @read_time = 0.0
+      @gc_time = 0.0
+    end
+
+    def record_read_error
+      @read_error_count += 1
+    end
+
+    def record_write_error
+      @write_error_count += 1
+    end
+
+    def record_write_time(&block)
+      result = nil
+      @write_time = Benchmark.realtime { result = block.call }
+      return result
+    end
+
+    def record_read_time(&block)
+      @read_time = Benchmark.realtime { block.call }
+    end
+  end
+
+  # measureをして、measureの結果をためる
+  # @return [Boolean] 成功したか. テスト時に戻り値を使いたい
+  def self.measure(&bypass_process_block)
+    unless ProconBypassMan.config.enable_procon_performance_measurement?
+      bypass_process_block.call(PerformanceSpan.new)
+      return
+    end
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.1.0")
+      snapshot_gc_time = GC.stat(:time) / 1000.0
+    end
+    snapshot_gc_count = GC.count
+    span = PerformanceSpan.new
+
+    span.time_taken = Benchmark.realtime {
+      span.succeed = bypass_process_block.call(span)
+    }.floor(3)
+
+    if span.succeed
+      ProconBypassMan::Procon::PerformanceMeasurement::LastBypassAt.touch do |interval_from_previous_succeed|
+        span.interval_from_previous_succeed = interval_from_previous_succeed.floor(3)
+      end
+    end
+
+    (GC.count - snapshot_gc_count).tap do |increased_gc_count|
+      span.gc_count = increased_gc_count
+    end
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.1.0")
+      ((GC.stat(:time) / 1000.0) - snapshot_gc_time).tap do |increased_time|
+        span.gc_time = increased_time
+      end
+    end
+
+    ProconBypassMan::GC.stop_gc_in do
+      # measureするたびにperform_asyncしているとjob queueが詰まるのでbufferingしている
+      ProconBypassMan::Procon::PerformanceMeasurement::SpanTransferBuffer.instance.push_and_run_block_if_buffer_over(span) do |spans|
+        ProconBypassMan::ProconPerformanceSpanTransferJob.perform_async(spans.dup)
+      end
+    end
+    return span.succeed
+  end
+
+  # @return [MeasurementCollection, NilClass]
+  # bypassしているプロセスから呼ばれる
+  def self.pop_measurement_collection
+    ProconBypassMan::Procon::PerformanceMeasurement::QueueOverProcess.pop
+  end
+
+  # @param [MeasurementCollection] spans
+  # @return [ProconBypassMan::Procon::PerformanceMeasurement::MeasurementsSummarizer::PerformanceMetric]
+  # jobから呼ばれる予定
+  def self.summarize(spans: )
+    ProconBypassMan::Procon::PerformanceMeasurement::MeasurementsSummarizer.new(spans: spans).summarize
+  end
+end

data/lib/procon_bypass_man/procon.rb

@@ -7,8 +7,9 @@ class ProconBypassMan::Procon
   require "procon_bypass_man/procon/value_objects/rumble_binary"
   require "procon_bypass_man/procon/value_objects/binary"
   require "procon_bypass_man/procon/value_objects/bypass_mode"
-
   require "procon_bypass_man/procon/consts"
+  require "procon_bypass_man/procon/performance_measurement"
+  require "procon_bypass_man/procon/performance_measurement/queue_over_process"
   require "procon_bypass_man/procon/mode_registry"
   require "procon_bypass_man/procon/macro"
   require "procon_bypass_man/procon/macro_registry"

data/lib/procon_bypass_man/procon_display/bypass_hook.rb

@@ -1,11 +1,12 @@
 module ProconBypassMan::ProconDisplay::BypassHook
   include ProconBypassMan::Callbacks
 
-  define_callbacks :send_procon_to_gadget
+  define_callbacks :run
 
-  set_callback :send_procon_to_gadget, :after, :write_procon_display_Status
+  set_callback :run, :after, :write_procon_display_status
 
-  def write_procon_display_Status
+  def write_procon_display_status
+    return unless bypass_value.binary
     ProconBypassMan::ProconDisplay::Status.instance.current = bypass_value.binary.to_procon_reader.to_hash.dup
   end
 end

data/lib/procon_bypass_man/remote_macro/queue_over_process.rb

@@ -1,62 +1,44 @@
-class ProconBypassMan::QueueOverProcess
-  attr_reader :drb
-
-  @@drb_server = nil
-  @@drb_server_thread = nil
-
-  def self.start!
-    return unless ProconBypassMan.config.enable_remote_macro?
-    require 'drb/drb'
-
-    FileUtils.rm_rf(file_path) if File.exist?(file_path)
-    begin
-      @@drb_server = DRb.start_service(url, Queue.new, safe_level: 1)
-    rescue Errno::EADDRINUSE => e
-      ProconBypassMan.logger.error e
-      raise
-    end
-
-    @@drb_server_thread =
-      Thread.new do
-        DRb.thread.join
-      end
-  end
+class ProconBypassMan::RemoteMacro::QueueOverProcess
+  extend ProconBypassMan::CanOverProcess
 
-  def self.shutdown
-    if @@drb_server
-      @@drb_server_thread.kill
-      @@drb_server.stop_service
-    end
-  end
+  include Singleton
 
-  def self.push(value)
-    return unless ProconBypassMan.config.enable_remote_macro?
+  attr_reader :distributed_queue
 
-    drb.push(value)
+  # @override
+  def self.enable?
+    ProconBypassMan.config.enable_remote_macro?
   end
 
-  def self.pop
-    return unless ProconBypassMan.config.enable_remote_macro?
+  # @override
+  def self.distributed_class
+    Queue
+  end
 
-    drb.pop
+  # @override
+  def self.socket_file_path
+    "/tmp/procon_bypass_man_remote_macro_queue".freeze
   end
 
-  def self.drb
-    return unless ProconBypassMan.config.enable_remote_macro?
+  def self.push(value)
+    return unless enable?
 
-    @@drb ||= new.drb
+    instance.distributed_queue.push(value)
   end
 
-  PROTOCOL = "drbunix"
-  def self.url
-    "#{PROTOCOL}:/tmp/procon_bypass_man_queue"
+  def self.pop
+    return unless enable?
+
+    instance.distributed_queue.pop
   end
 
-  def self.file_path
-    url.gsub("#{PROTOCOL}:", "")
+  def self.clear
+    return unless enable?
+
+    instance.distributed_queue.clear
   end
 
   def initialize
-    @drb = DRbObject.new_with_uri(self.class.url)
+    @distributed_queue = DRbObject.new_with_uri(self.class.socket_path)
   end
 end

data/lib/procon_bypass_man/remote_macro/remote_macro_object.rb

@@ -1,30 +1,28 @@
-module ProconBypassMan
-  class RemoteMacroObject
-    # valueobjectがvalidatorの責務も持っている. 今度分離する
-    class ValidationError < StandardError; end
-    class MustBeNotNilError < ValidationError; end
-    class NonSupportAction < ValidationError; end
+class ProconBypassMan::RemoteMacro::RemoteMacroObject
+  # valueobjectがvalidatorの責務も持っている. 今度分離する
+  class ValidationError < StandardError; end
+  class MustBeNotNilError < ValidationError; end
+  class NonSupportAction < ValidationError; end
 
-    attr_accessor :name, :uuid, :steps
+  attr_accessor :name, :uuid, :steps
 
-    # @param [String] name
-    # @param [String] uuid
-    # @param [Array] steps
-    def initialize(name: , uuid:, steps: )
-      @name = name
-      @uuid = uuid
-      @steps = steps
-      freeze
-    end
+  # @param [String] name
+  # @param [String] uuid
+  # @param [Array] steps
+  def initialize(name: , uuid:, steps: )
+    @name = name
+    @uuid = uuid
+    @steps = steps
+    freeze
+  end
 
-    # @raise [MustBeNotNilError]
-    # @raise [NonSupportAction]
-    # @return [void]
-    def validate!
-      self.uuid or raise MustBeNotNilError, "uuidは値が必須です"
-      unless self.steps.is_a?(Array)
-        raise ValidationError, "stepsは配列です"
-      end
+  # @raise [MustBeNotNilError]
+  # @raise [NonSupportAction]
+  # @return [void]
+  def validate!
+    self.uuid or raise MustBeNotNilError, "uuidは値が必須です"
+    unless self.steps.is_a?(Array)
+      raise ValidationError, "stepsは配列です"
     end
   end
 end

data/lib/procon_bypass_man/remote_macro/remote_macro_receiver.rb

@@ -15,7 +15,7 @@ class ProconBypassMan::RemoteMacroReceiver
   end
 
   def self.run
-    while(task = ProconBypassMan::QueueOverProcess.pop)
+    while(task = ProconBypassMan::RemoteMacro::QueueOverProcess.pop)
       receive(task)
     end
     shutdown

data/lib/procon_bypass_man/remote_macro/remote_macro_sender.rb

@@ -1,7 +1,7 @@
 class ProconBypassMan::RemoteMacroSender
   def self.execute(name: , uuid: , steps: )
     ProconBypassMan.logger.info "[remote macro][sender] name: #{name}, uuid: #{uuid}, steps: #{steps}"
-    ProconBypassMan::QueueOverProcess.push(
+    ProconBypassMan::RemoteMacro::QueueOverProcess.push(
       ProconBypassMan::RemoteMacro::Task.new(name, uuid, steps)
     )
   end

data/lib/procon_bypass_man/remote_macro/task.rb

@@ -1,6 +1,2 @@
-module ProconBypassMan
-  module RemoteMacro
-    class Task < Struct.new(:name, :uuid, :steps)
-    end
-  end
+class ProconBypassMan::RemoteMacro::Task < ::Struct.new(:name, :uuid, :steps)
 end

data/lib/procon_bypass_man/remote_macro/task_queue.rb

@@ -1,13 +1,9 @@
-module ProconBypassMan
-  module RemoteMacro
-    class TaskQueue < ::Queue
-      def present?
-        not empty?
-      end
+class ProconBypassMan::RemoteMacro::TaskQueue < ::Queue
+  def present?
+    not empty?
+  end
 
-      def non_blocking_shift
-        present? && shift
-      end
-    end
+  def non_blocking_shift
+    present? && shift
   end
 end

data/lib/procon_bypass_man/remote_pbm_action/commands/update_remote_pbm_action_status_command.rb

@@ -10,7 +10,7 @@ module ProconBypassMan
     def execute(to_status: )
       ProconBypassMan::UpdateRemotePbmActionStatusHttpClient.new(
         path: path,
-        server_pool: ProconBypassMan.config.server_pool,
+        server: ProconBypassMan.config.api_server,
       ).put(to_status: to_status)
     end
 

data/lib/procon_bypass_man/runner.rb

@@ -1,8 +1,4 @@
-require_relative "io_monitor"
-
 class ProconBypassMan::Runner
-  class InterruptForRestart < StandardError; end
-
   include ProconBypassMan::SignalHandler
 
   def initialize(gadget: , procon: )
@@ -24,14 +20,12 @@ class ProconBypassMan::Runner
 
     loop do
       # NOTE メインプロセスではThreadをいくつか起動しているので念のためパフォーマンスを優先するためにforkしていく
-      child_pid = Kernel.fork {
+      child_pid = Kernel.fork do
         $will_terminate_token = false
-        DRb.start_service if defined?(DRb)
-        ProconBypassMan::RemoteMacroReceiver.start!
-        ProconBypassMan::ProconDisplay::Server.start!
+        ProconBypassMan.after_fork_on_bypass_process
         ProconBypassMan::BypassCommand.new(gadget: @gadget, procon: @procon).execute # ここでblockingする
         next
-      }
+      end
 
       begin
         # TODO 子プロセスが消滅した時に、メインプロセスは生き続けてしまい、何もできなくなる問題がある
@@ -39,7 +33,7 @@ class ProconBypassMan::Runner
           signal = readable_io.first[0].gets.strip
           handle_signal(signal)
         end
-      rescue InterruptForRestart
+      rescue ProconBypassMan::InterruptForRestart
         ProconBypassMan::PrintMessageCommand.execute(text: "設定ファイルの再読み込みを開始します")
         Process.kill("USR2", child_pid)
         Process.wait

data/lib/procon_bypass_man/scheduler.rb

@@ -68,13 +68,22 @@ module ProconBypassMan
     end
 
     def self.register_schedules
-      register(
-        schedule: Schedule.new(
-          klass: ProconBypassMan::SyncDeviceStatsJob,
-          args: [->{ ProconBypassMan::DeviceStatus.current }],
-          interval: 60,
+      if ProconBypassMan.config.has_api_server?
+        register(
+          schedule: Schedule.new(
+            klass: ProconBypassMan::SyncDeviceStatsJob,
+            args: [->{ ProconBypassMan::DeviceStatus.current }],
+            interval: 60,
+          )
         )
-      ) if ProconBypassMan.config.has_api_server?
+        register(
+          schedule: Schedule.new(
+            klass: ProconBypassMan::ReportProconPerformanceMeasurementsJob,
+            args: [->{ ProconBypassMan::Procon::PerformanceMeasurement.pop_measurement_collection }],
+            interval: 60,
+          )
+        )
+      end
     end
 
     # @param [Schedule] schedule

data/lib/procon_bypass_man/support/callbacks.rb

@@ -73,28 +73,32 @@ module ProconBypassMan
     def run_callbacks(kind, &block)
       chains = get_callbacks(kind) or raise("unknown callback")
       if chains.nil? || chains.empty?
-        block.call
-        return
+        return block.call
       end
 
       chains[:before]&.each do |chain|
         send chain.chain_method
       end
-      block.call
+      result = block.call
       chains[:after]&.each do |chain|
         send chain.chain_method
       end
+
+      return result
     end
 
     def get_callbacks(kind) # :nodoc:
       # classに直接moduleをincludeしている場合
-      if defined?(self.class.__callbacks)
+      if defined?(self.class.__callbacks) && !self.class.respond_to?(:callbacks)
         return self.class.__callbacks[kind.to_sym]
       end
 
       list = self.class.callbacks.flat_map { |callback_mod|
         callback_mod.__callbacks && callback_mod.__callbacks[kind.to_sym]
       }.compact
+      if(self.class.respond_to?(:__callbacks) && chain = self.class.__callbacks[kind.to_sym])
+        list << chain
+      end
       table = {}
       table[:before] = list.flat_map { |x| x[:before] }.compact
       table[:after] = list.flat_map { |x| x[:after] }.compact

data/lib/procon_bypass_man/support/can_over_process.rb

@@ -0,0 +1,60 @@
+require 'drb/drb'
+
+# NOTE マスタープロセスでstart_distributed_object!をコールする必要がある
+#      forkをしたらそのさきでDRb.start_serviceをコールする必要がある
+module ProconBypassMan::CanOverProcess
+  PROTOCOL = "drbunix".freeze
+
+  def self.extended(mod)
+    mod.singleton_class.attr_accessor :drb_server, :drb_server_thread
+  end
+
+  # @return [void]
+  def start_distributed_object!
+    return unless enable?
+
+    FileUtils.rm_rf(socket_file_path) if File.exist?(socket_file_path)
+    begin
+      self.drb_server = DRb.start_service(socket_path, distributed_class.new, safe_level: 1)
+    rescue Errno::EADDRINUSE => e
+      ProconBypassMan.logger.error e
+      raise
+    end
+
+    self.drb_server_thread =
+      Thread.new do
+        DRb.thread.join
+      end
+  end
+  alias start! start_distributed_object!
+
+  # @return [void]
+  def shutdown_distributed_object
+    if self.drb_server
+      self.drb_server_thread&.kill
+      self.drb_server_thread = nil
+      self.drb_server.stop_service
+    end
+  end
+  alias shutdown shutdown_distributed_object
+
+  # @return [Boolean]
+  def enable?
+    raise NotImplementedError
+  end
+
+  # @return [String]
+  def socket_file_path
+    raise NotImplementedError
+  end
+
+  # @return [any]
+  def distributed_class
+    raise NotImplementedError
+  end
+
+  # @return [String]
+  def socket_path
+    "#{PROTOCOL}:#{socket_file_path}".freeze
+  end
+end

data/lib/procon_bypass_man/support/gc.rb

@@ -0,0 +1,8 @@
+class ProconBypassMan::GC
+  def self.stop_gc_in(&block)
+    ::GC.disable
+    result = block.call
+    ::GC.enable
+    return result
+  end
+end

data/lib/procon_bypass_man/support/http_client.rb

@@ -26,9 +26,9 @@ module ProconBypassMan
       end
     end
 
-    def initialize(path: , server_pool: , retry_on_connection_error: false)
-      @server_pool = server_pool
-      @uri = URI.parse("#{server_pool.server}#{path}")
+    def initialize(path: , server: , retry_on_connection_error: false)
+      @server = server
+      @uri = URI.parse("#{server}#{path}")
       @retry_on_connection_error = retry_on_connection_error
     end
 
@@ -76,14 +76,13 @@ module ProconBypassMan
           return response.body
         end
       else
-        @server_pool.next!
         ProconBypassMan.logger.error("#{@uri}から200以外(#{response.code})が帰ってきました. #{response.body}")
       end
     end
 
     def handle_request
       raise "need block" unless block_given?
-      if @server_pool.server.nil?
+      if @server.nil?
         ProconBypassMan.logger.info('送信先が未設定なのでスキップしました')
         return
       end
@@ -94,6 +93,10 @@ module ProconBypassMan
         sleep(10)
         retry
       end
+    rescue Timeout::Error
+      ProconBypassMan.logger.error(e)
+      sleep(10)
+      retry
     rescue => e
       puts e
       ProconBypassMan.logger.error(e)
@@ -102,5 +105,5 @@ module ProconBypassMan
 end
 
 if $0 == __FILE__
-  ProconBypassMan::HttpClient.new(path: '/', server_pool: nil, retry_on_connection_error: false).get(response_body: '')
+  ProconBypassMan::HttpClient.new(path: '/', server: nil, retry_on_connection_error: false).get(response_body: '')
 end

data/lib/procon_bypass_man/support/load_agv.rb

@@ -0,0 +1,20 @@
+module ProconBypassMan
+  class LoadAgv
+    PATH = '/proc/loadavg'
+
+    # @return [[Integer, Integer, Integer]]
+    def get
+      loadavg = get_proc_loadavg
+      loadavg =~ /^([0-9.]+)\s([0-9.]+)\s([0-9.]+)/
+      return [$1.to_f, $2.to_f, $3.to_f].join("-")
+    rescue Errno::ENOENT
+      ""
+    end
+
+    private
+
+    def get_proc_loadavg
+      File.read('/proc/loadavg')
+    end
+  end
+end

data/lib/procon_bypass_man/support/procon_performance_http_client.rb

@@ -0,0 +1,7 @@
+module ProconBypassMan
+  class ProconPerformanceHttpClient < HttpClient
+    def post(body: )
+      super(request_body: { body: body })
+    end
+  end
+end