Skip to content

DOCS-895 - Remove XHR metrics from RUM docs #5423

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.

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

Draft
wants to merge 15 commits into
base: main
Choose a base branch
from
Draft

DOCS-895 - Remove XHR metrics from RUM docs #5423

wants to merge 15 commits into from

Conversation

kimsauce
Copy link
Collaborator

@kimsauce kimsauce commented May 31, 2025

Purpose of this pull request

Remove XHR metrics from RUM docs

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

https://sumologic.atlassian.net/browse/DOCS-895

@cla-bot cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label May 31, 2025
@kimsauce kimsauce self-assigned this May 31, 2025
@kimsauce kimsauce requested a review from sukhhanda1 May 31, 2025 03:41
Copy link
Collaborator

@jpipkin1 jpipkin1 left a comment

Choose a reason for hiding this comment

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

Approved, @kimsauce. But it looks like there might be a fix for the issue that may not require updating documentation. See Slack.

@kimsauce kimsauce marked this pull request as draft June 2, 2025 20:00
@kimsauce
Copy link
Collaborator Author

kimsauce commented Jun 2, 2025

Approved, @kimsauce. But it looks like there might be a fix for the issue that may not require updating documentation. See Slack.

Thank you, @jpipkin1 !

@kimsauce kimsauce changed the title Remove XHR metrics from RUM docs DOCS-895 - Remove XHR metrics from RUM docs Jun 3, 2025
@kimsauce kimsauce added the do-not-merge Pull requests that should not be merged label Jun 3, 2025
@@ -58,7 +58,7 @@ The **RUM Overview** dashboards (**Application**, **Service**, **Service with En

Use these dashboards to:
* Analyze load and paint timings for page document loads by application, service, or action.
* View information about core web vitals, XHR processing times/errors, and log errors.
* View information about [core web vitals, XHR processing times/errors, and log errors](/docs/apm/real-user-monitoring/metrics/#xhr-monitoring-metrics).
Copy link
Collaborator

Choose a reason for hiding this comment

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

The link is giving 404. We should change it to following.

Suggested change
* View information about [core web vitals, XHR processing times/errors, and log errors](/docs/apm/real-user-monitoring/metrics/#xhr-monitoring-metrics).
* View information about [core web vitals, XHR processing times/errors, and log errors](/docs/apm/real-user-monitoring/metrics.md#xhr-monitoring-metrics).

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@@ -78,7 +78,7 @@ The **RUM - TopN - Application** and **RUM - TopN - Application Service** dashbo
Use these dashboards to:
* Find out top N browsers, operating systems, and geolocations by load or requests.
* Understand the slowest and fastest browsers from a rendering perspective or geographical locations from a network perspective.
* Understand XHR and log errors your users are experiencing.
* Understand [XHR and log errors](/docs/apm/real-user-monitoring/metrics/#xhr-monitoring-metrics) your users are experiencing.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same as above.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The link is correct; you'd need to pull it in locally and test

Screenshot 2025-06-09 at 11 22 03 AM

@@ -123,11 +123,15 @@ These CWV KPIs are captured and displayed on Overview dashboards for Document Lo

## XHR monitoring metrics

An XML HTTP Request (XHR) is a form of communication between the browser and the application backend without reloading the page. A typical example is when a page needs to update a price ticker automatically or after pressing the “update price” button next to it.
:::note
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this some sort of formatting? I do not see any impact of this in the preview.
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes - to preview the correct formatting, you'd need to pull it in locally.

Here's what it looks like in localhost

Screenshot 2025-06-09 at 11 22 03 AM

@kimsauce kimsauce requested a review from sukhhanda1 June 9, 2025 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Contributor approved, listed in .clabot file do-not-merge Pull requests that should not be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants