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

[DOCS-9537] Add manual steps for nginx browser RUM #26323

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

Conversation

rtrieu
Copy link
Contributor

@rtrieu rtrieu commented Nov 15, 2024

What does this PR do? What is the motivation?

  • Adds steps for how to manually instrument RUM for nginx web servers

Merge instructions

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

Needs PM/eng review before merging.

@rtrieu rtrieu requested review from a team as code owners November 15, 2024 20:29
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

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

Really just the one edit to capitalize NGINX. I don't know if I was able to get to all of them. You might want to do a quick pass once you've applied these.

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
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
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
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
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
Copy link
Contributor

@hestonhoffman hestonhoffman left a comment

Choose a reason for hiding this comment

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

One more small edit

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

rtrieu commented Nov 18, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 18, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-18 21:40:49 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in master is 30m.


2024-11-18 21:44:49 UTC ⚠️ MergeQueue: This merge request build was cancelled

This merge request build was cancelled

@rtrieu
Copy link
Contributor Author

rtrieu commented Nov 18, 2024

/merge -c

Comment on lines 32 to 33
- Auto-Instrumentation does not inject into encrypted requests served by NGINX or IIS related to TLS.
- (NGINX only) Auto-Instrumentation does not inject encrypted requests served by the NGINX web server.
Copy link
Member

Choose a reason for hiding this comment

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

💬 suggestion: ‏Those two lines are telling the same thing, no?

Suggested change
- Auto-Instrumentation does not inject into encrypted requests served by NGINX or IIS related to TLS.
- (NGINX only) Auto-Instrumentation does not inject encrypted requests served by the NGINX web server.
- Auto-Instrumentation does not inject into encrypted requests served by NGINX or IIS related to TLS.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, that's not entirely true. Currently, it's not possible to inject in HTML pages **proxied **by the web-server. May I suggest this instead:

  • End-to-End Encryption by upstream server: If NGINX is acting as a proxy and the upstream server has end-to-end encryption (like TLS) enabled. The module can not inject RUM. Ensure the web server is setup for TLS origination.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dmehala Should I add "or IIS" as the original statement does, or does this only apply to NGINX?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dmehala I pushed an update - please check.

error_log <file> info;
```

[1]: https://app.datadoghq.com/rum/list
Copy link
Member

Choose a reason for hiding this comment

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

💬 suggestion: ‏make this link dependent to the selected region

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @BenoitZugmeyer, as far as I know, this already happens automatically. Let me know if you find something different.

content/en/real_user_monitoring/browser/setup/server.md Outdated Show resolved Hide resolved

{{% /collapse-content %}}

{{% collapse-content title="Manual instrumentation" level="h5" %}}
Copy link
Member

Choose a reason for hiding this comment

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

💭 thought: ‏it's a bit confusing to talk about "Manual instrumentation" on a page called "Auto instrumentation". Maybe we should have another wording, like: Using the installer and Manual configuration

Copy link
Contributor

Choose a reason for hiding this comment

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

Finally! Thank you @BenoitZugmeyer

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

@dmehala dmehala left a comment

Choose a reason for hiding this comment

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

Few comments there and there. It's getting increasingly confusing from the customer POV. The title mentions "RUM Browser Monitoring Server-Side (Auto) Instrumentation", some part of the doc says "Auto-instrumentation" and "Manual-instrumentation".

We committed to call the solution "Auto-Instrumentation". It worth to revisit the doc with the definitive naming.

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

Successfully merging this pull request may close these issues.

4 participants