bluepill 0.1.2 → 0.1.4

data/CONTRIBUTING.md

@@ -4,3 +4,34 @@ Contributing
 To ease development and troubleshooting, a simple vagrant environment exists [here](https://github.com/iancoffey/chef_bluepill_devel). A "vagrant up" should do the trick.
 
 As more OS options are added, this should also simplify the steps necessary to reproduce odd issues.
+
+Type checking
+-------------
+
+The RBS signatures in `sig/bluepill.rbs` ship with the gem, and CI checks `lib` against them with [Steep](https://github.com/soutaro/steep) in strict mode. Steep needs Ruby 3.3 or newer. To run the check locally:
+
+    bundle exec rake steep
+
+This installs the signatures of the dependencies into `.gem_rbs_collection`, validates the signatures and runs `steep check`. `sig-vendor` has stubs for the dependencies that publish no signatures. Update `sig/bluepill.rbs` when you change a method in `lib`.
+
+Mutation testing
+----------------
+
+CI runs [mutant](https://github.com/mbj/mutant) on Ruby 4.0, and every mutant must be killed. Mutant needs Ruby 3.3 or newer. To run it on every subject locally:
+
+    bundle exec rake mutant
+
+Or only on the subjects you changed since `master`:
+
+    bundle exec mutant run --since master
+
+CI only mutates the subjects that a push or pull request changes, split into shards that run in parallel. To mutate every subject in CI, run the Mutant workflow from the Actions tab.
+
+Performance
+-----------
+
+[Duel](https://github.com/sferik/duel-ruby) guards against changes that make bluepill slower. The benchmarks in `duel/` cover what bluepill does every tick: parsing `ps`, finding children, running checks, ticking processes, and logging. Duel needs Ruby 3.4 or newer. To compare your branch with `master`:
+
+    bundle exec duel
+
+A pull request that makes a benchmark slower, allocate more, or leave more objects alive fails the Perf workflow. To check that new benchmarks pass on unchanged code, run `bundle exec duel --force`, and to run some of them, add `--filter "^watch:"`.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Arya Asemanfar, Rohith Ravi, Gary Tsang
+Copyright (c) 2009-2026 Arya Asemanfar, Erik Berlin, Rohith Ravi, Gary Tsang
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.md

@@ -1,16 +1,19 @@
 # Bluepill
 Bluepill is a simple process monitoring tool written in Ruby.
 
+[![Duel](https://raw.githubusercontent.com/sferik/duel-ruby/main/assets/badge.svg)](https://github.com/sferik/duel-ruby)
+[![Test](https://github.com/bluepill-rb/bluepill/actions/workflows/test.yml/badge.svg?branch=master)][test]
+[![Lint](https://github.com/bluepill-rb/bluepill/actions/workflows/lint.yml/badge.svg?branch=master)][lint]
+[![Mutant](https://github.com/bluepill-rb/bluepill/actions/workflows/mutant.yml/badge.svg?branch=master)][mutant]
+[![Maintainability](https://qlty.sh/gh/bluepill-rb/projects/bluepill/maintainability.svg)][qlty]
+[![Coverage Status](https://coveralls.io/repos/github/bluepill-rb/bluepill/badge.svg?branch=master)][coveralls]
 [![Gem Version](https://badge.fury.io/rb/bluepill.svg)][gem]
-[![Build Status](https://travis-ci.org/bluepill-rb/bluepill.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/bluepill-rb/bluepill.svg)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/bluepill-rb/bluepill/badges/gpa.svg)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/bluepill-rb/bluepill/badge.svg?branch=master&service=github)][coveralls]
 
 [gem]: https://rubygems.org/gems/bluepill
-[travis]: https://travis-ci.org/bluepill-rb/bluepill
-[gemnasium]: https://gemnasium.com/bluepill-rb/bluepill
-[codeclimate]: https://codeclimate.com/github/bluepill-rb/bluepill
+[test]: https://github.com/bluepill-rb/bluepill/actions/workflows/test.yml
+[lint]: https://github.com/bluepill-rb/bluepill/actions/workflows/lint.yml
+[mutant]: https://github.com/bluepill-rb/bluepill/actions/workflows/mutant.yml
+[qlty]: https://qlty.sh/gh/bluepill-rb/projects/bluepill
 [coveralls]: https://coveralls.io/github/bluepill-rb/bluepill?branch=master
 
 ## Installation
@@ -80,7 +83,7 @@ Bluepill.application("app_name") do |app|
     process.checks :mem_usage, every: 10.seconds, below: 100.megabytes, times: [3,5]
   end
 end
- ```
+```
 
 To watch the modification time of a file, e.g. a log file to ensure the process is actually working add one more line:
 
@@ -225,6 +228,20 @@ end
 
 Note: We also set the PWD in the environment to the working dir you specify. This is useful for when the working dir is a symlink. Unicorn in particular will cd into the environment variable in PWD when it re-execs to deal with a change in the symlink.
 
+To run a command before every start, for example to clear a cache:
+
+```ruby
+Bluepill.application("app_name") do |app|
+  app.process("process_name") do |process|
+    process.pre_start_command = "/usr/bin/some_setup_command"
+    process.start_command = "/usr/bin/some_start_command"
+    process.pid_file = "/tmp/some_pid_file.pid"
+  end
+end
+```
+
+Bluepill waits for the `pre_start_command` to finish, and logs a warning if it exits with a non-zero status, but starts the process either way. It runs in the same `working_dir`, with the same `environment`, `uid`, and `gid`, as the process.
+
 By default, bluepill will send a SIGTERM to your process when stopping.
 To change the stop command:
 
@@ -264,35 +281,34 @@ process.monitor_children do |child_process|
 end
 ```
 
-Note {{PID}} will be substituted for the pid of process in both the stop and restart commands.
+Note `{{PID}}` will be substituted for the pid of process in both the stop and restart commands.
 
-### A Note About Output Redirection
+### Commands Don't Run in a Shell
 
-While you can specify shell tricks like the following in the `start_command` of a process:
+Bluepill splits each command (`start_command`, `pre_start_command`, `stop_command`, and `restart_command`) into words and runs it directly, without a shell. So shell syntax like `cd ... &&`, `VAR=value`, `|`, `>`, `2>&1`, and `*` globs doesn't work.
 
-```ruby
-Bluepill.application("app_name") do |app|
-  app.process("process_name") do |process|
-    process.start_command = "cd /tmp/some_dir && SOME_VAR=1 /usr/bin/some_start_command > /tmp/server.log 2>&1"
-    process.pid_file = "/tmp/some_pid_file.pid"
-  end
-end
-```
-
-We recommend that you _not_ do that and instead use the config options to capture output from your daemons. Like so:
+Use the config options instead:
 
 ```ruby
 Bluepill.application("app_name") do |app|
   app.process("process_name") do |process|
-    process.start_command = "/usr/bin/env SOME_VAR=1 /usr/bin/some_start_command"
+    process.start_command = "/usr/bin/some_start_command"
     process.working_dir = "/tmp/some_dir"
+    process.environment = {"SOME_VAR" => "1"}
     process.stdout = process.stderr = "/tmp/server.log"
     process.pid_file = "/tmp/some_pid_file.pid"
+    process.daemonize = true
   end
 end
 ```
 
-The main benefit of using the config options is that Bluepill will be able to monitor the correct process instead of just watching the shell that spawned your actual server.
+`stdout`, `stderr`, and `stdin` only apply to processes that bluepill daemonizes. A daemonized process starts in `/` unless you set `working_dir`, so use absolute paths or set `working_dir`.
+
+If you really need a shell, run one explicitly, and use `exec` so bluepill monitors your server instead of the shell that started it:
+
+```ruby
+process.start_command = "sh -c 'exec /usr/bin/some_start_command < /tmp/input'"
+```
 
 ### CLI
 
@@ -331,6 +347,24 @@ To quit the bluepill daemon for an application:
 
     sudo bluepill quit
 
+#### bpsv
+
+`bpsv` runs a bluepill command on the process it's named after, so a
+symlink to it works like an init script. For a process named `unicorn`:
+
+    sudo ln -s "$(which bpsv)" /usr/local/bin/unicorn
+    sudo unicorn restart
+
+That runs `bluepill restart unicorn`. Like `bluepill` without an
+_app_name_, it only works when one bluepill daemon is running.
+
+### Examples
+
+[examples/sample_app.rb](examples/sample_app.rb) monitors a small forking
+echo server, and stops any worker that uses too much memory. Its comments
+show how to run it. [examples/runit.rb](examples/runit.rb) monitors a
+service managed by runit.
+
 ### Logging
 By default, bluepill uses syslog local6 facility as described in the installation section. But if for any reason you don&apos;t want to use syslog, you can use a log file. You can do this by setting the :log\_file option in the config:
 
@@ -342,7 +376,8 @@ end
 
 Keep in mind that you still need to set up log rotation (described in the installation section) to keep the log file from growing huge.
 
-### Extra options
+### Foreground mode
+
 You can run bluepill in the foreground:
 
 ```ruby
@@ -353,6 +388,9 @@ end
 
 Note that You must define only one application per config when using foreground mode.
 
+
+JRuby allows you to run bluepill only in the foreground.
+
 ## Links
 
 * Code: [http://github.com/bluepill-rb/bluepill](http://github.com/bluepill-rb/bluepill)
@@ -362,15 +400,16 @@ Note that You must define only one application per config when using foreground
 [rubygems]: http://rubygems.org/gems/bluepill
 
 ## Supported Ruby Versions
-This library aims to support and is [tested against][travis] the following Ruby
+This library aims to support and is [tested against][ci] the following Ruby
 implementations:
 
 * Ruby 1.9.3
-* Ruby 2.0.0
-* Ruby 2.1
-* Ruby 2.2
-* JRuby 1.7
-* JRuby 9.0.0.0
+* Ruby 2.0 through 2.7
+* Ruby 3.0 through 3.4
+* Ruby 4.0
+* JRuby 1.7 (only in the foreground)
+* JRuby 9.0 through 9.4 (only in the foreground)
+* JRuby 10.0 and 10.1 (only in the foreground)
 
 If something doesn't work on one of these interpreters, please open an issue.
 

data/bin/bluepill

@@ -1,4 +1,4 @@
-#! /usr/bin/env ruby
+#!/usr/bin/env ruby
 require 'optparse'
 require 'bluepill'
 
@@ -72,7 +72,7 @@ if options[:privileged] && ::Process.euid != 0
   exit(3)
 end
 
-APPLICATION_COMMANDS = %w(status start stop restart unmonitor quit log)
+APPLICATION_COMMANDS = %w[status start stop restart unmonitor quit log].freeze
 
 controller = Bluepill::Controller.new(options.slice(:base_dir, :log_file))
 

data/bluepill.gemspec

@@ -6,21 +6,32 @@ Gem::Specification.new do |spec|
   spec.name        = 'bluepill'
   spec.version     = Bluepill::Version
   spec.platform    = Gem::Platform::RUBY
-  spec.authors     = ['Arya Asemanfar', 'Gary Tsang', 'Rohith Ravi']
+  spec.authors     = ['Arya Asemanfar', 'Erik Berlin', 'Rohith Ravi', 'Gary Tsang']
   spec.email       = ['entombedvirus@gmail.com']
-  spec.homepage    = 'http://github.com/bluepill-rb/bluepill'
+  spec.homepage    = 'https://github.com/bluepill-rb/bluepill'
   spec.summary     = 'A process monitor written in Ruby with stability and minimalism in mind.'
   spec.description = "Bluepill keeps your daemons up while taking up as little resources as possible. After all you probably want the resources of your server to be used by whatever daemons you are running rather than the thing that's supposed to make sure they are brought back up, should they die or misbehave."
   spec.license     = 'MIT'
 
-  spec.add_dependency 'activesupport', ['>= 3.2', '< 5']
+  # RubyGems before 2.0, which Ruby 1.9.3 ships with, has no metadata
+  if spec.respond_to?(:metadata=)
+    spec.metadata = {
+      'source_code_uri' => 'https://github.com/bluepill-rb/bluepill',
+      'changelog_uri' => 'https://github.com/bluepill-rb/bluepill/blob/master/CHANGELOG.md',
+      'bug_tracker_uri' => 'https://github.com/bluepill-rb/bluepill/issues',
+      'rubygems_mfa_required' => 'true',
+    }
+  end
+
+  spec.add_dependency 'activesupport', '>= 3.2'
   spec.add_dependency 'blue-daemons', '~> 1.1'
   spec.add_dependency 'state_machine', '~> 1.1'
-  spec.add_development_dependency 'bundler', '~> 1.3'
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.files            = %w(CONTRIBUTING.md DESIGN.md LICENSE README.md bluepill.gemspec) + Dir['bin/*'] + Dir['lib/**/*.rb']
-  spec.executables      = Dir['bin/*'].collect { |f| File.basename(f) }
+  # sig has the RBS signatures, and the standard libraries they use in manifest.yaml
+  spec.executables      = %w[bluepill bpsv]
+  spec.files            = %w[CHANGELOG.md CONTRIBUTING.md DESIGN.md LICENSE README.md bluepill.gemspec sig/manifest.yaml] +
+    spec.executables.collect { |f| "bin/#{f}" } + Dir['lib/**/*.rb'] + Dir['sig/**/*.rbs']
   spec.require_paths    = ['lib']
 end