Skip to content

Commit

Permalink
Add pricing details to Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
farski committed Oct 14, 2015
1 parent 7cee24f commit e0db74e
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

Based heavily on the concept of [`shoryuken-later`](https://github.com/joekhoobyar/shoryuken-later), `Shoryuken::Waiter` allows jobs to be scheduled greater that 15 minutes into the future when using [Shoryuken](https://github.com/phstc/shoryuken).

_**Notice:** Version 0.x is tightly coupled Rails and Shoryuken SQS queues. 1.x should add support for Shoryuken workers (currently only Active Job is supported), and more configurable DynamoDB tables. 0.0.x builds rely on Shoryuken changes that have not yet been merged into master._
_**Notice:** Version 0.x is tightly coupled Rails and Shoryuken SQS queues. 1.x should add support for Shoryuken workers (currently only Active Job is supported), and more configurable DynamoDB tables. 0.0.x builds rely on Shoryuken changes that have not yet been merged into master._

## Usage

Expand Down Expand Up @@ -51,6 +51,14 @@ Tables being used with `Shoryuken::Waiter` must be created with certain properti

Other properties of the table, such as the **provisioned capacity** will be application dependent.

#### Pricing

Specific [pricing details](https://aws.amazon.com/dynamodb/pricing/) for **DynamoDB** should be considered when determining the cost of using the service for `Shoryuken::Waiter` with your app. [AWS's Free Tier](https://aws.amazon.com/free/), which does not expire for **DynamoDB**, provides **25 Units** of read and write capacity and **25 GB** of storage for an account. In general this would be enough capacity to support several `Shoryuken::Waiter` tables at no cost for most applications.

Increasing the frequency of polling, scheduling many jobs that must be delayed, or having many jobs delayed for a very long time leading to a large on-disk footprint of the tables could lead to higher costs.

Be aware that the secondary index that is required for `Shoryuken::Waiter` counts against additional throughput capacity and storage costs.

## Internals

When a job is scheduled normally with `Shoryuken`, the message is sent to **SQS** with four properties `queue_url`, `message_body`, `delay_seconds`, and `message_attributes`.
Expand Down

0 comments on commit e0db74e

Please sign in to comment.