Skip to content

Change pending jobs command to print count

Harsh Chouraria requested to merge hchouraria-docs-improve-background-migrations-pending-command into master

What does this MR do?

The command added in !75388 (merged) and then subsequently updated in !78242 (merged) is attempting to print out an active record collection (with pending being an activerecord enum status match helper) that has not any usable printing inside it (only Ruby Object IDs are printed)

Since the goal of these commands is to check for any actual pending jobs continuing to exist even outside of the Sidekiq jobs queue the command could be updated to print the count of matching status records

Alternatively the following can be used to identify the actual pending classes and their arguments that have not yet completed:

gitlab-rails runner -e production 'puts Gitlab::Database::BackgroundMigrationJob.pending.map { |x| [x.class_name, x.arguments] }'

Related issues

Customer ticket: https://gitlab.zendesk.com/agent/tickets/261294

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 reviews above. Maintainer's review can occur before or after a technical writer review.
  • Ensure a release milestone is set.

Merge request reports