{"id":21062437,"url":"https://github.com/rnd-soft/worker_killer","last_synced_at":"2025-09-14T09:30:30.606Z","repository":{"id":56898494,"uuid":"224639124","full_name":"RND-SOFT/worker_killer","owner":"RND-SOFT","description":"[MIRROR] Kill any workers by memory and request counts or take custom reaction","archived":false,"fork":false,"pushed_at":"2024-04-02T12:03:21.000Z","size":81,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-08T02:09:58.665Z","etag":null,"topics":["delayed-job","gem","rack","rack-middleware","ruby","ruby-on-rails"],"latest_commit_sha":null,"homepage":"https://br.rnds.pro/ruby/worker_killer","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RND-SOFT.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-28T11:32:41.000Z","updated_at":"2024-12-05T11:46:00.000Z","dependencies_parsed_at":"2024-11-15T05:37:44.577Z","dependency_job_id":null,"html_url":"https://github.com/RND-SOFT/worker_killer","commit_stats":{"total_commits":36,"total_committers":2,"mean_commits":18.0,"dds":"0.41666666666666663","last_synced_commit":"8ccaaf221ee2069fac5f8789793a7ff53834c347"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RND-SOFT%2Fworker_killer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RND-SOFT%2Fworker_killer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RND-SOFT%2Fworker_killer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RND-SOFT%2Fworker_killer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RND-SOFT","download_url":"https://codeload.github.com/RND-SOFT/worker_killer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232962563,"owners_count":18603379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["delayed-job","gem","rack","rack-middleware","ruby","ruby-on-rails"],"created_at":"2024-11-19T17:38:52.491Z","updated_at":"2025-01-08T02:10:53.009Z","avatar_url":"https://github.com/RND-SOFT.png","language":"Ruby","readme":"# worker-killer\n\n[![Gem Version](https://badge.fury.io/rb/worker_killer.svg)](https://rubygems.org/gems/worker_killer)\n[![Gem](https://img.shields.io/gem/dt/worker_killer.svg)](https://rubygems.org/gems/worker_killer/versions)\n[![YARD](https://badgen.net/badge/YARD/doc/blue)](http://www.rubydoc.info/gems/worker_killer)\n\n[![Coverage](https://lysander.rnds.pro/api/v1/badges/wkiller_coverage.svg)](https://lysander.rnds.pro/api/v1/badges/wkiller_coverage.html)\n[![Quality](https://lysander.rnds.pro/api/v1/badges/wkiller_quality.svg)](https://lysander.rnds.pro/api/v1/badges/wkiller_quality.html)\n[![Outdated](https://lysander.rnds.pro/api/v1/badges/wkiller_outdated.svg)](https://lysander.rnds.pro/api/v1/badges/wkiller_outdated.html)\n[![Vulnerabilities](https://lysander.rnds.pro/api/v1/badges/wkiller_vulnerable.svg)](https://lysander.rnds.pro/api/v1/badges/wkiller_vulnerable.html)\n\nKill any workers by memory and/or request counts or take custom reaction. Inspired by [unicorn-worker-killer](https://github.com/kzk/unicorn-worker-killer).\n\n`worker-killer` gem provides automatic restart of Web-server and/or background job processor based on 1) max number of requests, and 2) process memory size (RSS). This will greatly improves site's stability by avoiding unexpected memory exhaustion at the application nodes.\n\nFeatures:\n\n- generic middleware implementation\n- Phusion Passenger support(through `passenger-config detach-process \u003cPID\u003e`)\n- Puma support through native plugin\n- DelayedJob support\n- custom reaction hook\n\n# Install\n\nNo external process like `god` is required. Just install one gem: `worker-killer`.\n\n```ruby\n  gem 'worker-killer'\n```\n\n# Usage\n\n## Rack-based Web-server\n\nAdd these lines to your `config.ru` or `application.rb`. (These lines should be added above the `require ::File.expand_path('../config/environment', __FILE__)` line.\n\n```ruby\n  # self-process killer\n  require 'worker_killer/middleware'\n\n  killer = WorkerKiller::Killer::Passenger.new\n\n  # Max requests per worker\n  middleware.insert_before(\n    Rack::Runtime,\n    WorkerKiller::Middleware::RequestsLimiter, killer: killer, min: 3072, max: 4096\n  )\n\n  # Max memory size (RSS) per worker\n  middleware.insert_before(\n    Rack::Runtime,\n    WorkerKiller::Middleware::OOMLimiter, killer: killer, min: nil, max: 0.5, check_cycle: 16\n  )\n```\n\n## DelayedJob background processor\n\nAdd these lines to your `initializers/delayed_job.rb` or `application.rb`.\n\n```ruby\n  # self-process killer\n  require 'worker_killer/delayed_job_plugin'\n\n  Delayed::Worker.plugins.tap do |plugins|\n    killer = WorkerKiller::Killer::DelayedJob.new\n\n    plugins \u003c\u003c WorkerKiller::DelayedJobPlugin::JobsLimiter.new(\n      killer: killer, min: 200, max: 300\n    )\n\n    plugins \u003c\u003c WorkerKiller::DelayedJobPlugin::OOMLimiter.new(\n      killer: killer, min: 500 * (1024**2), max: 600 * (1024**2)\n    )\n  end\n```\n\n## Puma Web-server\n\nAdd these lines to your `puma.rb` AND `application.rb`.\n\n```ruby\n  # puma.rb\n\n  require 'worker_killer/puma/plugin/worker_killer'\n  plugin('worker_killer')\n\n  # application.rb\n  if defined?(::Puma::Client)\n    killer = ::WorkerKiller::PumaPlugin.instance.killer\n\n    config.middleware.insert_before(\n      Rack::Runtime,\n      WorkerKiller::Middleware::OOMLimiter, killer: killer, min: nil, max: 0.5, verbose: false, check_cycle: 16\n    )\n\n    config.middleware.insert_before(\n      Rack::Runtime,\n      WorkerKiller::Middleware::RequestsLimiter, killer: killer, min: 3000, max: 4000, verbose: false\n    )\n  end\n```\n\nThis gem provides two modules: WorkerKiller::CountLimiter and WorkerKiller::MemoryLimiter, some Rack integration, DelayedJob plugin and Puma plugin.\n\n### WorkerKiller::Middleware::RequestsLimiter and WorkerKiller::DelayedJobPlugin::JobsLimiter\n\nThis module automatically restarts/kills the workers, based on the number of requests/jobs which worker processed.\n\n`min` and `max` specify the min and max of maximum requests per worker. The actual limit is decided by rand() between `min` and `max` per worker, to prevent all workers to be dead at the same time. Once the number exceeds the limit, that worker is automatically restarted.\n\nIf `verbose` is set to true, then after every request, your log will show the requests left before restart. This logging is done at the `info` level.\n\n### WorkerKiller::Middleware::OOMLimiter and WorkerKiller::DelayedJobPlugin::OOMLimiter\n\nThis module automatically restarts/kills the workers, based on its memory size.\n\n`min` and `max` specify the min and max of maximum memory in bytes per worker. The actual limit is decided by rand() between `min` and `max` per worker, to prevent all workers to be dead at the same time. Once the memory size exceeds `memory_size`, that worker is automatically restarted.\n\nThe memory size check is done in every `check_cycle` requests.\n\nIf `verbose` is set to true, then every memory size check will be shown in your logs. This logging is done at the `info` level.\n\n### WorkerKiller::PumaPlugin\n\nWorks in Puma `Cluster Mode`. Work correctly with `phased-restart` and `fork_workers`, but has maximum effectivity (memory usage) in simple `Cluster Mode` with **preload_app!**.\n\nExample production config: \n\n```ruby\n  port ENV.fetch('PUMA_PORT', 3000).to_i\n\n  environment ENV.fetch('RAILS_ENV', 'development')\n\n  pidfile ENV.fetch('PUMA_PIDFILE', 'tmp/pids/server.pid')\n\n  threads ENV.fetch('PUMA_THREADS', 4).to_i\n\n  workers ENV.fetch('PUMA_WORKERS', 3).to_i\n\n  require 'worker_killer/puma/plugin/worker_killer'\n  plugin('worker_killer')\n\n  preload_app!\n```\n\n# Special Thanks\n\n- [@hotchpotch](http://github.com/hotchpotch/) for the [original idea](https://gist.github.com/hotchpotch/1258681)\n- [@kzk](http://github.com/kzk/) for the [unicorn-worker-killer](https://github.com/kzk/unicorn-worker-killer)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frnd-soft%2Fworker_killer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frnd-soft%2Fworker_killer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frnd-soft%2Fworker_killer/lists"}