puma-plugin-systemd 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331bad09b8a7f0e62675cd82edb25ac4154f062aa68c0a0d8281018ba276dd8b
-  data.tar.gz: 81e80990542efce424e76f4155a7bb4e416d63036163ac6b33aebbe88f20adc1
+  metadata.gz: 58415395213c4ab44c816dd21f22aee85da0f86adb50e94d1ba4bd627d7d66b3
+  data.tar.gz: 88cb0b6f956b3fa4547671aa365fd6287c2af8ba6c795efdb27d4a0f3f4b2e66
 SHA512:
-  metadata.gz: c38c6cc61c8695eaa7b28406899d95c75e1a65a4754f98a947948e87ea3329544c303defd99eba30263e896e3f2712524e2bec0730ce159cddf16216715540fc
-  data.tar.gz: d3991a2398c378bfe02eb49a6e813180998d609a14d929d48a69cda5f2ba5732f120909b08ff287a8a373dc3a33503e45f93a6e2f4a6515ccba505027dc8898f
+  metadata.gz: f728a069997b449299d828fae771ba33a89efab3675df5518cbb952819155f3159aae22a4cab535d48688d65774eca89c6d2d553b723f7291e8e749378d782a3
+  data.tar.gz: 6f0fa1f9a1f2132ecba2990cfe44b394fe3d886d18e741a97ea192fa5bd22b47a02084f226c8e1b5da948ade8d976cf9ede36f27acbf74c6d2db91fe488b757e

data/README.md

@@ -31,7 +31,7 @@ Add it to your puma config:
 ```ruby
 # config/puma.rb
 
-bind "http://127.0.0.1:9292"
+bind "tcp://127.0.0.1:9292"
 
 workers 2
 threads 8, 16
@@ -115,6 +115,27 @@ release a new version, update the version number in `version.rb`, and then run
 `bundle exec rake release`, which will create a git tag for the version, push
 git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Testing
+
+There are few automated tests yet.
+
+There is an `example` directory which contains a Dockerfile and basic
+configuration for testing. To use it:
+
+```
+# Build an image with systemd and puma configured
+docker build -t puma-plugin-systemd-example -f example/Dockerfile .
+
+# Start a new container from the image in the background
+docker run --name puma-plugin-systemd --privileged --detach --rm puma-plugin-systemd
+
+# Show puma systemd integration
+docker exec puma-plugin-systemd-example systemctl status puma
+
+# Stop the container
+docker exec puma-plugin-systemd-example halt
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at

data/lib/puma/plugin/systemd.rb

@@ -28,12 +28,19 @@ class Puma::Plugin::Systemd
     @launcher.events.debug "systemd: WATCHDOG_PID=#{ENV["WATCHDOG_PID"].inspect}"
     @launcher.events.debug "systemd: WATCHDOG_USEC=#{ENV["WATCHDOG_USEC"].inspect}"
 
-    # Only install hooks if systemd is present, the systemd is booted by
-    # systemd, and systemd has asked us to notify it of events.
+    # Only install hooks if the system is booted by systemd, and systemd has
+    # asked us to notify it of events.
     @systemd = Systemd.new
-    if @systemd.present? && @systemd.booted? && @systemd.notify?
+    if @systemd.booted? && @systemd.notify?
       @launcher.events.debug "systemd: detected running inside systemd, registering hooks"
+
       register_hooks
+
+      # In clustered mode, we can start the status loop early and watch the
+      # workers boot
+      start_status_loop_thread if clustered?
+
+      start_watchdog_loop_thread if @systemd.watchdog?
     else
       @launcher.events.debug "systemd: not running within systemd, doing nothing"
     end
@@ -51,10 +58,8 @@ class Puma::Plugin::Systemd
   end
 
   def register_hooks
-    (@launcher.config.options[:on_restart] ||= []) << method(:restart)
     @launcher.events.on_booted(&method(:booted))
-    in_background(&method(:status_loop))
-    in_background(&method(:watchdog_loop)) if @systemd.watchdog?
+    (@launcher.config.options[:on_restart] ||= []) << method(:restart)
   end
 
   def booted
