service_skeleton 0.0.0.1.ENOTAG → 0.0.0.2.g46c1e0e

data/lib/service_skeleton/signal_handler.rb

@@ -0,0 +1,183 @@
+require_relative "./background_worker"
+require_relative "./logging_helpers"
+
+class ServiceSkeleton
+  # Manage signals in a sane and safe manner.
+  #
+  # Signal handling is a shit of a thing.  The code that runs when a signal is
+  # triggered can't use mutexes (which are used in all sorts of places you
+  # might not expect, like Logger!) or anything else that might block.  This
+  # greatly constrains what you can do inside a signal handler, so the standard
+  # approach is to stuff a character down a pipe, and then have the *real*
+  # signal handling run later.
+  #
+  # Also, there's always the (slim) possibility that something else might have
+  # hooked into a signal we want to receive.  Because only a single signal
+  # handler can be active for a given signal at a time, we need to "chain" the
+  # existing handler, by calling the previous signal handler from our signal
+  # handler after we've done what we need to do.  This class takes care of
+  # that, too, because it's a legend.
+  #
+  # So that's what this class does: it allows you to specify signals and
+  # associated blocks of code to run, it sets up signal handlers which send
+  # notifications to a background thread and chain correctly, and it manages
+  # the background thread to receive the notifications and execute the
+  # associated blocks of code outside of the context of the signal handler.
+  #
+  class SignalHandler
+    include ServiceSkeleton::LoggingHelpers
+    include ServiceSkeleton::BackgroundWorker
+
+    # Setup a signal handler instance.
+    #
+    # A single signal handler instance can handle up to 256 hooks, potentially
+    # hooking the same signal more than once.  Use #hook_signal to register
+    # signal handling callbacks.
+    #
+    # @param logger [Logger] the logger to use for all the interesting information
+    #   about what we're up to.
+    #
+    def initialize(logger:, service:, signal_counter:)
+      @logger, @service, @signal_counter = logger, service, signal_counter
+
+      @signal_registry = []
+
+      super
+    end
+
+    #:nocov:
+
+    # Register a callback to be executed on the receipt of a specified signal.
+    #
+    # @param sig [String, Symbol, Integer] the signal to hook into.  Anything that
+    #   `Signal.trap` will accept is OK by us, too.
+    #
+    # @param blk [Proc] the code to run when the signal is received.
+    #
+    # @return [void]
+    #
+    # @raise [RuntimeError] if you try to create more than 256 signal hooks.
+    #
+    # @raise [ArgumentError] if `sig` isn't recognised as a valid signal
+    #   specifier by `Signal.trap`.
+    #
+    def hook_signal(sig, &blk)
+      @bg_worker_op_mutex.synchronize do
+        handler_num = @signal_registry.length
+
+        if handler_num > 255
+          raise RuntimeError,
+                "Signal hook limit reached.  Slow down there, pardner"
+        end
+
+        sigspec = { signal: sig, callback: blk }
+
+        if @bg_worker_thread
+          install_handler(sigspec, handler_num)
+        else
+          # If the background thread isn't running yet, the signal handler will
+          # be installed when that is started.
+        end
+
+        @signal_registry << sigspec
+      end
+    end
+
+    def start
+      logger.info("SignalHandler#start") { "Starting signal handler with #{@signal_registry.length} hooks" }
+
+      @r, @w = IO.pipe
+
+      install_signal_handlers
+
+      loop do
+        begin
+          if ios = IO.select([@r])
+            if ios.first.include?(@r)
+              if ios.first.first.eof?
+                logger.info("SignalHandler#run") { "Signal pipe closed; shutting down" }
+                break
+              else
+                c = ios.first.first.read_nonblock(1)
+                handle_signal(c)
+              end
+            else
+              logger.error("SignalHandler#run") { "Mysterious return from select: #{ios.inspect}" }
+            end
+          end
+        rescue StandardError => ex
+          log_exception(ex) { "Exception in select loop" }
+        end
+      end
+    end
+
+    private
+
+    attr_reader :logger
+
+    # Given a character (presumably) received via the signal pipe, execute the
+    # associated handler.
+    #
+    # @param char [String] a single character, corresponding to an entry in the
+    #   signal registry.
+    #
+    # @return [void]
+    #
+    def handle_signal(char)
+      handler = @signal_registry[char.ord]
+
+      if handler
+        logger.debug("SignalHandler#handle_signal") { "#{handler[:signal]} received" }
+        @signal_counter.increment(signal: handler[:signal].to_s)
+        begin
+          handler[:callback].call
+        rescue => ex
+          log_exception(ex) { "Exception in signal handler" }
+        end
+      else
+        logger.error("SignalHandler#handle_signal") { "Unrecognised signal character: #{char.inspect}" }
+      end
+    end
+
+    def install_signal_handlers
+      @signal_registry.each_with_index do |sigspec, i|
+        install_handler(sigspec, i)
+      end
+    end
+
+    def install_handler(sigspec, i)
+      chain = nil
+
+      p = ->(_) do
+        @w.write_nonblock(i.chr) rescue nil
+        chain.call if chain.respond_to?(:call)
+      end
+      chain = Signal.trap(sigspec[:signal], &p)
+
+      sigspec[:chain] = chain
+      sigspec[:handler] = p
+    end
+
+    def shutdown
+      uninstall_signal_handlers
+
+      @r.close
+    end
+
+    def uninstall_signal_handlers
+      @signal_registry.reverse.each do |sigspec|
+        tmp_sig = Signal.trap(sigspec[:signal], "IGNORE")
+        if tmp_sig == sigspec[:handler]
+          # The current handler is ours, so we can replace
+          # it with the chained handler
+          Signal.trap(sigspec[:signal], sigspec[:chain])
+        else
+          # The current handler *isn't* this one, so we better
+          # put it back, because whoever owns it might get
+          # angry.
+          Signal.trap(sigspec[:signal], tmp_sig)
+        end
+      end
+    end
+  end
+end

