Indexing queue viewer

NEW FEATURE

Introduction

Indexing is a very large part of Git Integration for Jira app. This indexing feature displays various task entries, allowing you to easily view upcoming and ongoing tasks such as repository indexing and garbage collection.

The Indexing queue viewer displays detailed information such as:

• when was the indexing started
• when was the indexing finished
• how much time it took the indexing to complete
• ID of the task
• on which node the indexing was processed DATA CENTER

Highlights

Offering ease of use and scope of features, the Indexing queue viewer:

• provides users greater visibility into what’s happening with your repositories and system resources.

• shows detailed information about the tasks – which node it was processed on, start time, finish time, processing time, task id, and more (mentioned above).

• allows users to see which tasks are in the queue, find specific tasks by history, and filter tasks by specific parameters.

Access location

This feature can be accessed via the Jira dashboard menu Git ➜ Indexing queue.

Indexing queue dashboard

The dashboard displays the current number of processing tasks and tasks in the queue.

Click Clear queue to free up the current queue of all tasks with QUEUED status.

Take into consideration that this action…

• only removes tasks in QUEUED status.
• does not cancel tasks in INDEXING status.
• does not clear the CANCELED status. A task with CANCELED status will stay like that indefinitely until subsequent reindex.

To the right of the dashboard is the Settings view panel. which shows information related to the general settings for scheduled indexing, garbage collection, etc.

Click Edit to go directly to the General settings page.

Filters and search

Just below the dashboard are controls for view filters. This section allow users to control which information is displayed on the screen.

These includes:

• filter by status
• filter by trigger
• filter by type of operation
• filter by node
• filter by repository ID
• filter by task ID
• filter by parent task ID
• filter by name – case-sensitive:
  • For ‘repository: Name’ — this is a name comprising a group and a repository name.
  • For ‘integration: Name‘ — this is the name of the connected integration.

Filter: Status

Filter the task list by clicking on the Status dropdown and selecting a category:

• All – Displays the data for every Status category. This is the default selection for the Status filter.

• Queued — Displays tasks having QUEUED status. This indicates that the indexing tasks are still waiting in line to be processed or are still unfinished.

• Indexing — Displays tasks having INDEXING status. This indicates that the indexing task is already running.

• Indexed — Displays tasks having INDEXED status. This indicates that the indexing task has finished.

• Error — Displays tasks having ERROR status. This indicates that the indexing task has encountered an error. Go to … Actions ➜ View log to see the error(s).

• VERSION 4.23 Canceled — Displays tasks having CANCELED status. This indicates that the indexing task has been cancelled…

  • manually — triggered by a user action (admins)
  • forcefully — triggered because of an error
  • automatically — triggered because the repository/integration disabled

  For detailed information on canceling reindex, see Cancel indexing: Revision indexing.

Filter: Trigger

Filters the task list by clicking on the Trigger dropdown and selecting a category:

• All – Displays the data for every Trigger category.

• Manual — Displays tasks that was triggered manually. This includes user-triggered events such as:

  • reindex repositories/integrations/reindex all

  • reset all/reset repository

  • reindex triggered by bulk import

  • reindex triggered by Reindex REST API

  • reindex triggered by an update of repository

• Webhook — Displays tasks triggered by webhook. Indexing triggered by webhooks fall on this category. For related information, see Webhook indexing explainer.

• Scheduled — Displays tasks triggered by scheduled jobs. For more information, see Scheduler jobs.

• App activity — Displays reindex tasks triggered by:

  • a branch creation/deletion

  • a manipulation with pull request

  • a change of commit issue association

  • a repository update, e.g. by a change of main branch

• Initial indexing — Displays tasks triggered by initial indexing. Initial indexing is performed by the Git Integration for Jira app on the first successful connection of the git service integration.

Filter: Type of operation

Filters the view by clicking on the Type of operation dropdown and selecting a category:

• All –- Displays the data for every Type of operation category.

• Reindex –- Displays tasks related to indexing.

• Garbage Collection -– Displays tasks related to Garbage Collection.

• Remove repository –- Displays tasks related to removal of a repository.

Filter: Node

DATA CENTER

Filters the view by clicking on the Node dropdown and selecting a category:

• All –- Displays the data for every Node in the cluster.

• Node[1…] – Node[n] –- Displays tasks and data only for the specified node in the cluster.

Using search to filter specific items to view

To the right of the view filter options, users can use the search bar to query for specific tasks and the indexing list view will be updated accordingly. Note that filtering by name is case-sensitive.

Sorting

Sorting allows users to arrange tasks by categories such as status, trigger, and type of operation.

The default sort order applies the following rule:

1. INDEXING – first

