Skip to main content

Support Features

Nexus Repository has features to manage and monitor your server for issues. This is useful for troubleshooting and support activities.

Support features are available in the Support view of the Administration menu.

Support ZIP

Administrators may produce a support zip by navigating to Administration → Support → Support Zip. Submit the generated ZIP archive file to Sonatype support by email or attach it to a support ticket.

Sensitive password-related information is removed from the generated files. You are prompted to verify your repository manager account credentials when generating the support zip.

Single Instance Environment

In non-highly available deployments, the support ZIP archive files are stored on the server under the $data-dir/downloads directory named as the time the file was generated.

image__5_.png

To generate a support zip:

  1. Select the cog icon in the top toolbar to open the administration interface.

  2. Select the Support and then Support Zip sidebar menu options.

  3. Select the contents you would like to include in your support zip; then select Create support Zip.

When the support zip is generated, you are taken to a screen like the one below where you can see the name, size, and path of the zip file as well as download the file with the Download button.

image__6_.png

High Availability Environment

In highly available deployments, each node may need to generate a support zip to properly diagnose issues. These zips are stored in the oldest shared blob store available to each node. You must have a blob store shared across all nodes to create a support zip.

A screenshot and details about creating a support zip in a High Availability (HA) environment are below; the experience varies slightly for non-HA environments.

Support zip screen

When a support zip has not been created for a given node, no zip created is displayed.

Follow the steps below to generate a new support zip:

  1. To generate a support zip for a node, select the cog icon in the top toolbar to open the administration interface.

  2. Select Support and then Support ZIP sidebar menu items.

  3. Select the Generate new Zip button for the given node; alternatively, select the Generate Zip from all nodes button to generate new support zips for all nodes using the same settings you will configure in the next step

  4. In the form that appears, select the contents to include.

  5. Select the Create support zip button; support zip creation may take some time. A spinner appears while generation is taking place.

  6. The spinner disappears when the support zip is ready. Refresh your screen to see the new download link(s) in the node cards if a previous support zip existed for a node. The new download link appears without refresh when no zip exists.

  7. Select the link to download the zip file.

Locate the support zip in the shared blob store in the following path:

/shared_blob_store/content/directpath/nexus-blobstore-download-service

High-availability nodes not shut down gracefully continue to appear on the Support Zip page for a few seconds.