For AI agents: a documentation index is available at https://www.mongodb.com/docs/llms.txt — markdown versions of all pages are available by appending .md to any URL path.

Product Usage Telemetry Overview

Product usage telemetry collects structured configuration and health metadata from your Ops Manager installation and the deployments it manages. It sends that data to MongoDB. Ops Manager enables product usage telemetry by default.

Starting in Ops Manager 9.0.2 and 8.0.28, product usage telemetry replaces the telemetry used in Ops Manager 8.0.27 and earlier. Product usage telemetry collects configuration and health metadata about your Ops Manager installation and the deployments it manages. MongoDB ties the data to your Enterprise Advanced account. Ops Manager 8.0.27 and earlier collected an anonymous report that could identify neither you nor your organization. For details, see Telemetry in Ops Manager 8.0.27 and Earlier.

Product usage telemetry describes how your Ops Manager installation and the deployments it manages are configured. It covers versions, topology, provisioned resources, backup settings, TLS settings, and authentication methods.

Product usage telemetry includes the IDs of your Ops Manager organizations, projects, and deployments. It also includes the names of your replica sets and shards. For the complete field list, see Retrieve Telemetry Data.

Product usage telemetry doesn't include database or document contents, query information, application logs, secrets, or credentials.

Product usage telemetry allows MongoDB to tie the collected information to your Enterprise Advanced account. To do this, Ops Manager signs each payload with an Ed25519 key unique to your installation through its license component. MongoDB verifies the signature and uses your license enrollment to associate the telemetry with your account. If MongoDB can't verify the signature, it still accepts the telemetry but doesn't associate it with your account.

The following table describes how often Ops Manager collects and sends product usage telemetry, and how long MongoDB retains it.

Item
Behavior

Cadence

Ops Manager collects a snapshot once a day and sends product usage telemetry to MongoDB once a week. Each week, Ops Manager sends the daily snapshots from the previous seven days. Each snapshot travels as its own payload. Ops Manager keeps each snapshot in its AppDB for 90 days after collecting it, then deletes it.

First collection

Within six hours after you install or upgrade to Ops Manager 9.0.2, 8.0.28, or later. Ops Manager sends the first payload six days after the first collection.

Retries

If a send fails, Ops Manager keeps the snapshot and retries every six hours until the send succeeds. Ops Manager continues working normally while it retries. If Ops Manager can't reach MongoDB, it keeps the daily snapshots from the last 90 days and deletes older ones. If nothing is sent for 8 days, a banner appears on the Deployment pages. To resolve it, see Troubleshoot Product Usage Telemetry.

Retention at MongoDB

MongoDB keeps product usage telemetry for 90 days, starting when MongoDB receives it. An individual daily snapshot can be kept for up to 97 days, after which MongoDB automatically deletes it.

Location

MongoDB stores product usage telemetry in the AWS us-east-1 region.

Product usage telemetry is on by default. You can turn it off only if the installed license key includes an active telemetry exemption. This applies in every license status, including Expired and Unlicensed. To request an exemption, contact your MongoDB account team.

If the license key includes an active telemetry exemption, the License Key Manager page lists the Telemetry Exemption entitlement under Entitlements. To open the page, click Admin, License Keys. The entitlement reads:

"An approved exception, included in your license key, that gives you the option to turn off product usage telemetry in Ops Manager. This exception was requested by your account team."

A telemetry exemption is active only during its validity period. The validity period is defined in the license key and can't extend beyond the license key grant that includes it.

When the validity period ends, the Product Telemetry Collection toggle locks on again. Product usage telemetry becomes mandatory. To keep it off, request a new exemption from your MongoDB account team and install a license key that includes it.

Earlier Ops Manager versions use a separate telemetry setting. Turning telemetry off in an earlier version doesn't turn off product usage telemetry after you upgrade.

For more information about license keys and entitlements, see Ops Manager License Keys Overview.

The following table describes how the Product Telemetry Collection toggle behaves in each situation.

Situation
Toggle
Product usage telemetry

No active telemetry exemption

On and locked

Collection continues and data is uploaded on the normal schedule.

A license key with an active telemetry exemption is installed

Unlocked. It stays on until you turn it off. Installing the license key doesn't turn telemetry off

If on, collection and uploads continue until you turn it off.

You have a license key with an active telemetry exemption and turn the toggle off

Off

Not collected or sent.

You have a license key with an active telemetry exemption and turn the toggle back on

On

Ops Manager collects a snapshot at its next check, within six hours, and resumes sending.

The exemption's validity period ends

On and locked again, even if the license key is still installed

Collection is mandatory again. Uploads follow the normal schedule.

A license key with an active exemption is installed again later

Unlocked, and returns to the setting you last saved

Follows the toggle

To view product usage telemetry settings, you must have the Global Owner role.

1

Click Admin, General, Ops Manager Config.

2

Click the Telemetry tab.

The following table describes the elements on the Telemetry tab.

UI element
Description

Product Telemetry Collection toggle

Turns product usage telemetry on or off. For details, see Telemetry Exemption.

Learn more

Opens the product usage telemetry overview page.

Next Scheduled Upload

