Routing rules can prevent mail from being sent
What does this MR do?
If Sidekiq routing rules have been incorrectly configured and the mailers
queue is missing from the configuration, all outgoing mail will not be sent.
This was not immediately apparent to me this was the problem as I had configured routing rules several weeks ago and forgot about it. I then wondered today why none of my outgoing mail was not being sent. It makes sense to me to add a mention of this on the SMTP troubleshooting page and link back to the routing rules page.
Even though we have an INFO
box in https://docs.gitlab.com/ee/administration/sidekiq/processing_specific_job_classes.html#routing-rules that mentions that you must add the mailers
queue to your configuration - I missed that
Mailer jobs cannot be routed by routing rules, and always go to the
mailers
queue. When using routing rules, ensure that at least one process is listening to themailers
queue. Typically this can be placed alongside thedefault
queue.
Related issues
Author's checklist
-
Consider taking the GitLab Technical Writing Fundamentals course -
Follow the: -
Ensure that the product tier badge is added to topic's h1
. -
Request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are only adding documentation, do not add any of the following labels:
~"feature"
~"frontend"
~"backend"
~"bug"
~"database"
These labels cause the MR to be added to code verification QA issues.
Review checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior
, say something likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure GDK
. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set.