v0.1.0

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.1.0
+
+- Emit extra data via `pre_term` callback before puma worker killer terminates a worker #49.
+
 ## 0.0.7
 
 - Logging is configurable #41

README.md

@@ -105,8 +105,8 @@ PumaWorkerKiller.config do |config|
   config.rolling_restart_frequency = 12 * 3600 # 12 hours in seconds
   config.reaper_status_logs = true # setting this to false will not log lines like:
   # PumaWorkerKiller: Consuming 54.34765625 mb with master and 2 workers.
-  
-  config.pre_term = -> (worker) {} #nop
+
+  config.pre_term = -> (worker) { puts "Worker #{worker.inspect} being killed" }
 end
 PumaWorkerKiller.start
 ```
@@ -115,6 +115,20 @@ PumaWorkerKiller.start
 
 `config.pre_term` will be called just prior to worker termination with the worker that is about to be terminated. This may be useful to use in keeping track of metrics, time of day workers are restarted, etc.
 
+By default Puma Worker Killer will emit a log when a worker is being killed
+
+```
+PumaWorkerKiller: Out of memory. 5 workers consuming total: 500 mb out of max: 450 mb. Sending TERM to pid 23 consuming 53 mb.
+```
+
+or
+
+```
+PumaWorkerKiller: Rolling Restart. 5 workers consuming total: 650mb mb. Sending TERM to pid 34.
+```
+
+However you may want to collect more data, such as sending an event to an error collection service like rollbar or airbrake. The `pre_term` lambda gets called before any worker is killed by PWK for any reason.
+
 ## Attention
 
 If you start puma as a daemon, to add puma worker killer config into puma config file, rather than into initializers:

lib/puma_worker_killer/version.rb

@@ -1,3 +1,3 @@
 module PumaWorkerKiller
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end