good_job 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ea00429e2b1515df6973f66c81d1827acdb4528e39ac811ece90a69fbd0b4f6
-  data.tar.gz: 9d3c7e104fda0d102789fc97fb716e5372c6e746d169fb521b84ecf13312ce24
+  metadata.gz: 1f3fa6d323c18dfb49aaf3b87f0ca71492a935752e7ca140880b68daa72a60f9
+  data.tar.gz: 999b400b7e1dd22206898fb1cdc35f6255088ce94c3562fa48fe97fc20a23672
 SHA512:
-  metadata.gz: 7f34e2681a4642c9c337dd76253950a46d1edbff21feb6940eace1fa99b63d3d919f1eb3b2ae56b90d06d0697229c47ac581998be8615abc594c308255325fb1
-  data.tar.gz: fc69543344585cbfc7cb7608cce5884526481cbf75474a70d2ddea5737ff1eaea722743ad1508e683a2bbeda91e4399d25c8b1294cb3a763d1436b36ece74b77
+  metadata.gz: 1b9236562e20d4da1e5738d9b143fabe9377d854b392b6b0eb2d77c0009d9f8a0c82ef94b414446a7b5db0b2a43e477ad4b8a6c7bff737b69c9d8a744ee29151
+  data.tar.gz: cfcc994ea2f6e9a26c3b1115ccb2df6383e2897c3db891415745b86769dbdc411a62b7d60c89aa7ddb6880009c6124c795cef33efff55daa860ed7fd90e1b81d

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## [v1.2.4](https://github.com/bensheldon/good_job/tree/v1.2.4) (2020-09-01)
+
+[Full Changelog](https://github.com/bensheldon/good_job/compare/v1.2.3...v1.2.4)
+
+**Implemented enhancements:**
+
+- Add environment variable to mirror `cleanup\_preserved\_jobs --before-seconds-ago=SECONDS` [\#110](https://github.com/bensheldon/good_job/issues/110)
+
+**Closed issues:**
+
+- Remove unused PgLocks class [\#121](https://github.com/bensheldon/good_job/issues/121)
+- Fix minor issue with CommandLine option links in README.md [\#116](https://github.com/bensheldon/good_job/issues/116)
+- Unused .advisory\_lock\_details in PgLocks [\#105](https://github.com/bensheldon/good_job/issues/105)
+
+**Merged pull requests:**
+
+- Remove unused PgLocks class [\#120](https://github.com/bensheldon/good_job/pull/120) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
+- Better table name detection for Job queries [\#119](https://github.com/bensheldon/good_job/pull/119) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
+- Fix readme CommandLine option links [\#115](https://github.com/bensheldon/good_job/pull/115) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
+- Allow env variable config for cleanups [\#114](https://github.com/bensheldon/good_job/pull/114) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
+- Have YARD render markdown files with GFM \(Github Flavored Markdown\) [\#113](https://github.com/bensheldon/good_job/pull/113) ([bensheldon](https://github.com/bensheldon))
+- Add markdownlint to lint readme [\#109](https://github.com/bensheldon/good_job/pull/109) ([bensheldon](https://github.com/bensheldon))
+- Remove unused method in PgLocks [\#107](https://github.com/bensheldon/good_job/pull/107) ([gadimbaylisahil](https://github.com/gadimbaylisahil))
+- Re-organize Readme: frontload configuration, add Table of Contents  [\#106](https://github.com/bensheldon/good_job/pull/106) ([bensheldon](https://github.com/bensheldon))
+
 ## [v1.2.3](https://github.com/bensheldon/good_job/tree/v1.2.3) (2020-08-27)
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.2.2...v1.2.3)
@@ -63,6 +88,7 @@
 **Merged pull requests:**
 
 - Document GoodJob module [\#83](https://github.com/bensheldon/good_job/pull/83) ([bensheldon](https://github.com/bensheldon))
+- Add Postgres LISTEN/NOTIFY support [\#82](https://github.com/bensheldon/good_job/pull/82) ([bensheldon](https://github.com/bensheldon))
 
 ## [v1.1.4](https://github.com/bensheldon/good_job/tree/v1.1.4) (2020-08-19)
 
@@ -75,7 +101,6 @@
 
 **Merged pull requests:**
 
-- Add Postgres LISTEN/NOTIFY support [\#82](https://github.com/bensheldon/good_job/pull/82) ([bensheldon](https://github.com/bensheldon))
 - Allow Schedulers to filter \#create\_thread to avoid flood of queries when running async with multiple schedulers [\#81](https://github.com/bensheldon/good_job/pull/81) ([bensheldon](https://github.com/bensheldon))
 - Fully name scheduler threadpools and thread names; refactor CLI STDOUT [\#80](https://github.com/bensheldon/good_job/pull/80) ([bensheldon](https://github.com/bensheldon))
 
@@ -157,10 +182,6 @@
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v1.0.1...v1.0.2)
 
-**Fixed bugs:**
-
-- Fix counting of available execution threads [\#58](https://github.com/bensheldon/good_job/pull/58) ([bensheldon](https://github.com/bensheldon))
-
 **Merged pull requests:**
 
 - Add migration generator [\#56](https://github.com/bensheldon/good_job/pull/56) ([thedanbob](https://github.com/thedanbob))
@@ -182,6 +203,10 @@
 
 [Full Changelog](https://github.com/bensheldon/good_job/compare/v0.8.2...v0.9.0)
 
+**Fixed bugs:**
+
+- Fix counting of available execution threads [\#58](https://github.com/bensheldon/good_job/pull/58) ([bensheldon](https://github.com/bensheldon))
+
 **Merged pull requests:**
 
 - Allow preservation of finished job records [\#46](https://github.com/bensheldon/good_job/pull/46) ([bensheldon](https://github.com/bensheldon))
@@ -262,6 +287,7 @@
 
 - Improve ActiveRecord usage for advisory locking [\#24](https://github.com/bensheldon/good_job/pull/24) ([bensheldon](https://github.com/bensheldon))
 - Remove support for Rails 5.1 [\#23](https://github.com/bensheldon/good_job/pull/23) ([bensheldon](https://github.com/bensheldon))
+- Clean up Gemspec [\#15](https://github.com/bensheldon/good_job/pull/15) ([bensheldon](https://github.com/bensheldon))
 
 ## [v0.3.0](https://github.com/bensheldon/good_job/tree/v0.3.0) (2020-03-22)
 
@@ -289,7 +315,6 @@
 
 **Merged pull requests:**
 
-- Clean up Gemspec [\#15](https://github.com/bensheldon/good_job/pull/15) ([bensheldon](https://github.com/bensheldon))
 - Set up Rubocop [\#14](https://github.com/bensheldon/good_job/pull/14) ([bensheldon](https://github.com/bensheldon))
 - Add pg gem as explicit dependency [\#13](https://github.com/bensheldon/good_job/pull/13) ([bensheldon](https://github.com/bensheldon))
 - Bump nokogiri from 1.10.7 to 1.10.9 [\#12](https://github.com/bensheldon/good_job/pull/12) ([dependabot[bot]](https://github.com/apps/dependabot))

data/README.md

@@ -4,210 +4,281 @@ GoodJob is a multithreaded, Postgres-based, ActiveJob backend for Ruby on Rails.
 
 **Inspired by [Delayed::Job](https://github.com/collectiveidea/delayed_job) and [Que](https://github.com/que-rb/que), GoodJob is designed for maximum compatibility with Ruby on Rails, ActiveJob, and Postgres to be simple and performant for most workloads.**
 
-- **Designed for ActiveJob.** Complete support for [async, queues, delays, priorities, timeouts, and retries](https://edgeguides.rubyonrails.org/active_job_basics.html) with near-zero configuration. 
-- **Built for Rails.** Fully adopts Ruby on Rails [threading and code execution guidelines](https://guides.rubyonrails.org/threading_and_code_execution.html) with [Concurrent::Ruby](https://github.com/ruby-concurrency/concurrent-ruby). 
+- **Designed for ActiveJob.** Complete support for [async, queues, delays, priorities, timeouts, and retries](https://edgeguides.rubyonrails.org/active_job_basics.html) with near-zero configuration.
+- **Built for Rails.** Fully adopts Ruby on Rails [threading and code execution guidelines](https://guides.rubyonrails.org/threading_and_code_execution.html) with [Concurrent::Ruby](https://github.com/ruby-concurrency/concurrent-ruby).
 - **Backed by Postgres.** Relies upon Postgres integrity, session-level Advisory Locks to provide run-once safety and stay within the limits of `schema.rb`, and LISTEN/NOTIFY to reduce queuing latency.
 - **For most workloads.** Targets full-stack teams, economy-minded solo developers, and applications that enqueue less than 1-million jobs/day.
 
 For more of the story of GoodJob, read the [introductory blog post](https://island94.org/2020/07/introducing-goodjob-1-0).
 
-<details>
+<details markdown="1">
 <summary><strong>📊 Comparison of GoodJob with other job queue backends (click to expand)</strong></summary>
 
 |                 | Queues, priority, retries | Database                              | Concurrency       | Reliability/Integrity  | Latency                  |
 |-----------------|---------------------------|---------------------------------------|-------------------|------------------------|--------------------------|
 | **GoodJob**     | ✅ Yes                     | ✅ Postgres                            | ✅ Multithreaded   | ✅ ACID, Advisory Locks | ✅ Postgres LISTEN/NOTIFY |
-| **Que**         | ✅ Yes                     | 🟨 Postgres, requires  `structure.sql` | ✅ Multithreaded   | ✅ ACID, Advisory Locks | ✅ Postgres LISTEN/NOTIFY |
-| **Delayed Job** | ✅ Yes                     | ✅ Postgres                            | 🟥 Single-threaded | ✅ ACID, record-based   | 🟨 Polling                |
-| **Sidekiq**     | ✅ Yes                     | 🟥 Redis                               | ✅ Multithreaded   | 🟥 Crashes lose jobs    | ✅ Redis BRPOP            |
-| **Sidekiq Pro** | ✅ Yes                     | 🟥 Redis                               | ✅ Multithreaded   | ✅ Redis RPOPLPUSH      | ✅ Redis RPOPLPUSH        |
+| **Que**         | ✅ Yes                     | 🔶️ Postgres, requires  `structure.sql` | ✅ Multithreaded   | ✅ ACID, Advisory Locks | ✅ Postgres LISTEN/NOTIFY |
+| **Delayed Job** | ✅ Yes                     | ✅ Postgres                            | 🔴 Single-threaded | ✅ ACID, record-based   | 🔶 Polling                |
+| **Sidekiq**     | ✅ Yes                     | 🔴 Redis                               | ✅ Multithreaded   | 🔴 Crashes lose jobs    | ✅ Redis BRPOP            |
+| **Sidekiq Pro** | ✅ Yes                     | 🔴 Redis                               | ✅ Multithreaded   | ✅ Redis RPOPLPUSH      | ✅ Redis RPOPLPUSH        |
 
 </details>
 
-## Installation
+## Table of contents
+
+- [Set up](#set-up)
+- [Configuration](#configuration)
+    - [Command-line options](#command-line-options)
+        - [`good_job start`](#good_job-start)
+        - [`good_job cleanup_preserved_jobs`](#good_job-cleanup_preserved_jobs)
+    - [Adapter options](#adapter-options)
+    - [Global options](#global-options)
+- [Going deeper](#going-deeper)
+    - [Exceptions, retries, and reliability](#exceptions-retries-and-reliability)
+        - [Exceptions](#exceptions)
+        - [Retries](#retries)
+        - [ActionMailer retries](#actionmailer-retries)
+    - [Timeouts](#timeouts)
+    - [Optimize queues, threads, and processes](#optimize-queues-threads-and-processes)
+    - [Database connections](#database-connections)
+    - [Executing jobs async / in-process](#executing-jobs-async--in-process)
+    - [Migrating to GoodJob from a different ActiveJob backend](#migrating-to-goodjob-from-a-different-activejob-backend)
+    - [Monitoring and preserving worked jobs](#monitoring-and-preserving-worked-jobs)
+- [Contributing](#contributing)
+    - [Gem development](#gem-development)
+    - [Releasing](#releasing)
+- [License](#license)
+
+## Set up
+
+1. Add `good_job` to your application's Gemfile:
 
-Add this line to your application's Gemfile:
+    ```ruby
+    gem 'good_job'
+    ```
 
-```ruby
-gem 'good_job'
-```
+1. Install the gem:
 
-And then execute:
-```bash
-$ bundle install
-```
+    ```bash
+    $ bundle install
+    ```
 
-## Usage
+1. Run the GoodJob install generator. This will generate a database migration to create a table for GoodJob's job records:
 
-1. Create a database migration:
-    
-   ```bash
+    ```bash
     $ bin/rails g good_job:install
     ```
 
     Run the migration:
-    
+
     ```bash
     $ bin/rails db:migrate
     ```
-    
+
 1. Configure the ActiveJob adapter:
-    
-   ```ruby
+
+    ```ruby
     # config/application.rb
     config.active_job.queue_adapter = :good_job
     ```
-    
-    By default, using `:good_job` is equivalent to manually configuring the adapter:
-    
+
+1. Inside of your application, queue your job 🎉:
+
     ```ruby
-    # config/environments/development.rb
-    config.active_job.queue_adapter = GoodJob::Adapter.new(execution_mode: :inline)
-   
-    # config/environments/test.rb
-    config.active_job.queue_adapter = GoodJob::Adapter.new(execution_mode: :inline)
-   
-    # config/environments/production.rb
-    config.active_job.queue_adapter = GoodJob::Adapter.new(execution_mode: :external)
+    YourJob.perform_later
     ```
 
-1. Queue your job 🎉: 
-    
+    GoodJob supports all ActiveJob features:
+
     ```ruby
     YourJob.set(queue: :some_queue, wait: 5.minutes, priority: 10).perform_later
     ```
 
-1. In production, the scheduler is designed to run in its own process:
-    
-    ```bash
-    $ bundle exec good_job
-    ```
-   
-   Configuration options available with `help`:
+1. In development, GoodJob executes jobs immediately. In production, GoodJob provides different options:
 
-    ```bash
-    $ bundle exec good_job help start
-   
-    Usage:
-      good_job start
-    
-    Options:
-      [--max-threads=N]                                          # Maximum number of threads to use for working jobs (default: ActiveRecord::Base.connection_pool.size)
-      [--queues=queue1,queue2(;queue3,queue4:5;-queue1,queue2)]  # Queues to work from. Separate multiple queues with commas; exclude queues with a leading minus; separate isolated execution pools with semicolons and threads with colons (default: *)
-      [--poll-interval=N]                                        # Interval between polls for available jobs in seconds (default: 1)    
-    
-    Start job worker
-    ```
+    - By default, GoodJob separates job enqueuing from job execution so that jobs can be scaled independently of the web server.  Use the GoodJob command-line tool to execute jobs:
 
-1. Optimize execution to reduce congestion and execution latency. 
+        ```bash
+        $ bundle exec good_job start
+        ```
 
-    By default, GoodJob creates a single thread execution pool that will execute jobs from any queue. Depending on your application's workload, job types, and service level objectives, you may wish to optimize execution resources; for example, providing dedicated execution resources for transactional emails so they are not delayed by long-running batch jobs. Some options:
+        Ideally the command-line tool should be run on a separate machine or container from the web process. For example, on Heroku:
 
-    - Multiple execution pools within a single process:
-        
-        ```bash
-        $ bundle exec good_job --queues=transactional_messages:2;batch_processing:1;-transactional_messages,batch_processing:2;* --max-threads=5
+        ```Procfile
+        web: rails server
+        worker: bundle exec good_job start
         ```
-      
-        This configuration will result in a single process with 4 isolated thread execution pools. Isolated execution pools are separated with a semicolon (`;`) and queue names and thread counts with a colon (`:`)
-        
-        - `transactional_messages:2`: execute jobs enqueued on `transactional_messages` with up to 2 threads.
-        - `batch_processing:1` execute jobs enqueued on `batch_processing` with a single thread.
-        - `-transactional_messages,batch_processing`: execute jobs enqueued on _any_ queue _excluding_ `transactional_messages` or `batch_processing` with up to 2 threads.
-        - `*`: execute jobs on any queue on up to 5 threads, as configured by `--max-threads=5`
-        
-        For moderate workloads, multiple isolated thread execution pools offers a good balance between congestion management and economy. 
-        
-        Configuration can be injected by environment variables too:
-        
-        ```bash
-        $ GOOD_JOB_QUEUES="transactional_messages:2;batch_processing:1;-transactional_messages,batch_processing:2;*" GOOD_JOB_MAX_THREADS=5 bundle exec good_job
+
+        The command-line tool supports a variety of options, see the reference below for command-line configuration.
+
+    - GoodJob can also be configured to execute jobs within the web server process to save on resources. This is useful for low-workloads when economy is paramount.
+
         ```
-        
-    - Multiple processes; for example, on Heroku:
-    
-        ```procfile
-        # Procfile
-        
-        # Separate dyno types
-        worker: bundle exec good_job --max-threads=5
-        transactional_worker: bundle exec good_job --queues=transactional_messages --max-threads=2
-        batch_worker: bundle exec good_job --queues=batch_processing --max-threads=1
-      
-        # Combined multi-process dyno
-        combined_worker: bundle exec good_job --max-threads=5 & bundle exec good_job --queues=transactional_messages --max-threads=2 & bundle exec good_job --queues=batch_processing --max-threads=1 & wait -n
+        $ GOOD_JOB_EXECUTION_MODE=async rails server
         ```
-      
-      Running multiple processes can optimize for CPU performance at the expense of greater memory and system resource usage.
 
-    _Keep in mind, queue operations and management is an advanced discipline. This stuff is complex, especially for heavy workloads and unique processing requirements. Good job 👍_
+        Additional configuration is likely necessary, see the reference below for async configuration.
 
-### Error handling, retries, and reliability
+## Configuration
 
-GoodJob guarantees that a completely-performed job will run once and only once. GoodJob fully supports ActiveJob's built-in functionality for error handling, retries and timeouts. Writing reliable, transactional, and idempotent `ActiveJob#perform` methods is outside the scope of GoodJob.
+### Command-line options
 
-#### Error handling
+There several top-level commands available through the `good_job` command-line tool.
 
-By default, if a job raises an error while it is being performed, _and it bubbles up to the GoodJob backend_, GoodJob will be immediately re-perform the job until it finishes successfully.
+Configuration options are available with `help`.
 
-- `Exception`-type errors, such as a SIGINT, will always cause a job to be re-performed.
-- `StandardError`-type errors, by default, will cause a job to be re-performed, though this is configurable:
-   
-    ```ruby
-    # config/initializers/good_job.rb
-    GoodJob.reperform_jobs_on_standard_error = true # => default
-    ```
+#### `good_job start`
+
+`good_job start` executes queued jobs.
+
+```bash
+$ bundle exec good_job help start
+
+Usage:
+  good_job start
+
+Options:
+  [--max-threads=COUNT]      # Maximum number of threads to use for working jobs. (env var: GOOD_JOB_MAX_THREADS, default: 5)
+  [--queues=QUEUE_LIST]      # Queues to work from. (env var: GOOD_JOB_QUEUES, default: *)
+  [--poll-interval=SECONDS]  # Interval between polls for available jobs in seconds (env var: GOOD_JOB_POLL_INTERVAL, default: 1)
+
+Executes queued jobs.
+
+All options can be configured with environment variables.
+See option descriptions for the matching environment variable name.
+
+== Configuring queues
+Separate multiple queues with commas; exclude queues with a leading minus;
+separate isolated execution pools with semicolons and threads with colons.
+```
+
+#### `good_job cleanup_preserved_jobs`
+
+`good_job cleanup_preserved_jobs` deletes preserved job records. See [`GoodJob.preserve_job_records` for when this command is useful.
+
+```bash
+$ bundle exec good_job help cleanup_preserved_jobs
+
+Usage:
+  good_job cleanup_preserved_jobs
+
+Options:
+  [--before-seconds-ago=SECONDS] # Delete records finished more than this many seconds ago (env var:  GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO, default: 86400)
+
+Deletes preserved job records.
+
+By default, GoodJob deletes job records when the job is performed and this
+command is not necessary.
+
+However, when `GoodJob.preserve_job_records = true`, the jobs will be
+preserved in the database. This is useful when wanting to analyze or
+inspect job performance.
+
+If you are preserving job records this way, use this command regularly
+to delete old records and preserve space in your database.
+```
+
+### Adapter options
+
+To use GoodJob, you can set `config.active_job.queue_adapter` to a `:good_job` or to an instance of `GoodJob::Adapter`, which you can configure with several options:
+
+- `execution_mode` (symbol) specifies how and where jobs should be executed. You can also set this with the environment variable `GOOD_JOB_EXECUTION_MODE`. It can be any one of:
+    - `:inline` executes jobs immediately in whatever process queued them (usually the web server process). This should only be used in test and development environments.
+    - `:external` causes the adapter to equeue jobs, but not execute them. When using this option (the default for production environments), you’ll need to use the command-line tool to actually execute your jobs.
+    - `:async` causes the adapter to execute you jobs in separate threads in whatever process queued them (usually the web process). This is akin to running the command-line tool’s code inside your web server. It can be more economical for small workloads (you don’t need a separate machine or environment for running your jobs), but if your web server is under heavy load or your jobs require a lot of resources, you should choose `:external` instead.
+- `max_threads` (integer) sets the maximum number of threads to use when `execution_mode` is set to `:async`. You can also set this with the environment variable `GOOD_JOB_MAX_THREADS`.
+- `queues` (string) determines which queues to execute jobs from when `execution_mode` is set to `:async`. See the description of `good_job start` for more details on the format of this string. You can also set this with the environment variable `GOOD_JOB_QUEUES`.
+- `poll_interval` (integer) sets the number of seconds between polls for jobs when `execution_mode` is set to `:async`. You can also set this with the environment variable `GOOD_JOB_POLL_INTERVAL`.
+
+Using the symbol instead of explicitly configuring the options above (i.e. setting `config.active_job.queue_adapter = :good_job`) is equivalent to:
+
+```ruby
+# config/environments/development.rb
+config.active_job.queue_adapter = GoodJob::Adapter.new(execution_mode: :inline)
+
+# config/environments/test.rb
+config.active_job.queue_adapter = GoodJob::Adapter.new(execution_mode: :inline)
+
+# config/environments/production.rb
+config.active_job.queue_adapter = GoodJob::Adapter.new(execution_mode: :external)
+```
+
+### Global options
+
+Good Job’s general behavior can also be configured via several attributes directly on the `GoodJob` module:
+
+- **`GoodJob.logger`** ([Rails Logger](https://api.rubyonrails.org/classes/ActiveSupport/Logger.html)) lets you set a custom logger for GoodJob. It should be an instance of a Rails `Logger`.
+- **`GoodJob.preserve_job_records`** (boolean) keeps job records in your database even after jobs are completed. (Default: `false`)
+- **`GoodJob.reperform_jobs_on_standard_error`** (boolean) causes jobs to be re-queued and retried if they raise an instance of `StandardError`. Instances of `Exception`, like SIGINT, will *always* be retried, regardless of this attribute’s value. (Default: `true`)
+- **`GoodJob.on_thread_error`** (proc, lambda, or callable) will be called when a job raises an error. It can be useful for logging errors to bug tracking services, like Sentry or Airbrake.
 
-To report errors that _do_ bubble up to the GoodJob backend, assign a callable to `GoodJob.on_thread_error`. For example:
+You’ll generally want to configure these in `config/initializers/good_job.rb`, like so:
 
 ```ruby
 # config/initializers/good_job.rb
+GoodJob.preserve_job_records = true
+GoodJob.reperform_jobs_on_standard_error = false
+GoodJob.on_thread_error = -> (exception) { Raven.capture_exception(exception) }
+```
 
-# With Sentry (or Bugsnag, Airbrake, Honeybadger, etc.)
+## Going deeper
+
+### Exceptions, retries, and reliability
+
+GoodJob guarantees that a completely-performed job will run once and only once. GoodJob fully supports ActiveJob's built-in functionality for error handling, retries and timeouts.
+
+#### Exceptions
+
+ActiveJob provides [tools for rescuing and retrying exceptions](https://guides.rubyonrails.org/active_job_basics.html#exceptions), including `retry_on`, `discard_on`, `rescue_from` that will rescue exceptions before they get to GoodJob.
+
+If errors do reach GoodJob, you can assign a callable to `GoodJob.on_thread_error` to be notified. For example, to log errors to an exception monitoring service like Sentry (or Bugsnag, Airbrake, Honeybadger, etc.):
+
+```ruby
+# config/initializers/good_job.rb
 GoodJob.on_thread_error = -> (exception) { Raven.capture_exception(exception) }
 ```
 
-### Retrying jobs
+#### Retries
 
-ActiveJob can be configured to retry an infinite number of times, with an exponential backoff. Using ActiveJob's `retry_on` will ensure that errors do not bubble up to the GoodJob backend:
+By default, GoodJob will automatically and immediately retry a job when an exception is raised to GoodJob.
+
+However, ActiveJob can be configured to retry an infinite number of times, with an exponential backoff. Using ActiveJob's `retry_on` prevents exceptions from reaching GoodJob:
 
 ```ruby
-class ApplicationJob < ActiveJob::Base  
+class ApplicationJob < ActiveJob::Base
   retry_on StandardError, wait: :exponentially_longer, attempts: Float::INFINITY
   # ...
 end
 ```
 
-When specifying a limited number of retries, care must be taken to ensure that an error does not bubble up to the GoodJob backend because that will result in the job being re-performed:
+When using `retry_on` with _a limited number of retries_, the final exception will not be rescued and will raise to GoodJob. GoodJob can be configured to discard un-handled exceptions instead of retrying them:
 
 ```ruby
-class ApplicationJob < ActiveJob::Base  
+# config/initializers/good_job.rb
+GoodJob.reperform_jobs_on_standard_error = false
+```
+
+Alternatively, pass a block to `retry_on` to handle the final exception instead of raising it to GoodJob:
+
+```ruby
+class ApplicationJob < ActiveJob::Base
   retry_on StandardError, attempts: 5 do |_job, _exception|
-    # Log error, etc.
-    # You must implement this block, otherwise, 
-    #   Active Job will re-raise the error.
-    # Do not re-raise the error, otherwise 
-    #   GoodJob will immediately re-perform the job. 
+    # Log error, do nothing, etc.
   end
   # ...
 end
 ```
 
-GoodJob can be configured to allow omitting `retry_on`'s block argument and implicitly discard un-handled errors:
+When using `retry_on` with an infinite number of retries, exceptions will never be raised to GoodJob, which means `GoodJob.on_thread_error` will never be called. To report log or report exceptions to an exception monitoring service (e.g. Sentry, Bugsnag, Airbrake, Honeybadger, etc), create an explicit exception wrapper. For example:
 
 ```ruby
-# config/initializers/good_job.rb
-
-# Do NOT re-perform a job if a StandardError bubbles up to the GoodJob backend
-GoodJob.reperform_jobs_on_standard_error = false 
-```
+class ApplicationJob < ActiveJob::Base
+  retry_on StandardError, wait: :exponentially_longer, attempts: Float::INFINITY
 
-When using an exception monitoring service (e.g. Sentry, Bugsnag, Airbrake, Honeybadger, etc), the use of `rescue_on` may be incompatible with their ActiveJob integration. It's safest to explicitly wrap jobs with an exception reporter. For example:
+  retry_on SpecialError, attempts: 5 do |_job, exception|
+    Raven.capture_exception(exception)
+  end
 
-```ruby
-class ApplicationJob < ActiveJob::Base  
-  retry_on StandardError, wait: :exponentially_longer, attempts: Float::INFINITY
-  
   around_perform do |_job, block|
     block.call
   rescue StandardError => e
@@ -218,12 +289,11 @@ class ApplicationJob < ActiveJob::Base
 end
 ```
 
-
-ActiveJob's `discard_on` functionality is supported too.
-
 #### ActionMailer retries
 
-Using a Mailer's `#deliver_later` will enqueue an instance of `ActionMailer::DeliveryJob` which inherits from `ActiveJob::Base` rather than your applications `ApplicationJob`. You can use an initializer to configure retries on `ActionMailer::DeliveryJob`:
+Any configuration in `ApplicationJob` will have to be duplicated on `ActionMailer::DeliveryJob` because ActionMailer uses a custom class, `ActionMailer::DeliveryJob`, which inherits from `ActiveJob::Base`,  rather than your applications `ApplicationJob`.
+
+You can use an initializer to configure `ActionMailer::DeliveryJob`, for example:
 
 ```ruby
 # config/initializers/good_job.rb
@@ -238,14 +308,14 @@ rescue StandardError => e
 end
 ```
 
-#### Timeouts
+### Timeouts
 
 Job timeouts can be configured with an `around_perform`:
 
 ```ruby
-class ApplicationJob < ActiveJob::Base  
+class ApplicationJob < ActiveJob::Base
   JobTimeoutError = Class.new(StandardError)
-  
+
   around_perform do |_job, block|
     # Timeout jobs after 10 minutes
     Timeout.timeout(10.minutes, JobTimeoutError) do
@@ -255,20 +325,61 @@ class ApplicationJob < ActiveJob::Base
 end
 ```
 
-### Configuring job execution threads
-    
-GoodJob executes enqueued jobs using threads. There is a lot than can be said about [multithreaded behavior in Ruby on Rails](https://guides.rubyonrails.org/threading_and_code_execution.html), but briefly:
+### Optimize queues, threads, and processes
+
+By default, GoodJob creates a single thread execution pool that will execute jobs from any queue. Depending on your application's workload, job types, and service level objectives, you may wish to optimize execution resources. For example, providing dedicated execution resources for transactional emails so they are not delayed by long-running batch jobs. Some options:
+
+- Multiple execution pools within a single process:
 
-- Each GoodJob execution thread requires its own database connection, which are automatically checked out from Rails’s connection pool. _Allowing GoodJob to schedule more threads than are available in the database connection pool can lead to timeouts and is not recommended._ 
-- The maximum number of GoodJob threads can be configured, in decreasing precedence:
-    1. `$ bundle exec good_job --max_threads 4`
-    2. `$ GOOD_JOB_MAX_THREADS=4 bundle exec good_job`
-    3. `$ RAILS_MAX_THREADS=4 bundle exec good_job`
-    4. Implicitly via Rails's database connection pool size (`ActiveRecord::Base.connection_pool.size`)
+    ```bash
+    $ bundle exec good_job --queues=transactional_messages:2;batch_processing:1;-transactional_messages,batch_processing:2;* --max-threads=5
+    ```
+
+    This configuration will result in a single process with 4 isolated thread execution pools. Isolated execution pools are separated with a semicolon (`;`) and queue names and thread counts with a colon (`:`)
+
+    - `transactional_messages:2`: execute jobs enqueued on `transactional_messages` with up to 2 threads.
+    - `batch_processing:1` execute jobs enqueued on `batch_processing` with a single thread.
+    - `-transactional_messages,batch_processing`: execute jobs enqueued on _any_ queue _excluding_ `transactional_messages` or `batch_processing` with up to 2 threads.
+    - `*`: execute jobs on any queue on up to 5 threads, as configured by `--max-threads=5`
+
+    For moderate workloads, multiple isolated thread execution pools offers a good balance between congestion management and economy.
+
+    Configuration can be injected by environment variables too:
+
+    ```bash
+    $ GOOD_JOB_QUEUES="transactional_messages:2;batch_processing:1;-transactional_messages,batch_processing:2;*" GOOD_JOB_MAX_THREADS=5 bundle exec good_job
+    ```
+
+- Multiple processes; for example, on Heroku:
+
+    ```procfile
+    # Procfile
+
+    # Separate dyno types
+    worker: bundle exec good_job --max-threads=5
+    transactional_worker: bundle exec good_job --queues=transactional_messages --max-threads=2
+    batch_worker: bundle exec good_job --queues=batch_processing --max-threads=1
+
+    # Combined multi-process dyno
+    combined_worker: bundle exec good_job --max-threads=5 & bundle exec good_job --queues=transactional_messages --max-threads=2 & bundle exec good_job --queues=batch_processing --max-threads=1 & wait -n
+    ```
+
+    Running multiple processes can optimize for CPU performance at the expense of greater memory and system resource usage.
+
+Keep in mind, queue operations and management is an advanced discipline. This stuff is complex, especially for heavy workloads and unique processing requirements. Good job 👍
+
+### Database connections
+
+Each GoodJob execution thread requires its own database connection that is automatically checked out from Rails’s connection pool. _Allowing GoodJob to create more threads than available database connections can lead to timeouts and is not recommended._ For example:
+
+```yaml
+# config/database.yml
+pool: <%= [ENV.fetch("RAILS_MAX_THREADS", 5).to_i, ENV.fetch("GOOD_JOB_MAX_THREADS", 4).to_i].max %>
+```
 
 ### Executing jobs async / in-process
 
-GoodJob is able to run "async" in the same process as the webserver (e.g. `bin/rail s`). GoodJob's async execution mode offers benefits of economy by not requiring a separate job worker process, but with the tradeoff of increased complexity. Async mode can be configured in two ways:
+GoodJob can execute jobs "async" in the same process as the webserver (e.g. `bin/rail s`). GoodJob's async execution mode offers benefits of economy by not requiring a separate job worker process, but with the tradeoff of increased complexity. Async mode can be configured in two ways:
 
 - Directly configure the ActiveJob adapter:
 
@@ -276,12 +387,13 @@ GoodJob is able to run "async" in the same process as the webserver (e.g. `bin/r
     # config/environments/production.rb
     config.active_job.queue_adapter = GoodJob::Adapter.new(execution_mode: :async, max_threads: 4, poll_interval: 30)
     ```
+
 - Or, when using `...queue_adapter = :good_job`, via environment variables:
 
     ```bash
     $ GOOD_JOB_EXECUTION_MODE=async GOOD_JOB_MAX_THREADS=4 GOOD_JOB_POLL_INTERVAL=30 bin/rails server
     ```
- 
+
 Depending on your application configuration, you may need to take additional steps:
 
 - Ensure that you have enough database connections for both web and job execution threads:
@@ -295,27 +407,27 @@ Depending on your application configuration, you may need to take additional ste
 
     ```ruby
     # config/puma.rb
-  
+
     before_fork do
       GoodJob.shutdown
     end
-    
+
     on_worker_boot do
       GoodJob.restart
     end
-    
+
     on_worker_shutdown do
       GoodJob.shutdown
     end
-  
+
     MAIN_PID = Process.pid
     at_exit do
       GoodJob.shutdown if Process.pid == MAIN_PID
     end
     ```
-  
+
   GoodJob is compatible with Puma's `preload_app!` method.
-  
+
 ### Migrating to GoodJob from a different ActiveJob backend
 
 If your application is already using an ActiveJob backend, you will need to install GoodJob to enqueue and perform newly created jobs _and_ finish performing pre-existing jobs on the previous backend.
@@ -331,7 +443,7 @@ If your application is already using an ActiveJob backend, you will need to inst
     ```
 
 1. Continue running executors for both backends. For example, on Heroku it's possible to run [two processes](https://help.heroku.com/CTFS2TJK/how-do-i-run-multiple-processes-on-a-dyno) within the same dyno:
-    
+
    ```procfile
     # Procfile
     # ...
@@ -344,7 +456,7 @@ If your application is already using an ActiveJob backend, you will need to inst
 
 GoodJob is fully instrumented with [`ActiveSupport::Notifications`](https://edgeguides.rubyonrails.org/active_support_instrumentation.html#introduction-to-instrumentation).
 
-By default, GoodJob will delete job records after they are run, regardless of whether they succeed or not (raising a kind of `StandardError`), unless they are interrupted (raising a kind of `Exception`). 
+By default, GoodJob will delete job records after they are run, regardless of whether they succeed or not (raising a kind of `StandardError`), unless they are interrupted (raising a kind of `Exception`).
 
 To preserve job records for later inspection, set an initializer:
 
@@ -356,7 +468,7 @@ GoodJob.preserve_job_records = true
 It is also necessary to delete these preserved jobs from the database after a certain time period:
 
 - For example, in a Rake task:
-  
+
     ```ruby
     GoodJob::Job.finished(1.day.ago).delete_all
     ```
@@ -426,7 +538,7 @@ $ gem signin
 # Update version number, changelog, and create git commit:
 $ bundle exec rake release[minor] # major,minor,patch
 
-# ..and follow subsequent directions. 
+# ..and follow subsequent directions.
 ```
 
 ## License

data/lib/good_job.rb

@@ -8,7 +8,6 @@ require 'good_job/job'
 require 'good_job/scheduler'
 require 'good_job/multi_scheduler'
 require 'good_job/adapter'
-require 'good_job/pg_locks'
 require 'good_job/performer'
 require 'good_job/current_execution'
 require 'good_job/notifier'

data/lib/good_job/cli.rb

@@ -4,17 +4,29 @@ module GoodJob
   class CLI < Thor
     RAILS_ENVIRONMENT_RB = File.expand_path("config/environment.rb")
 
-    desc :start, "Start job worker"
+    desc :start, <<~DESCRIPTION
+      Executes queued jobs.
+
+      All options can be configured with environment variables. 
+      See option descriptions for the matching environment variable name.
+
+      == Configuring queues
+      Separate multiple queues with commas; exclude queues with a leading minus; 
+      separate isolated execution pools with semicolons and threads with colons.
+
+    DESCRIPTION
     method_option :max_threads,
                   type: :numeric,
-                  desc: "Maximum number of threads to use for working jobs (default: ActiveRecord::Base.connection_pool.size)"
+                  banner: 'COUNT',
+                  desc: "Maximum number of threads to use for working jobs. (env var: GOOD_JOB_MAX_THREADS, default: 5)"
     method_option :queues,
                   type: :string,
-                  banner: "queue1,queue2(;queue3,queue4:5;-queue1,queue2)",
-                  desc: "Queues to work from. Separate multiple queues with commas; exclude queues with a leading minus; separate isolated execution pools with semicolons and threads with colons (default: *)"
+                  banner: "QUEUE_LIST",
+                  desc: "Queues to work from. (env var: GOOD_JOB_QUEUES, default: *)"
     method_option :poll_interval,
                   type: :numeric,
-                  desc: "Interval between polls for available jobs in seconds (default: 1)"
+                  banner: 'SECONDS',
+                  desc: "Interval between polls for available jobs in seconds (env var: GOOD_JOB_POLL_INTERVAL, default: 1)"
     def start
       set_up_application!
 
@@ -39,17 +51,35 @@ module GoodJob
 
     default_task :start
 
-    desc :cleanup_preserved_jobs, "Delete preserved job records"
+    desc :cleanup_preserved_jobs, <<~DESCRIPTION
+      Deletes preserved job records. 
+
+      By default, GoodJob deletes job records when the job is performed and this
+      command is not necessary.
+
+      However, when `GoodJob.preserve_job_records = true`, the jobs will be
+      preserved in the database. This is useful when wanting to analyze or
+      inspect job performance.
+
+      If you are preserving job records this way, use this command regularly
+      to delete old records and preserve space in your database.
+
+    DESCRIPTION
     method_option :before_seconds_ago,
                   type: :numeric,
-                  default: 24 * 60 * 60,
-                  desc: "Delete records finished more than this many seconds ago"
-
+                  banner: 'SECONDS',
+                  desc: "Delete records finished more than this many seconds ago (env var: GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO, default: 86400)"
     def cleanup_preserved_jobs
       set_up_application!
 
-      timestamp = Time.current - options[:before_seconds_ago]
-      ActiveSupport::Notifications.instrument("cleanup_preserved_jobs.good_job", { before_seconds_ago: options[:before_seconds_ago], timestamp: timestamp }) do |payload|
+      configuration = GoodJob::Configuration.new(options)
+
+      timestamp = Time.current - configuration.cleanup_preserved_jobs_before_seconds_ago
+
+      ActiveSupport::Notifications.instrument(
+        "cleanup_preserved_jobs.good_job",
+        { before_seconds_ago: configuration.cleanup_preserved_jobs_before_seconds_ago, timestamp: timestamp }
+      ) do |payload|
         deleted_records_count = GoodJob::Job.finished(timestamp).delete_all
 
         payload[:deleted_records_count] = deleted_records_count

data/lib/good_job/configuration.rb

@@ -51,5 +51,13 @@ module GoodJob
         1
       ).to_i
     end
+
+    def cleanup_preserved_jobs_before_seconds_ago
+      (
+        options[:before_seconds_ago] ||
+        env['GOOD_JOB_CLEANUP_PRESERVED_JOBS_BEFORE_SECONDS_AGO'] ||
+        24 * 60 * 60
+      ).to_i
+    end
   end
 end

data/lib/good_job/lockable.rb

@@ -25,8 +25,8 @@ module GoodJob
         join_sql = <<~SQL
           LEFT JOIN pg_locks ON pg_locks.locktype = 'advisory'
             AND pg_locks.objsubid = 1
-            AND pg_locks.classid = ('x'||substr(md5(:table_name || "#{table_name}"."#{primary_key}"::text), 1, 16))::bit(32)::int
-            AND pg_locks.objid = (('x'||substr(md5(:table_name || "#{table_name}"."#{primary_key}"::text), 1, 16))::bit(64) << 32)::bit(32)::int
+            AND pg_locks.classid = ('x'||substr(md5(:table_name || #{quoted_table_name}.#{quoted_primary_key}::text), 1, 16))::bit(32)::int
+            AND pg_locks.objid = (('x'||substr(md5(:table_name || #{quoted_table_name}.#{quoted_primary_key}::text), 1, 16))::bit(64) << 32)::bit(32)::int
         SQL
 
         joins(sanitize_sql_for_conditions([join_sql, { table_name: table_name }]))

data/lib/good_job/version.rb

@@ -1,3 +1,3 @@
 module GoodJob
-  VERSION = '1.2.3'.freeze
+  VERSION = '1.2.4'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: good_job
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Ben Sheldon
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -178,6 +178,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  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: kramdown-parser-gfm
+  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: mdl
+  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: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -347,7 +389,6 @@ files:
 - lib/good_job/multi_scheduler.rb
 - lib/good_job/notifier.rb
 - lib/good_job/performer.rb
-- lib/good_job/pg_locks.rb
 - lib/good_job/railtie.rb
 - lib/good_job/scheduler.rb
 - lib/good_job/version.rb

data/lib/good_job/pg_locks.rb

@@ -1,21 +0,0 @@
-module GoodJob
-  class PgLocks < ActiveRecord::Base
-    self.table_name = 'pg_locks'.freeze
-
-    # https://www.postgresql.org/docs/9.6/view-pg-locks.html
-    # Advisory locks can be acquired on keys consisting of either a single bigint value or two integer values.
-    # A bigint key is displayed with its high-order half in the classid column, its low-order half in the objid column, and objsubid equal to 1.
-    # The original bigint value can be reassembled with the expression (classid::bigint << 32) | objid::bigint.
-    # Integer keys are displayed with the first key in the classid column, the second key in the objid column, and objsubid equal to 2.
-    # The actual meaning of the keys is up to the user. Advisory locks are local to each database, so the database column is meaningful for an advisory lock.
-    def self.advisory_lock_details
-      connection.select <<~SQL
-        SELECT *
-        FROM pg_locks
-        WHERE
-          locktype = 'advisory' AND
-          objsubid = 1
-      SQL
-    end
-  end
-end