Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Health Checks are a great way to identify problems in Jira and save the time of your Jira Administrators. Optimizer for Jira comes with over 20 health checks which can be used to analyze your Jira instance and show warnings or errors when something is detected that is considered bad practice or incorrect.

...

To get started and find out more about the health checks using the Health Checks in Optimizer, please use the table of contents below to navigate to the section you want to learn more about:

Table of Contents

Accessing

...

Health Checks

The health checks Health Checks are displayed on Optimizer’s Homepage, it is the first thing you’ll see when you enter the app. As a reminder, you can access Optimizer by clicking the ⚙️ Settings icon in the top right of the screen and then on Optimizer.

Info

You can also access the Homepage from anywhere within Optimizer by clicking the Home option under the Home section in the left-hand side navigation bar.

How

...

Health Checks are scored

On the homepage, you’ll see an overview of the health check scores with a grade and a message about the state of your Jira instance.

...

The grade is calculated from the number of health checks Health Checks that have failed or have warnings and is provides a good indicator of the health of your instance and whether you need to take any actions.

...

Jira instance.

Health Check Collections

For your convenience, Optimizer’s health checks Health Checks are grouped into collections Collections. Each collection is comprised of several health checks that are related but comprises several related Health Checks that focus on different issues with the instanceareas.

There are collections for:

...

Each collection is displayed on Optimizer’s homepage as a card containing a summary of how many health checks within the collection passed, warnedhad warnings, failed, or are were disabled. This allows lets you to quickly focus your attention to the health check on the Health Check results that most need improvement.

Clicking on a collection card will take you to an overview of the health checks within that collection, allowing you to see at a glance the state of each health check, when it last ran, and how many results there are.

Running Health Checks

By default, Optimizer’s health checks run automatically once per day but it is also possible to manually run health checks to get more up to date information. For instance, if you take action based on the results of a health check, then a manual re-run will allow you to quickly see any improvements reflected in your score, and corresponding updated results.

...

Note

You can’t run health checks that have been disabled in your configured health check settings.

Viewing Health Check Results

In order to view the results for of a health check, click on the collection card (e.g., Custom Fields) as shown below.

...

  • Global custom fields

  • Unused custom fields

...

Within each collection, you can click onto any of the rows to find out more detail about the results. This will open a modal with a description of the health check window that displays the description of each Health Check along with a summary of any sets of results. Clicking on a row for a set of results will open a table displaying all of the results in that set. As with the rest of the smart tables within Optimizer, you can then easily deep dive into a particular result and take action against many results at once.

A screenshot of Optimizer’s homepage, which shows the health checks. The chart should be visible with a score, and the health check cards should be shown with multiple statuses (pass, warning, disabled, and fail). One of the cards should be highlighted.

A screenshot of the homepage after clicking on one of the collection cards. The collection display should be visible with the collection name, description and a summary of the health check statuses (passed, warning, failed and disabled). There should be at least 1 warning or failed health check. There should be rows visible for each health check in the collection and one of them should be highlighted.

A screenshot of the homepage, after clicking on a collection card and then a health check row (for a health check with at least 1 set of results). The health check modal should be visible with the health check name and description with rows for each set of results. One the the result rows should be highlighted.

A screenshot of the homepage, after clicking on a collection card, a health check row and then a results set. The health check results table should be visible with the table title being the health check name followed by “results” and there should be a back button in the top left corner.

A screenshot of Optimizer’s homepage, which shows the health checks. The side-navigation needs to be visible, showing the Home button. The chart should be visible with a score, and the health check cards should be shown with multiple statuses (pass, warning, disabled, and fail), as shown below.

...

You can click the row to deep dive even further. In this example, we are going to click on the “8 unused Custom Fields found”, and it will take us to a smart table where these fields are displayed.

...

Once you have reached the smart table, it operates like the other smart tables in Optimizer. You can easily configure and delete individual or multiple custom fields within this one place, and it makes the maintenance process really easy for Jira admins.

Info

You can find more information about Optimizer’s smart tables here.

Configuring Health Checks

All of Optimizer’s health checks have settings that you can change to configure them to your preference. The settings can be updated by selecting the ⚙️ Settings button at the top of the left navigation bar, or in the top right of the homepage. Health check settings exist under the Health Checks tab. You can change the setting parameters as desired and then Save the changes.

A screenshot of Optimizer’s homepage. The side navigation bar should be visible including the settings button near the top. The health checks chart and cards should be visible with the settings button on the right hand side of the page. The 2 health check buttons should be highlighted.

All of the health checks have 2 common settings - enabled and schedule (described below). Some health checks also have specific settings (for example, the maximum number of issues for a project to be considered small).

Enabling/Disabling Health Checks

Each health check has a setting allowing it to be to be enabled or disabled. There are 3 possible states for this setting:

...

This setting will appear next to the health check name in the settings modal (which can be accessed by clicking on one of the ⚙️ Settings buttons in Optimizer) and the value can be changed by selecting the desired state and clicking Save.

A screenshot of the settings modal (which opens after clicking one of the settings buttons) on the health checks tab, highlighting the enabled setting of one of the health checks

Scheduling Health Checks

Each health check has a setting that determines when the health check will run automatically (if enabled). The setting allows the selection of a frequency (hourly, daily, weekly or monthly) and a time (for instance, hour of the day) which determines when and how often the health check will run.

This setting will appear within the expandable section for the health check in the settings modal (which can be accessed by clicking on one of the ⚙️ Settings buttons in Optimizer) and the value can be changed by selecting the desired frequency and time and clicking Save.

A screenshot of the settings modal (which opens after clicking one of the settings buttons) on the health checks tab with one of the health check settings sections open, highlighting the schedule setting