data/lib/service_skeleton.rb

@@ -1,13 +1,8 @@
-# frozen_string_literal: true
-
-require_relative "service_skeleton/config_class"
+require_relative "service_skeleton/config"
 require_relative "service_skeleton/config_variables"
-require_relative "service_skeleton/generator"
 require_relative "service_skeleton/logging_helpers"
 require_relative "service_skeleton/metrics_methods"
-require_relative "service_skeleton/service_name"
-require_relative "service_skeleton/signals_methods"
-require_relative "service_skeleton/ultravisor_children"
+require_relative "service_skeleton/signal_handler"
 
 require "frankenstein/ruby_gc_metrics"
 require "frankenstein/ruby_vm_metrics"
@@ -16,26 +11,154 @@ require "frankenstein/server"
 require "prometheus/client/registry"
 require "sigdump"
 
-module ServiceSkeleton
+class ServiceSkeleton
+  extend ServiceSkeleton::ConfigVariables
+
   include ServiceSkeleton::LoggingHelpers
-  extend ServiceSkeleton::Generator
 
-  def self.included(mod)
-    mod.extend ServiceSkeleton::ServiceName
-    mod.extend ServiceSkeleton::ConfigVariables
-    mod.extend ServiceSkeleton::ConfigClass
-    mod.extend ServiceSkeleton::MetricsMethods
-    mod.extend ServiceSkeleton::SignalsMethods
-    mod.extend ServiceSkeleton::UltravisorChildren
+  def self.config_class(klass)
+    @config_class = klass
+  end
+
+  def self.service_name
+    self.to_s
+      .gsub("::", "_")
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .downcase
   end
 
   attr_reader :config, :metrics, :logger
 
-  def initialize(*_, metrics:, config:)
-    @metrics = metrics
-    @config  = config
-    @logger  = @config.logger
+  def initialize(env)
+    @env = env
+    @config = (self.class.instance_variable_get(:@config_class) || ServiceSkeleton::Config).new(env, self)
+    @logger = @config.logger
+
+    setup_metrics
+    setup_signals
+  end
+
+  def start
+    begin
+      start_metrics_server
+      start_signal_handler
+      run
+    rescue ServiceSkeleton::Error::InheritanceContractError
+      # We want this one to be fatal
+      raise
+    rescue StandardError => ex
+      log_exception(ex)
+    end
+  end
+
+  def stop(force = false)
+    shutdown
+
+    if @metrics_server
+      @metrics_server.shutdown
+      @metrics_server = nil
+    end
+
+    @signal_handler.stop!
+  end
+
+  def service_name
+    self.class.service_name
+  end
+
+  def registered_variables
+    self.class.registered_variables
+  end
+
+  def hook_signal(spec, &blk)
+    @signal_handler.hook_signal(spec, &blk)
+  end
+
+  private
+
+  def run
+    raise ServiceSkeleton::Error::InheritanceContractError, "ServiceSkeleton#run method not overridden"
   end
-end
 
-require_relative "service_skeleton/runner"
+  def setup_metrics
+    @metrics = Prometheus::Client::Registry.new
+
+    Frankenstein::RubyGCMetrics.register(@metrics)
+    Frankenstein::RubyVMMetrics.register(@metrics)
+    Frankenstein::ProcessMetrics.register(@metrics)
+
+    @metrics.singleton_class.prepend(ServiceSkeleton::MetricsMethods)
+    @metrics.service = self
+
+  end
+
+  def start_metrics_server
+    if config.metrics_port
+      logger.info(self.class.to_s) { "Starting metrics server on port #{config.metrics_port}" }
+
+      @metrics_server = Frankenstein::Server.new(
+        port: config.metrics_port,
+        logger: logger,
+        metrics_prefix: :metrics_server,
+        registry: @metrics,
+      )
+      @metrics_server.run
+    end
+  end
+
+  def setup_signals
+    @signal_handler = ServiceSkeleton::SignalHandler.new(logger: logger, service: self, signal_counter: metrics.counter(:"#{service_name}_signals_handled_total", "How many of each type of signal have been handled"))
+
+    @signal_handler.hook_signal("USR1") do
+      logger.level -= 1 unless logger.level == Logger::DEBUG
+      logger.info($0) { "Received SIGUSR1; log level is now #{Logger::SEV_LABEL[logger.level]}." }
+    end
+
+    @signal_handler.hook_signal("USR2") do
+      logger.level += 1 unless logger.level == Logger::ERROR
+      logger.info($0) { "Received SIGUSR2; log level is now #{Logger::SEV_LABEL[logger.level]}." }
+    end
+
+    @signal_handler.hook_signal("HUP") do
+      logger.reopen
+      logger.info($0) { "Received SIGHUP; log file handle reopened" }
+    end
+
+    @signal_handler.hook_signal("QUIT") do
+      Sigdump.dump("+")
+    end
+
+    @signal_handler.hook_signal("INT") do
+      self.stop(!!@terminating)
+      @terminating = true
+    end
+
+    @signal_handler.hook_signal("TERM") do
+      self.stop(!!@terminating)
+      @terminating = true
+    end
+  end
+
+  def start_signal_handler
+    @signal_handler.start!
+  end
+
+  @registered_variables = [
+    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_LEVEL) { "INFO" },
+    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_ENABLE_TIMESTAMPS) { false },
+    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_FILE) { nil },
+    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_MAX_FILE_SIZE) { 1048576 },
+    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_LOG_MAX_FILES) { 3 },
+    ServiceSkeleton::ConfigVariable.new(:SERVICE_SKELETON_METRICS_PORT) { nil },
+  ]
+
+  def self.inherited(subclass)
+    subclass.string(:"#{subclass.service_name.upcase}_LOG_LEVEL", default: "INFO")
+    subclass.boolean(:"#{subclass.service_name.upcase}_LOG_ENABLE_TIMESTAMPS", default: false)
+    subclass.string(:"#{subclass.service_name.upcase}_LOG_FILE", default: nil)
+    subclass.integer(:"#{subclass.service_name.upcase}_LOG_MAX_FILE_SIZE", default: 1048576, range: 0..Float::INFINITY)
+    subclass.integer(:"#{subclass.service_name.upcase}_LOG_MAX_FILES", default: 3, range: 1..Float::INFINITY)
+    subclass.integer(:"#{subclass.service_name.upcase}_METRICS_PORT", default: nil, range: 1..65535)
+  end
+end