When Ops Manager next sends product usage telemetry to MongoDB. Blank when telemetry is turned off, and before the first collection.

Last Successful Upload

When Ops Manager last delivered product usage telemetry to MongoDB. Blank until the first successful send.

Current Collected Data: Download

Collects fresh data and downloads it as telemetry-data.json.

View data details

Opens a summary of the product usage telemetry configuration and the data categories it collects.

Note

During initial setup, the setup wizard shows that product usage telemetry is enabled by default, without a toggle. After setup, you can review the data on the Telemetry tab.

Each time you download the data, Ops Manager collects it and returns the current report. The download doesn't return a stored snapshot.

1

Click Admin, General, Ops Manager Config, Telemetry.

2

Next to Current Collected Data, click Download.

3

Open telemetry-data.json. For a description of its contents, see Data Collected.

You can also call the Retrieve Telemetry Data endpoint. Its data field contains the same content as the downloaded file.

To turn off product usage telemetry, you need:

  • The Global Owner role.

  • An active telemetry exemption on the installed license key.

You can turn off product usage telemetry from the Ops Manager UI.

1

Click Admin, General, Ops Manager Config, Telemetry.

2

Turn off the Product Telemetry Collection toggle. The change applies immediately, and Ops Manager displays "Configuration saved successfully."

You can also turn off product usage telemetry by calling the Toggle Telemetry Status endpoint with { "enabled": false }.

When product usage telemetry is off, Ops Manager stops collecting and sending it. Next Scheduled Upload becomes blank, and Last Successful Upload keeps its value.

If Ops Manager can't send product usage telemetry, it shows a warning banner on the Deployment pages. Every user who can open the Deployment page sees the banner on every tab, and you can't dismiss it. The banner appears when the license key has no active telemetry exemption and 8 or more whole days have passed since the last successful send. It clears when a send succeeds or when you install a license key with an active telemetry exemption.

To resolve the banner, see Troubleshoot Product Usage Telemetry.

Each Ops Manager host must have outbound HTTPS access on TCP port 443 and DNS resolution to cloud.mongodb.com.

The following table describes the controls that protect product usage telemetry.

Area
Control

In transit

Ops Manager sends telemetry over HTTPS (TLS 1.2 or later).

Authenticity

Through its license component, Ops Manager signs each payload with an Ed25519 key unique to your installation. MongoDB verifies the signature when it receives the payload. If signing isn't available, Ops Manager sends the report unsigned.

At rest

MongoDB encrypts the data in AWS with KMS-managed keys.

Access control

Least-privilege IAM roles on the S3 landing zone restrict access to designated MongoDB engineering personnel.

Auditing

Comprehensive audit logging tracks all access requests and data operations

Each payload that Ops Manager sends has three parts.

Part
Description

Payload

A tamper-evident envelope created by your Ops Manager installation at send time. It contains a fingerprint (SHA-256 digest) of the report and identifiers that tie the report to your Ops Manager enrollment. It doesn't contain the report itself, which travels in Metrics.

Signature

A digital signature over the envelope, created with your installation's Ed25519 key. The signature proves that the report came from your Ops Manager installation and hasn't changed in transit.

Metrics

The report itself, in plain JSON

The downloaded telemetry-data.json file and the API return only the report. For the complete field list, types, and examples, see Retrieve Telemetry Data.

Ops Manager sends each snapshot to MongoDB with a payload fingerprint and signature over the report. MongoDB uses the payload and signature fields to verify the report. The metrics field is the report itself, in plain JSON. The download and the API return the same report:

{ "payload": "eyJhbGciOiJFZERTQSIsInR5cCI6IkpXVCJ9.eyJ...", "signature": "MEUCIQDx8fJ2kQ7vL3mN5pR9sT1uW3yA5bC7dE9fG1hI3jK5wQI...", "metrics": { "data": { "appDbNodes": 3, "backupDaemons": 1, "deployments": [ ... ], "infrastructure": "VM", "instances": [ ... ], "omAuthMethod": "LDAP", "orgs": 1, "projects": 2, "uuid": "3f8a2c6e-9b1d-4e7a-a5c3-8d2f1b6e4a90", "version": "9.0.2" }, "generationTimestamp": 1794442020000, "ingestionTimestamp": 1794442020000 }}

For a complete example response, see Retrieve Telemetry Data.

MongoDB infrastructure also records a small set of standard HTTP request headers from every HTTPS request that your Ops Manager installation sends. MongoDB uses these headers solely for operational integrity: verifying delivery, troubleshooting, and abuse prevention. MongoDB doesn't store these headers with product usage telemetry.

Header
Description
Example

User-Agent

Identifies the HTTP client library that sent the request

Apache-HttpClient/5.5 (Java/21)

Host

The telemetry endpoint hostname the request is sent to

cloud.mongodb.com

Content-Type

The media type of the request body

application/json

Content-Length

The size of the request body in bytes

2847

Content-Encoding

The transfer encoding applied to the body

gzip

X-Forwarded-For / source address

The public IP address Ops Manager connects from

203.0.113.42

Note

MongoDB retains the HTTP request headers in request logs for 390 days, after which it deletes them.