Nexus Repository Telemetry

Nexus Repository sends required base telemetry to provide expected daily usage metrics for entitlement review.

Expected daily usage metrics include request and component usage data, such as daily repository request counts and current component totals. These values can help Sonatype review usage over time, including total requests in a calendar month and peak components observed in a calendar month.

If expected daily metrics are not received, a grace period may apply.

Acknowledge Required Base Telemetry

Starting in Nexus Repository 3.97.0, an administrator must acknowledge the required base telemetry requirement during onboarding. The acknowledgement appears for both new self-hosted installations and instances upgraded to Nexus Repository 3.97.0 or later.

The acknowledgement records that an administrator understands the telemetry requirement and the effect of unsuccessful telemetry delivery. Acknowledgement is recorded once for the Nexus Repository instance. After it is recorded, administrators are not prompted to acknowledge the requirement again.

Required Base Telemetry Grace Period

Nexus Repository monitors required base telemetry delivery and provides a grace period when telemetry cannot be successfully uploaded. The grace period depends on the Nexus Repository edition:

Edition	Grace Period
Community Edition	10 days
Pro Edition	45 days

During the grace period, Nexus Repository continues to operate normally. A Baseline Telemetry Upload Issue warning appears when upload failures require administrator attention and shows the remaining grace-period time.

To resolve a required base telemetry upload issue:

1. Verify that the Nexus Repository server can reach the required telemetry endpoints.

2. Run the Upload Retry task.

3. Review the Baseline Telemetry status under Settings → Status.

4. If telemetry still cannot be delivered, contact Sonatype Support.

After Nexus Repository successfully uploads required base telemetry, the telemetry warning is cleared.

/service/rest/v1/system/mandatory-telemetry-acknowledgement

curl -u <username>:<password> \
  -X GET \
  https://<nexus-host>/service/rest/v1/system/mandatory-telemetry-acknowledgement

curl -u <username>:<password> \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"acknowledgement":true}' \
  https://<nexus-host>/service/rest/v1/system/mandatory-telemetry-acknowledgement

Read Only Mode

If required base telemetry cannot be successfully uploaded within the applicable grace period, Nexus Repository enters read only mode.

To restore normal operation, resolve the telemetry connectivity issue and successfully send required base telemetry. Run the Upload Retry task after restoring connectivity if you want to retry the upload immediately. See Tasks for more details. If your environment cannot send required base telemetry, contact Sonatype Support.

If your network uses a TLS-intercepting proxy, configure Nexus Repository to use the proxy and add the proxy’s certificate to the Nexus Repository trust store. Telemetry requests use the Nexus Repository trust store. Configuring the proxy without trusting its certificate can prevent telemetry uploads. These failures count toward the required telemetry grace period. If the failures continue through the grace period, Nexus Repository enters read-only mode.

Take the following steps to configure the proxy and certificate:

Whitelist the following endpoints to ensure that your Nexus Repository instance can successfully send telemetry:

Community Edition Endpoints

Nexus Repository Pro Endpoints

The samples below provide an example of what you can expect to see in the logs when telemetry is successfully sent or when it fails to send:

Success

Telemetry upload successfully with valid signature

Issues Validating Telemetry Payload Signature

Telemetry upload failed (signature verification). Status: {}, URL: {}

Issues with Telemetry Content

 Telemetry upload failed (client error). Status: {}, URL: {}, Response: {}

Issues with Required Base Telemetry

This instance of Nexus Repository has been unable to upload required base telemetry data for the past {} days. This is a warning only. Your instance will continue to operate normally. Check that your server can reach the Sonatype telemetry service, then run the Upload Retry task. If your environment cannot send telemetry or the issue persists, contact Sonatype Support.

Required Base Telemetry Not Acknowledged

Mandatory telemetry acknowledgement was not received. An administrator must acknowledge the mandatory telemetry notice from the Nexus Repository UI.