data/service_skeleton.gemspec

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 begin
   require 'git-version-bump'
 rescue LoadError
@@ -24,17 +22,19 @@ Gem::Specification.new do |s|
     common aspects of a system service.
   EOF
 
-  s.authors  = ["Matt Palmer", "Sam Saffron"]
-  s.email    = ["sam.saffron@discourse.org"]
+  s.authors  = ["Matt Palmer"]
+  s.email    = ["matt.palmer@discourse.org"]
   s.homepage = "https://github.com/discourse/service_skeleton"
 
   s.files = `git ls-files -z`.split("\0").reject { |f| f =~ /^(G|spec|Rakefile)/ }
 
-  s.required_ruby_version = ">= 2.5.0"
+  s.required_ruby_version = ">= 2.3.0"
 
-  s.add_runtime_dependency "frankenstein", "~> 2.0"
-  s.add_runtime_dependency "loggerstash", ">= 0.0.9", "< 1"
-  s.add_runtime_dependency "prometheus-client", "~> 2.0"
+  s.add_runtime_dependency "frankenstein", "~> 1.2"
+  # prometheus-client provides no guaranteed backwards compatibility,
+  # and in fact happily breaks things with no notice, so we're stuck
+  # with hard-coding a specific version to avoid unexpected disaster.
+  s.add_runtime_dependency "prometheus-client", "0.8.0"
   s.add_runtime_dependency "sigdump", "~> 0.2"
   s.add_runtime_dependency "to_regexp", "~> 0.2"
 
@@ -44,11 +44,10 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'guard-rspec'
   s.add_development_dependency 'guard-rubocop'
   s.add_development_dependency 'rack-test'
-  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rake', "~> 12.0"
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop'
-  s.add_development_dependency 'rubocop-discourse'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'yard'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_skeleton
 version: !ruby/object:Gem::Version
-  version: 0.0.0.1.ENOTAG
+  version: 0.0.0.2.g46c1e0e
 platform: ruby
 authors:
 - Matt Palmer
-- Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: frankenstein
@@ -17,48 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: loggerstash
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: prometheus-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: sigdump
   requirement: !ruby/object:Gem::Requirement
@@ -175,16 +154,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -227,20 +206,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-discourse
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -277,79 +242,30 @@ description: |
   for your services, as well as a collection of helper classes to manage
   common aspects of a system service.
 email:
-- sam.saffron@discourse.org
+- matt.palmer@discourse.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".git-blame-ignore-revs"
-- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - LICENCE
 - README.md
 - lib/service_skeleton.rb
+- lib/service_skeleton/background_worker.rb
 - lib/service_skeleton/config.rb
-- lib/service_skeleton/config_class.rb
 - lib/service_skeleton/config_variable.rb
-- lib/service_skeleton/config_variable/boolean.rb
-- lib/service_skeleton/config_variable/enum.rb
-- lib/service_skeleton/config_variable/float.rb
-- lib/service_skeleton/config_variable/integer.rb
-- lib/service_skeleton/config_variable/kv_list.rb
-- lib/service_skeleton/config_variable/path_list.rb
-- lib/service_skeleton/config_variable/string.rb
-- lib/service_skeleton/config_variable/url.rb
-- lib/service_skeleton/config_variable/yaml_file.rb
 - lib/service_skeleton/config_variables.rb
 - lib/service_skeleton/error.rb
 - lib/service_skeleton/filtering_logger.rb
