Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split everything left out of the README #1180

Merged
merged 15 commits into from
Nov 12, 2024

Conversation

whatyouhide
Copy link
Contributor

Oooph, this is the final one! I’m pretty happy with this one, excited to hear your thoughts.

guides/operational_maintenance.md Show resolved Hide resolved
lib/oban/worker.ex Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Member

@sorenone sorenone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! The slimmed down Readme and quick Getting Started has been much improved. Please double-check the suggestions and formatting to ensure I haven't thwarted your efforts. ;)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
guides/configuration.md Outdated Show resolved Hide resolved
guides/job_uniqueness.md Outdated Show resolved Hide resolved
lib/oban/plugins/pruner.ex Outdated Show resolved Hide resolved
lib/oban/worker.ex Outdated Show resolved Hide resolved
lib/oban/worker.ex Outdated Show resolved Hide resolved
Comment on lines 304 to 320
### Caveats & Guidelines

Usually, scheduled job management operates in `global` mode and notifies queues
of available jobs via PubSub to minimize database load. However, when PubSub
isn't available, staging switches to a `local` mode where each queue polls
independently.

Local mode is less efficient and will only happen if you're running in an
environment where neither `Postgres` nor `PG` notifications work. That situation
should be rare and limited to the following conditions:

1. Running with a connection pooler, like [`pg_bouncer`][pg_bouncer],
in transaction mode.
2. Running without clustering, that is, without *distributed Erlang*.

If **both** of those criteria apply and PubSub notifications won't work, then
staging will switch to polling in `local` mode.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think there a better location for this section? Maybe a guide about distribution/pubsub/notifiers? You're in the head-space for it more than we are right now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we can split this out. The nice thing about splitting it out is that we'll have a home for this stuff (and a URL for it too).

whatyouhide and others added 14 commits November 12, 2024 18:18
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
Co-authored-by: Shannon Selbert <shannon@sorentwo.com>
@whatyouhide
Copy link
Contributor Author

@sorentwo second pass done ✅

mix.exs Outdated Show resolved Hide resolved
@sorenone sorenone merged commit 899c31c into oban-bg:main Nov 12, 2024
0 of 2 checks passed
@whatyouhide whatyouhide deleted the al/final-readme-split branch November 13, 2024 08:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants