Sha256: 9a0206601ce0070379bc8d956996f5c7f2c75648ddce9f0fcfde2e987e0fe29a

Contents?: true

Size: 1.57 KB

Versions: 25

Compression:

Stored size: 1.57 KB

Contents

Iteration comes with a special wrapper enumerator that allows you to throttle iterations based on external signal (e.g. database health).

Consider this example:

```ruby
class InactiveAccountDeleteJob < ActiveJob::Base
  include JobIteration::Iteration

  def build_enumerator(_params, cursor:)
    enumerator_builder.active_record_on_batches(
      Account.inactive,
      cursor: cursor
    )
  end

  def each_iteration(batch, _params)
    Account.where(id: batch.map(&:id)).delete_all
  end
end
```

For an app that keeps track of customer accounts, it's typical to purge old data that's no longer relevant for storage.

At the same time, if you've got a lot of DB writes to perform, this can cause extra load on the database and slow down other parts of your service.

You can change `build_enumerator` to wrap enumeration on DB rows into a throttle enumerator, which takes signal as a proc and enqueues the job for later in case the proc returned `true`.

```ruby
def build_enumerator(_params, cursor:)
  enumerator_builder.build_throttle_enumerator(
    enumerator_builder.active_record_on_batches(
      Account.inactive,
      cursor: cursor
    ),
    throttle_on: -> { DatabaseStatus.unhealthy? },
    backoff: 30.seconds
  )
end
```

Note that it's up to you to implement `DatabaseStatus.unhealthy?` that works for your database choice. At Shopify, a helper like `DatabaseStatus` checks the following MySQL metrics:

* Replication lag across all regions
* DB threads
* DB is available for writes (otherwise indicates a failover happening)
* [Semian](https://github.com/shopify/semian) open circuits

Version data entries

25 entries across 25 versions & 1 rubygems

Version Path
job-iteration-1.7.0 guides/throttling.md
job-iteration-1.6.0 guides/throttling.md
job-iteration-1.5.1 guides/throttling.md
job-iteration-1.5.0 guides/throttling.md
job-iteration-1.4.1 guides/throttling.md
job-iteration-1.4.0 guides/throttling.md
job-iteration-1.3.6 guides/throttling.md
job-iteration-1.3.5 guides/throttling.md
job-iteration-1.3.4 guides/throttling.md
job-iteration-1.3.3 guides/throttling.md
job-iteration-1.3.2 guides/throttling.md
job-iteration-1.3.1 guides/throttling.md
job-iteration-1.3.0 guides/throttling.md
job-iteration-1.2.0 guides/throttling.md
job-iteration-1.1.14 guides/throttling.md
job-iteration-1.1.13 guides/throttling.md
job-iteration-1.1.12 guides/throttling.md
job-iteration-1.1.11 guides/throttling.md
job-iteration-1.1.10 guides/throttling.md
job-iteration-1.1.9 guides/throttling.md