Skip to content

Update sidekiq-cluster interval documentation

Jamie Reid requested to merge jrreid-doc-sidekiq-interval into master

What does this MR do?

The docs incorrectly stated that sidekiq[interval] controlled how often enqueued jobs were checked for. In actuality, this gitlab.rb option is passed to sidekiq-cluster -h to specify how often worker threads should be checked.

Per @tkuah and @marin this interval value represents the number of seconds between worker checks performed by sidekiq-cluster. It's passed to the sidekiq-cluster binary here https://gitlab.com/gitlab-org/gitlab/-/blob/cc39c13afd9f6dfee320dcfb49f6f523212ea52b/sidekiq_cluster/cli.rb#L206-208

sidekiq-cluster's help output states:

$ bin/sidekiq-cluster -h
cli.rb [QUEUE,QUEUE] [QUEUE] ... [OPTIONS]

    -i, --interval INT               The number of seconds to wait between worker checks

Author's checklist

If you are only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::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 like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure 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.
Edited by Marcia Ramos

Merge request reports