Skip to content
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

RUM Auto-instrumentation updates #28233

Open
wants to merge 17 commits into
base: master
Choose a base branch
from

Conversation

rtrieu
Copy link
Contributor

@rtrieu rtrieu commented Mar 18, 2025

What does this PR do? What is the motivation?

Per discussion with @sarjyusuf, this primarily contains the following updates:

  • Added a card layout partial to the auto-instrumentation landing page
  • Created a page for each auto-instrumentation server (added multi-code lang functionality)
  • Added more use case info about auto vs custom instrumentation to the browser setup overview page (removed multi-code lang functionality)
  • Updated language for all preview tags that mentioned auto-instrumentation

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

To be reviewed by RUM Eng before merging.

@rtrieu rtrieu requested review from a team as code owners March 18, 2025 19:44
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR Guide Content impacting a guide labels Mar 18, 2025
@@ -1,6 +1,58 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

How is a customer supposed to navigate to this section? Given the path it looks to me like it is supposed to be visible when clicking here

auto-instrumentation-updates/real_user_monitoring/browser/setup
image
image

But instead on that left menu, or the breadcrumbs, the content for "real_user_monitoring/browser/setup/client" is shown instead. It might just be me misunderstanding how navigation is supposed to happen, though (If so, can you link to the page here? 🙇 ).


Keep in mind the following limitations when using this setup:

- This instrumentation method **does not support [advanced RUM configurations][1]**, except for `allowedTracingUrls` and `excludedActivityUrls`.
Copy link
Contributor

Choose a reason for hiding this comment

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

(Comment applies to all servers)

The phrasing we had before (This instrumentation method does not support any advanced RUM configurations. However, allowedTracingUrls and excludedActivityUrls are supported) didn't imply allowedTracingUrls and excludedActivityUrls are advanced RUM configurations, while now I think it does. They are not mentioned in the advanced RUM configurations page, so that might be confusing.

Copy link
Contributor

Choose a reason for hiding this comment

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

I am no native english speaker but the "however" in the original wording seems to indicate allowedTracingUrls and excludedActivityUrls are advanced configuration. I am also non RUM expert, IIRC advanced configuration are configurations supporting arrays and functions, these two are compatible with arrays and functions. Summoning @allspain for clarification.

Copy link
Contributor

Choose a reason for hiding this comment

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

Moving Damien's comment into the PR comments: this is not the appropriate logo for IBM HTTP Server

@rtrieu rtrieu added the WORK IN PROGRESS No review needed, it's a wip ;) label Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Guide Content impacting a guide Images Images are added/removed with this PR WORK IN PROGRESS No review needed, it's a wip ;)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants