Skip to content

Commit 04583cf

Browse files
rtrieujoepeeplesBenoitZugmeyer
authored
Auto instrumentation updates v2 (#28766)
* move limitations around and add further reading * move limitations and add more descriptions * Apply suggestions from code review Co-authored-by: Joe Peeples <[email protected]> * Apply suggestions from code review Co-authored-by: Benoît <[email protected]> --------- Co-authored-by: Joe Peeples <[email protected]> Co-authored-by: Benoît <[email protected]>
1 parent 4f3d8d6 commit 04583cf

File tree

5 files changed

+67
-41
lines changed

5 files changed

+67
-41
lines changed

content/en/real_user_monitoring/browser/setup/server/_index.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,20 @@ To remotely configure your RUM application:
4848

4949
<div class="alert alert-warning">To request support for a web server that is not listed here, <a href="https://www.datadoghq.com/private-beta/rum-sdk-auto-injection/">fill out this form.</a></div>
5050

51-
Follow the documentation for your web server type to learn more:
51+
If you don't want to configure your RUM applications remotely, follow the documentation for your web server type to configure your RUM application locally:
5252

53+
<br>
5354
{{< partial name="rum/rum-browser-setup.html" >}}
55+
<br>
5456

57+
## Limitations
58+
59+
Keep in mind the following limitations when using this setup:
60+
61+
- This instrumentation method **does not support [advanced RUM configurations][1]**, except for `allowedTracingUrls` and `excludedActivityUrls`.
62+
- If your web server is acting as a proxy and the upstream server uses **end-to-end encryption (TLS)** or **content compression** (gzip, zstd, Brotli), the RUM Browser SDK **cannot be injected**. To ensure proper instrumentation:
63+
- **Disable content compression** on the upstream server.
64+
- **Enable TLS origination** on the web server.
5565

5666
## Further reading
5767

content/en/real_user_monitoring/browser/setup/server/apache.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ beta: true
44
code_lang: apache
55
type: multi-code-lang
66
code_lang_weight: 3
7+
further_reading:
8+
- link: '/real_user_monitoring/browser/setup/server/'
9+
tag: 'Documentation'
10+
text: 'Browser Monitoring Auto-Instrumentation (Server-Side)'
711
---
812

913
<div class="alert alert-info">To try the preview for RUM Auto-Instrumentation, follow the instructions on this page.</div>
@@ -12,14 +16,7 @@ code_lang_weight: 3
1216

1317
RUM Auto-Instrumentation works by injecting the RUM Browser SDK into the HTML responses being served through a web server or proxy.
1418

15-
## Limitations
16-
17-
Keep in mind the following limitations when using this setup:
18-
19-
- This instrumentation method **does not support [advanced RUM configurations][1]**, except for `allowedTracingUrls` and `excludedActivityUrls`.
20-
- If your web server is acting as a proxy and the upstream server uses **end-to-end encryption (TLS)** or **content compression** (gzip, zstd, Brotli), the RUM Browser SDK may **not be injected**. To ensure proper instrumentation:
21-
- **Disable content compression** on the upstream server.
22-
- **Enable TLS origination** on the web server.
19+
To understand important limitations and compatibility requirements, see [Limitations][1].
2320

2421
## Prerequisites
2522

@@ -47,6 +44,8 @@ To automatically instrument your RUM application:
4744

4845
{{% collapse-content title="Manual configuration" level="h5" %}}
4946

47+
To manually load the module onto your web server instead of running the installation script, follow the instructions below.
48+
5049
To manually instrument your RUM application:
5150

5251
#### Download the module file
@@ -106,9 +105,15 @@ To update your RUM Application:
106105
If you notice that RUM is not being injected into HTML pages, consider the following potential causes:
107106

108107
- **Content-Type mismatch**: RUM is injected only into HTML pages. If the `Content-Type` header does not correctly indicate `text/html`, the injection is skipped.
109-
- **Upstream server has end-to-end encryption or content compression**: See [Limitations](#limitations).
110108

111-
[1]: /real_user_monitoring/browser/advanced_configuration/
109+
### Limitations
110+
See other [Limitations][1].
111+
112+
## Further reading
113+
114+
{{< partial name="whats-next/whats-next.html" >}}
115+
116+
[1]: /real_user_monitoring/browser/setup/server/#limitations
112117
[2]: /agent/
113118
[3]: https://httpd.apache.org/modules/
114119
[4]: https://app.datadoghq.com/rum/list

content/en/real_user_monitoring/browser/setup/server/ibm.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ beta: true
44
code_lang: ibm
55
type: multi-code-lang
66
code_lang_weight: 4
7+
further_reading:
8+
- link: '/real_user_monitoring/browser/setup/server/'
9+
tag: 'Documentation'
10+
text: 'Browser Monitoring Auto-Instrumentation (Server-Side)'
711
---
812

913
<div class="alert alert-info">To try the preview for RUM Auto-Instrumentation, follow the instructions on this page.</div>
@@ -12,14 +16,7 @@ code_lang_weight: 4
1216

1317
RUM Auto-Instrumentation works by injecting the RUM Browser SDK into the HTML responses being served through a web server or proxy.
1418

15-
## Limitations
16-
17-
Keep in mind the following limitations when using this setup:
18-
19-
- This instrumentation method **does not support [advanced RUM configurations][1]**, except for `allowedTracingUrls` and `excludedActivityUrls`.
20-
- If your web server is acting as a proxy and the upstream server uses **end-to-end encryption (TLS)** or **content compression** (gzip, zstd, Brotli), the RUM Browser SDK may **not be injected**. To ensure proper instrumentation:
21-
- **Disable content compression** on the upstream server.
22-
- **Enable TLS origination** on the web server.
19+
To understand important limitations and compatibility requirements, see [Limitations][1].
2320

2421
## Prerequisites
2522

@@ -50,6 +47,8 @@ To automatically instrument your RUM application:
5047

5148
{{% collapse-content title="Manual configuration" level="h5" %}}
5249

50+
To manually load the module onto your web server instead of running the installation script, follow the instructions below.
51+
5352
To manually instrument your RUM application:
5453

5554
#### Download the module file
@@ -111,9 +110,15 @@ To update your RUM Application:
111110
If you notice that RUM is not being injected into HTML pages, consider the following potential causes:
112111

113112
- **Content-Type mismatch**: RUM is injected only into HTML pages. If the `Content-Type` header does not correctly indicate `text/html`, the injection is skipped.
114-
- **Upstream server has end-to-end encryption or content compression**: See [Limitations](#limitations).
115113

116-
[1]: /real_user_monitoring/browser/advanced_configuration/
114+
### Limitations
115+
See other [Limitations][1].
116+
117+
## Further reading
118+
119+
{{< partial name="whats-next/whats-next.html" >}}
120+
121+
[1]: /real_user_monitoring/browser/setup/server/#limitations
117122
[2]: /agent/
118123
[3]: https://httpd.apache.org/modules/
119124
[4]: https://rum-auto-instrumentation.s3.amazonaws.com/httpd/latest/mod_datadog-amd64.zip

content/en/real_user_monitoring/browser/setup/server/nginx.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ beta: true
44
code_lang: nginx
55
type: multi-code-lang
66
code_lang_weight: 5
7+
further_reading:
8+
- link: '/real_user_monitoring/browser/setup/server/'
9+
tag: 'Documentation'
10+
text: 'Browser Monitoring Auto-Instrumentation (Server-Side)'
711
---
812

913
<div class="alert alert-info">To try the preview for RUM Auto-Instrumentation, follow the instructions on this page.</div>
@@ -12,14 +16,7 @@ code_lang_weight: 5
1216

1317
RUM Auto-Instrumentation works by injecting the RUM Browser SDK into the HTML responses being served through a web server or proxy.
1418

15-
## Limitations
16-
17-
Keep in mind the following limitations when using this setup:
18-
19-
- This instrumentation method **does not support [advanced RUM configurations][1]**, except for `allowedTracingUrls` and `excludedActivityUrls`.
20-
- If your web server is acting as a proxy and the upstream server uses **end-to-end encryption (TLS)** or **content compression** (gzip, zstd, Brotli), the RUM Browser SDK may **not be injected**. To ensure proper instrumentation:
21-
- **Disable content compression** on the upstream server.
22-
- **Enable TLS origination** on the web server.
19+
To understand important limitations and compatibility requirements, see [Limitations][1].
2320

2421
## Prerequisites
2522

@@ -51,6 +48,8 @@ To automatically instrument your RUM application:
5148

5249
{{% collapse-content title="Manual configuration" level="h5" %}}
5350

51+
To manually load the module onto your web server instead of running the installation script, follow the instructions below.
52+
5453
To manually instrument your RUM application:
5554

5655
#### Download the appropriate `.tgz` file
@@ -122,7 +121,9 @@ Since the module is in Preview, it's possible NGINX may stop serving requests, p
122121
If you notice that RUM is not being injected into HTML pages, consider the following potential causes:
123122

124123
- **Content-Type mismatch**: RUM is injected only into HTML pages. If the `Content-Type` header does not correctly indicate `text/html`, the injection is skipped.
125-
- **Upstream server has end-to-end encryption or content compression**: See [Limitations](#limitations).
124+
125+
### Limitations
126+
See other [Limitations][1].
126127

127128
## Reference
128129

@@ -147,8 +148,11 @@ If you notice that RUM is not being injected into HTML pages, consider the follo
147148
| 1.27.3 | [ngx_http_datadog-amd64-1.27.3][35] | [ngx_http_datadog-arm64-1.27.3][36] |
148149
| 1.27.4 | [ngx_http_datadog-amd64-1.27.4][37] | [ngx_http_datadog-arm64-1.27.4][38] |
149150

151+
## Further reading
152+
153+
{{< partial name="whats-next/whats-next.html" >}}
150154

151-
[1]: /real_user_monitoring/browser/advanced_configuration/
155+
[1]: /real_user_monitoring/browser/setup/server/#limitations
152156
[2]: /agent/
153157
[3]: https://docs.nginx.com/nginx/admin-guide/dynamic-modules/dynamic-modules/
154158
[4]: https://app.datadoghq.com/rum/list

content/en/real_user_monitoring/browser/setup/server/windows_iis.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ beta: true
44
code_lang: windows_iis
55
type: multi-code-lang
66
code_lang_weight: 6
7+
further_reading:
8+
- link: '/real_user_monitoring/browser/setup/server/'
9+
tag: 'Documentation'
10+
text: 'Browser Monitoring Auto-Instrumentation (Server-Side)'
711
---
812

913
<div class="alert alert-info">To try the preview for RUM Auto-Instrumentation, follow the instructions on this page.</div>
@@ -12,14 +16,7 @@ code_lang_weight: 6
1216

1317
RUM Auto-Instrumentation works by injecting the RUM Browser SDK into the HTML responses being served through a web server or proxy.
1418

15-
## Limitations
16-
17-
Keep in mind the following limitations when using this setup:
18-
19-
- This instrumentation method **does not support [advanced RUM configurations][1]**, except for `allowedTracingUrls` and `excludedActivityUrls`.
20-
- If your web server is acting as a proxy and the upstream server uses **end-to-end encryption (TLS)** or **content compression** (gzip, zstd, Brotli), the RUM Browser SDK may **not be injected**. To ensure proper instrumentation:
21-
- **Disable content compression** on the upstream server.
22-
- **Enable TLS origination** on the web server.
19+
To understand important limitations and compatibility requirements, see [Limitations][1].
2320

2421
## Prerequisites
2522

@@ -72,10 +69,15 @@ To update your RUM Application:
7269
If you notice that RUM is not being injected into HTML pages, consider the following potential causes:
7370

7471
- **Content-Type mismatch**: RUM is injected only into HTML pages. If the `Content-Type` header does not correctly indicate `text/html`, the injection is skipped.
75-
- **Upstream server has end-to-end encryption or content compression**: See [Limitations](#limitations).
7672

73+
### Limitations
74+
See other [Limitations][1].
75+
76+
## Further reading
77+
78+
{{< partial name="whats-next/whats-next.html" >}}
7779

78-
[1]: /real_user_monitoring/browser/advanced_configuration/
80+
[1]: /real_user_monitoring/browser/setup/server/#limitations
7981
[2]: /agent/
8082
[3]: https://app.datadoghq.com/rum/list/create/
8183
[4]: /real_user_monitoring/guide/best-practices-for-rum-sampling/

0 commit comments

Comments
 (0)