2. QUEUED tasks (see details below):

   a. raised to the top manually

   b. reindex triggered manually:

   *   ![](/wp-content/uploads/actions-icon.png) Actions ➜ Reindex repositories/integrations or Reindex all
   
   *   ![](/wp-content/uploads/actions-icon.png) Actions ➜ Reset all/Reset repository
   
   *   via Bulk Import
   
   *   via Reindex REST API
   
   *   via an update from changes in the repository

   c. triggered by webhooks

   d. triggered by scheduled job

   e. Actions ➜ Remove repository/integration

   f. Garbage Collection tasks

3. FINISHED – last

Cancel indexing

VERSION 4.23+

This feature allows Jira administrators to interrupt the indexing process once it has been queued or has already started. It will suspend the indexing process and can be resumed with subsequent reindex later on.

As of GIJ v4.27.1+, the pull/merge request reindex can be manually cancelled via Indexing queue viewer.

For any selected queue task that is still processing or in progress, click on … (Actions) ➜ Cancel.

For a more detailed information about this feature, see Cancel indexing.

Viewing logs

The ‘indexing status’ is displayed in the indexing log dialog that appears during manual reindex. The View log information from the Indexing Queue Viewer is similar to the logs that can be viewed in the Manage integration screen.

For encountered errors when indexing, open the logs via Actions ➜ View log. Copy the message log and submit this to us thru [email protected] or via Support portal for analysis. For the above example error, there are several factors that caused this error – the Git service is down, no internet connection, the webhook has changed or the personal access token has expired.

Moving list items to top

Move the selected queue item to the top of the list (most recent). To do this click … (Action) ➜ Move to top. This will make it easy to monitor the selected item’s behavior such as indexing status and viewing its indexing process logs.

Indexing queue list

On the next indexing run, the finished tasks for some repository are removed from the queue. This is regardless of the reindex trigger whether scheduled, webhook or manual. The max age for old finished tasks is 1 hour (see below).

The indexing queue does not remove the task from the queue when any of the following conditions is true:

• this task is the last one of this type for this integration/repository

• this task is not older than 1 hour from now

For removed integrations/repositories., the pending queued tasks related to removal are deleted from the indexing queue list.

View indexing details

On the left of the first column, click the > symbol to expand the detailed view of the index task in the queue.

Finish time

In this column, the amount of time from when the task has finished indexing is shown.

Integration name

This column displays the name of the integrations where indexing tasks has been performed.

Repository name

This column displays the name of the repositories where indexing tasks has been performed. Also displayed is the organization (GitHub) or group (GitLab) name before the repository name indicating it’s under that org or group.

Type of operation

The type of operation states what kind of indexing was triggered:

• Reindex
• Webhook
• Scheduled
• Manual
• Garbage collection
• Remove

Delay

This column shows No delay for indexed items that were processed immediately after the previous one. Also displayed are the amount of time when the indexing has finished for the tasks.

Trigger

This column shows what kind of operation triggered the reindex for this task.

Status

This column shows the indexing status of the task in the list.

Refresh function

At the bottom-left portion of the indexing queue viewer, click the Refresh icon to refresh the queue list view.

Pagination

At the bottom-right portion of the indexing queue viewer, use the page controls to navigate across the task page list.

Data center node indexing

The Indexing queue viewer page correctly displays the number of current indexing tasks according to the specified number of threads, such as:

• Current number of indexing threads which defines the number of indexing threads on current node
• Current number of processing tasks which defines the number of all processing tasks on all nodes
• Number of tasks with status which corresponds to the number of threads; multiplied by the number of nodes involved in indexing.

Tasks with INDEXING status can also be marked for cancelling.

The QUEUED tasks can also be removed from the indexing queue.

The GC tasks can be completed if the indexing queue is empty.

See more Git Integration for Jira app features

Manager permissions (Git Integration for Jira Data Center)

Cancel indexing (Git Integration for Jira Data Center)

Pull request filters (Git Integration for Jira Data Center)

Tag filters (Git Integration for Jira Data Center)

Indexing queue viewer (this page)

Deep linking feature (Git Integration for Jira Data Center)

GitHub App integration (Git Integration for Jira Data Center)

Git Integration + ScriptRunner (Git Integration for Jira Data Center)

Git Integration + Jira Automation (Git Integration for Jira Data Center)

Enforced git permissions for Jira users – Features (Git Integration for Jira Data Center)

Shared reindex queue between DC nodes (Git Integration for Jira Data Center)

Smart commits overview (Git Integration for Jira Data Center)

Associate Pull/Merge Requests to Issues Based on Commits (Git Integration for Jira Data Center)

Creating branches (Git Integration for Jira Data Center)

Creating pull/merge requests (Git Integration for Jira Data Center)

Issue Git integration panel – Features (Git Integration for Jira Data Center)