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

Adapt RUM server onboarding to include httpd #27435

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

Conversation

pablomartinezbernardo
Copy link
Contributor

@pablomartinezbernardo pablomartinezbernardo commented Feb 4, 2025

What does this PR do? What is the motivation?

  • Add instructions on how to onboard with injection in the server for RUM
  • Small changes in the already existing content for clarity

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

Copy link
Contributor

github-actions bot commented Feb 4, 2025

Preview links (active after the build_preview check completes)

Modified Files

@allspain
Copy link

allspain commented Feb 6, 2025

Does HTTPD support allowedTracingUrls and excludedActivityUrls? If so we should edit the NGINX line to include HTTPD

@allspain
Copy link

allspain commented Feb 6, 2025

There's a paragraph towards the bottom of the page that says:

Content compression by upstream server: If NGINX is acting as a proxy and the upstream server has content compression (like gzip, zstd, or Brotli) enabled, the module may not inject RUM. Ensure that content compression is disabled on the upstream server and configure NGINX to compress the content.

Should this be just NGINX or any of the webservers?

@rtrieu rtrieu added the editorial review Waiting on a more in-depth review label Feb 10, 2025
@rtrieu
Copy link
Contributor

rtrieu commented Feb 10, 2025

Created DOCS-10037 for more in-depth review.

@pablomartinezbernardo
Copy link
Contributor Author

There's a paragraph towards the bottom of the page that says:

Content compression by upstream server: If NGINX is acting as a proxy and the upstream server has content compression (like gzip, zstd, or Brotli) enabled, the module may not inject RUM. Ensure that content compression is disabled on the upstream server and configure NGINX to compress the content.

Should this be just NGINX or any of the webservers?

It applies to all because they can all be configured as reverse proxies. It also feels redundant with the section above that reads "If proxying compressed traffic...". WGDYT @rtrieu ?

@pablomartinezbernardo pablomartinezbernardo marked this pull request as ready for review February 11, 2025 12:38
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

Some minor feedback for your review. But otherwise looks good!

content/en/real_user_monitoring/browser/setup/server.md Outdated Show resolved Hide resolved
content/en/real_user_monitoring/browser/setup/server.md Outdated Show resolved Hide resolved
@rtrieu
Copy link
Contributor

rtrieu commented Feb 12, 2025

There's a paragraph towards the bottom of the page that says:
Content compression by upstream server: If NGINX is acting as a proxy and the upstream server has content compression (like gzip, zstd, or Brotli) enabled, the module may not inject RUM. Ensure that content compression is disabled on the upstream server and configure NGINX to compress the content.
Should this be just NGINX or any of the webservers?

It applies to all because they can all be configured as reverse proxies. It also feels redundant with the section above that reads "If proxying compressed traffic...". WGDYT @rtrieu ?

I think you are right that this is repetitive. I'll push a commit with a suggestion to reconcile these two.

- This instrumentation method does not support any [advanced RUM configurations][3]. However, `allowedTracingUrls` and `excludedActivityUrls` are supported for NGINX, Windows IIS, and Apache httpd web servers.
- If the web server is acting as a proxy and the upstream server has end-to-end encryption (like TLS) or content compression (like gzip, zstd, or Brotli) enabled, the module may not inject RUM. Ensure the following for successful instrumentation:
- Content compression is disabled on the upstream server.
- The web server is configured to compress the content.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@rtrieu what was your intention behind this line? As of right now it is a bit confusing for me, as it sounds like we're recommending to enable content compression, which shouldn't have an impact on our solution either way.

Copy link
Contributor

Choose a reason for hiding this comment

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

@pablomartinezbernardo my intention was to consolidate this section with the information that was previously under Troubleshooting. We can change it back if this is confusing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants