Skip to content

(DOCSP-58901): Note Admin API limitations for regionalized projects - #191

Open
corryroot wants to merge 1 commit into
10gen:mainfrom
corryroot:DOCSP-58901
Open

corryroot wants to merge 1 commit into
10gen:mainfrom
corryroot:DOCSP-58901

Conversation

@corryroot

Copy link
Copy Markdown
Collaborator

Summary

Adds a note to the Atlas Data Processing page (cet/atlas/data-processing.rst) clarifying that for projects with a non-US Project Services Region (data regionalization) enabled, five features are accessible only via the Atlas UI — programmatic requests to the Atlas Administration API are not supported and will fail.

Affected features:

  • Performance Advisor
  • Query Profiler
  • Schema Advisor
  • Data Explorer
  • Real Time Performance Panel

The note is placed immediately after the existing section that enumerates these same five features, and intentionally avoids citing a specific HTTP status code (engineering logs show a 400 from the regionalization check, but HELP-99639's customer observed 401/500 — the wording states only that requests "fail").

Jira

Resolves DOCSP-58901 — motivated by HELP-99639 (customer's Performance Advisor slow-query-logs API calls failing on a regionalized project).

Root cause (context)

All public Atlas API requests route to mms-api-public pods in us-east-1 only; no public API pods are deployed in the EU regionalization regions. Regionalized projects therefore hit the regionalization check and fail for these endpoints.

⚠️ Important caveats

  • Legal review required. The page carries a banner: "Please do not edit this page without approval from legal." This wording must be reviewed/approved before merge.
  • Page remains unindexed. The existing no-TOC / no-search-indexing banner is preserved, per the ticket requirement.
  • This is shared content; rendering should be verified in the consuming Atlas docs project after merge.

Staging

  • docs/atlas/atlas-data-processing/

Comment on lines +67 to +79
.. note:: {+atlas-admin-api+} Limitations for Regionalized Projects

For projects with a non-US *Project Services Region* enabled, you
can access the preceding features only through the {+service+}
console. |service-fullname| doesn't support programmatic requests to
the :ref:`{+atlas-admin-api+} <atlas-admin-api>` for the following
features, and such requests fail:

- :ref:`Performance Advisor <performance-advisor>`
- :ref:`Query Profiler <profile-database>`
- :ref:`Schema Advisor <schema-suggestions>`
- :ref:`Data Explorer <atlas-ui>`
- :ref:`Real Time Performance Panel <real-time-metrics-status-tab>`

@melissamahoney-mongodb melissamahoney-mongodb Sep 15, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As its own little change, this feels tidy. However, in context of the broader section, this is sort of awkward and repetitive. It refers to the above features, and then describes the following features, which are all the same. Can we simplify? Does it have to be a separate note? Could this simply be "You can't access these features by programmatic request"?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants