Added a chapter on how to prepare for production. #525
Conversation
README.md
Outdated
| The number of the database connections your setup needs is directly dependent | ||
| on the execution mode. A good way to estimate the size of the connections pool | ||
| per process running as `:external` execution mode is: | ||
|
|
||
| * 1 connection dedicated to the scheduler aka `LISTEN/NOTIFY` | ||
| * 1 connection per thread * `GOOD_JOB_MAX_THREADS` | ||
| * 1 connection per every extra thread if your application runs these as part | ||
| of a job | ||
| * 1 connection dedicated to the cron scheduler if you're running it | ||
| * 1 connection dedicated to the cron executor if you're running cron | ||
|
|
||
| If you're running the queue along with the Rails process, please adjust | ||
| the pool size taking into account the number of web server threads! | ||
|
|
||
| It is important to understand that the queue process won't crash if the | ||
| connections pool is exhausted, instead it will report an exception (eg. | ||
| `ActiveRecord::ConnectionTimeoutError`)! |
There was a problem hiding this comment.
I'd like this to be isolated inside of the section on database connection pool size.
Overall, I'm imagining the section you're proposing here is more of a checklist of items that explains why you should configure them for production, but the how and details lives in the section related to that specific feature.
There was a problem hiding this comment.
@bensheldon thanks for reviewing this, I followed your suggestions and moved it as the Database Connections sub-section.
As for the reasoning behind it, we basically were wrapping our heads around trying to compile a production-ready setup and still failed to grasp the whole connections usage part. It can be seen as a checklist, though to me, I just want to make sure our findings are documented, as I'll definitely be returning to them as I use good_jobs in more projects 😉
See #523 for more feedback.
Based on the feedback from #523 I tried to put together a chapter with best practices on how to prepare running GoodJob in production.
@bensheldon @reczy would appreciate you taking a look at this. Thank you!
Closes #523