Skip to content

docs(rum): add RUM resources Best practices note #724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
michael-richey wants to merge 2 commits into
base: michael.richey/add-rum-config
Choose a base branch
from
Open

docs(rum): add RUM resources Best practices note #724

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce5935f
docs(rum): add RUM resources Best practices note
michael-richey Sep 25, 2026
e526b6e
docs(rum): fix PATCH-only wording in README
michael-richey Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,19 @@ If importing/syncing subset of resources, users should ensure that dependent res

See [Supported resources](#supported-resources) section below for potential resource dependencies.

#### RUM resources

RUM (Real User Monitoring) resources cover application configuration, retention filters, metrics, operations, replay playlists, teams-ownership mappings, and org-level config. Some RUM resources are parent-scoped under a RUM application (`rum_applications`) and are synced after it.

Limitations and notes:

- **Intake data is not migrated.** RUM events, analytics/aggregation, replay sessions, and the `.../sessions` playlist associations are intake-tied and out of scope (consistent with this tool's general stance on ingested data). The tool syncs the resource *definitions* only.
- **`rum_operations`** and **`rum_replay_playlists`** are static definitions (name, query, journey rules / name, description). Their `query` fields are RUM query filters (e.g. `@type:view`), not session ids, so no session-id stripping is required.
- **`rum_permanent_retention_filters`** are system-provisioned with fixed ids identical across orgs; reads use GET, but mutations are PATCH-only (configure `cross_product_sampling` — no POST/DELETE), so `create` delegates to `update` and `delete` is a no-op.
- **`rum_teams_ownership_mappings`** have no PATCH endpoint; update is implemented as delete-then-recreate. `team_handle` is a stable handle (preserved across orgs by the `teams` resource) and is not remapped; the dependency on `teams` is soft.
- **`rum_config`** is a singleton org setting; only `enforced_application_tags` is configurable.
- **Excluded (cannot fit the import model):** `rum_teams_ownership_rules` (read-only — nothing to mutate) and `rum_retention_quotas` (no list endpoint — cannot enumerate for import). Sync these manually if needed.

| Resource | Dependencies |
|----------------------------------------|------------------------------------------------------------------|
| authn_mappings | roles, teams |
Expand Down
Loading