@@ -64,6 +69,10 @@ class Puma::Plugin::Systemd
     rescue
       @launcher.events.error "! systemd: notify ready failed:\n  #{$!.to_s}\n  #{$!.backtrace.join("\n    ")}"
     end
+
+    # In single mode, we can only start the status loop once the server is
+    # started after booted
+    start_status_loop_thread
   end
 
   def restart(launcher)
@@ -97,6 +106,12 @@ class Puma::Plugin::Systemd
     end
   end
 
+  def start_status_loop_thread
+    # This is basically what Puma::Plugins.add_background / fire_background
+    # does, but at a time of our choosing.
+    @status_loop_thread ||= Thread.new(&method(:status_loop))
+  end
+
   # If watchdog is configured we'll send a ping at about half the timeout
   # configured in systemd as recommended in the docs.
   def watchdog_loop
@@ -119,6 +134,10 @@ class Puma::Plugin::Systemd
     end
   end
 
+  def start_watchdog_loop_thread
+    @watchdog_loop_thread ||= Thread.new(&method(:watchdog_loop))
+  end
+
   # Give us a way to talk to systemd.
   #
   # It'd be great to use systemd-notify for the whole shebang, but there's a
@@ -137,29 +156,14 @@ class Puma::Plugin::Systemd
   #   https://www.freedesktop.org/software/systemd/man/sd-daemon.html
   #
   class Systemd
-    # Do we have a systemctl binary? This is a good indicator whether systemd
-    # is installed at all.
-    def present?
-      ENV["PATH"].split(":").any? { |dir| File.exists?(File.join(dir, "systemctl")) }
-    end
-
     # Is the system currently booted with systemd?
     #
-    # We could check for the systemd run directory directly, but we can't be
-    # absolutely sure of it's location and breaks encapsulation. We can be sure
-    # that systemctl is present on a systemd system and understand whether
-    # systemd is running. The systemd-notify binary actually recommends this.
-    #
-    #   An alternate way to check for this state is to call systemctl(1) with
-    #   the is-system-running command. It will return "offline" if the system
-    #   was not booted with systemd.
-    #
     # See also sd_booted:
     #
     #   https://www.freedesktop.org/software/systemd/man/sd_booted.html
     #
     def booted?
-      IO.popen(["systemctl", "is-system-running"], &:read).chomp != "offline"
+      File.directory?("/run/systemd/system/")
     end
 
     # Are we running within a systemd unit that expects us to notify?
@@ -260,11 +264,27 @@ class Puma::Plugin::Systemd
       end
     end
 
+    def pool_capacity
+      if clustered?
+        @stats["worker_status"].map { |s| s["last_status"].fetch("pool_capacity", 0) }.inject(0, &:+)
+      else
+        @stats.fetch("pool_capacity", 0)
+      end
+    end
+
+    def max_threads
+      if clustered?
+        @stats["worker_status"].map { |s| s["last_status"].fetch("max_threads", 0) }.inject(0, &:+)
+      else
+        @stats.fetch("max_threads", 0)
+      end
+    end
+
     def to_s
       if clustered?
-        "puma #{Puma::Const::VERSION} cluster: #{booted_workers}/#{workers} workers: #{running} threads, #{backlog} backlog"
+        "puma #{Puma::Const::VERSION} cluster: #{booted_workers}/#{workers} workers: #{running}/#{max_threads} threads, #{pool_capacity} available, #{backlog} backlog"
       else
-        "puma #{Puma::Const::VERSION}: #{running} threads, #{backlog} backlog"
+        "puma #{Puma::Const::VERSION}: #{running}/#{max_threads} threads, #{pool_capacity} available, #{backlog} backlog"
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma-plugin-systemd
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Samuel Cochran
@@ -28,7 +28,7 @@ cert_chain:
   cTRkS42ilkarelc4DnSSO5jw7qFq7Cmf6F9hMx3xdoSWpLf+FvXJRbYrqwZIsmME
   V8zEtJFhdNOFOdtcTE67qh/aYQe2y/LDnG9ywXHWdSeF4UUjg1WRt8s3OP8=
   -----END CERTIFICATE-----
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puma