Documentation Nexus Repository Manager 2.14

12.1. Configuring Repository Health Check

12.1.1. Configuration Per Repository

Repository health check can be setup for any repository, as long as the following apply:

  • The Repository Type is Proxy.
  • The Repository Policy is not Snapshot.
  • The Repository is In Service.

Repository health check for a single repository can be enabled in one of two ways. The quickest way is to simply click the Analyze button. After pressing this button, you will be prompted to either analyze all or only the selected repository.

Alternatively, you can select the repository in the list of repositories and then set the Enabled configuration in the Health Check tab to true as displayed in Figure 12.1, “Enabling Repository Health Check”. Administrator privileges are required to perform this configuration.


Figure 12.1. Enabling Repository Health Check


After enabling Repository Health Check for the first time you will be presented with an acceptance of the Terms of Service.

Once enabled, a scheduled task that performs the initial analysis is created and started. This task uses the identifier of the repository and the prefix Health Check: as a name and is configured to run regularly. New component infomation is supplied by the Sonatype Data Services to Nexus Repository Manager daily. The recurrence frequency can be changed in the scheduled task administration described in Section 6.5, “Managing Scheduled Tasks”. Disabling health check for a specific repository removes this scheduled task automatically.

After a successful analysis, the Health Check column in the list of repositories will display security and license issue counts for the repository. An example is displayed in Figure 12.2, “The Repositories List with Health Check Result Counts”.


Figure 12.2. The Repositories List with Health Check Result Counts

Hovering your mouse pointer over that value will display the Repository Health Check summary data in a pop-up window. A sample window is displayed in Figure 12.3, “A Result Summary for a Repository Health Check”.


Figure 12.3. A Result Summary for a Repository Health Check

At the bottom of the pop-up window, you find the button View Detailed Report to access the detailed report. It will show up in another tab in the main area of the user interface.

12.1.2. Global Configuration

Alternatively to enabling and disabling health check for each repository, you can enable health check globally. This can be achieved by creating and configuring a new capability called Health Check: Configuration. Details about managing capabilities can be found in Section 6.6, “Accessing and Configuring Capabilities”.

The health check configuration capability allows you to enable and disable it with the Enabled checkbox and set up health check for all proxy repositories by enabling Configure for all proxy repositories. With this configuration, health check will be enabled for all existing proxy repositories. Any newly created proxy repository will automatically have health check enabled as well.


When disabling the global configuration option, if you also have the Repositories tab open, be sure to refresh the user interface to avoid viewing older data.