-- lib/service_skeleton/generator.rb
 - lib/service_skeleton/logging_helpers.rb
-- lib/service_skeleton/metric_method_name.rb
 - lib/service_skeleton/metrics_methods.rb
-- lib/service_skeleton/runner.rb
-- lib/service_skeleton/service_name.rb
-- lib/service_skeleton/signal_manager.rb
-- lib/service_skeleton/signals_methods.rb
-- lib/service_skeleton/ultravisor_children.rb
-- lib/service_skeleton/ultravisor_loggerstash.rb
+- lib/service_skeleton/signal_handler.rb
 - service_skeleton.gemspec
-- ultravisor/.yardopts
-- ultravisor/Guardfile
-- ultravisor/README.md
-- ultravisor/lib/ultravisor.rb
-- ultravisor/lib/ultravisor/child.rb
-- ultravisor/lib/ultravisor/child/call.rb
-- ultravisor/lib/ultravisor/child/call_receiver.rb
-- ultravisor/lib/ultravisor/child/cast.rb
-- ultravisor/lib/ultravisor/child/cast_receiver.rb
-- ultravisor/lib/ultravisor/child/process_cast_call.rb
-- ultravisor/lib/ultravisor/error.rb
-- ultravisor/lib/ultravisor/logging_helpers.rb
-- ultravisor/spec/example_group_methods.rb
-- ultravisor/spec/example_methods.rb
-- ultravisor/spec/spec_helper.rb
-- ultravisor/spec/ultravisor/add_child_spec.rb
-- ultravisor/spec/ultravisor/child/call_spec.rb
-- ultravisor/spec/ultravisor/child/cast_spec.rb
-- ultravisor/spec/ultravisor/child/id_spec.rb
-- ultravisor/spec/ultravisor/child/new_spec.rb
-- ultravisor/spec/ultravisor/child/restart_delay_spec.rb
-- ultravisor/spec/ultravisor/child/restart_spec.rb
-- ultravisor/spec/ultravisor/child/run_spec.rb
-- ultravisor/spec/ultravisor/child/shutdown_spec.rb
-- ultravisor/spec/ultravisor/child/spawn_spec.rb
-- ultravisor/spec/ultravisor/child/unsafe_instance_spec.rb
-- ultravisor/spec/ultravisor/child/wait_spec.rb
-- ultravisor/spec/ultravisor/new_spec.rb
-- ultravisor/spec/ultravisor/remove_child_spec.rb
-- ultravisor/spec/ultravisor/run_spec.rb
-- ultravisor/spec/ultravisor/shutdown_spec.rb
 homepage: https://github.com/discourse/service_skeleton
 licenses: []
 metadata: {}
@@ -361,14 +277,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: The bare bones of a service

data/.editorconfig

@@ -1,7 +0,0 @@
-[*.rb]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-insert_final_newline = true
-charset = utf-8
-trim_trailing_whitespace = true

data/.git-blame-ignore-revs

@@ -1,2 +0,0 @@
-# Reformatting ultravisor
-5a89b13dce618cd2544c5518833c4f1587a38ee7

data/.github/workflows/ci.yml

@@ -1,50 +0,0 @@
-name: Service Skeleton Tests
-
-on:
-  pull_request:
-  push:
-    branches:
-      - master
-    tags:
-      - v*
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
-    strategy:
-      matrix:
-        ruby: ["2.5", "2.6", "2.7"]
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: Bundler cache
-        uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-
-      - name: Setup gems
-        run: |
-          gem install bundler
-          bundle config path vendor/bundle
-          bundle install --jobs 4
-      - name: Rubocop
-        run: bundle exec rubocop
-      - name: Tests
-        run: bundle exec rspec
-      - name: Ultravisor Tests
-        run: bundle exec rspec ultravisor/spec
-  publish:
-    if: contains(github.ref, 'refs/tags/v')
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Release Gem
-        uses: CvX/publish-rubygems-action@master
-        env:
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}