RUM Browser Monitoring Server-Side (Auto) Instrumentation
To try the preview for RUM SDK Auto-Injection, follow the setup instructions below.
Overview
Datadog RUM Server-Side Instrumentation (Auto-Instrumentation) lets you opt into Real User Monitoring (RUM) automatically by instrumenting web applications served through a web server or proxy.
RUM Auto-Instrumentation works by injecting a RUM SDK JavaScript scriptlet into the HTML responses being served through a web server or proxy.
After your applications have been instrumented, you can configure your RUM application in Datadog.
Prerequisites
The automatic installation method requires that you have the Datadog Agent installed.
Set up your RUM application
The Auto-Instrumentation method leverages the Nginx Dynamic Modules capability to implement a response body filter. The filter injects the RUM SDK into the response body for responses identified as HTML.
To automatically instrument your RUM application:
- In Datadog, navigate to the Digital Experience > Add an Application Page and select the JavaScript (JS) application type.
- Select Auto-Instrumentation and Nginx.
- Set your Session and Session Replay sample rates. See guidance on configuring sampling.
- Copy and run the installer command to load the Datadog RUM SDK Injector onto your Nginx module.
- After the installer successfully installs the SDK Injector, restart Nginx to begin collecting RUM sessions.
Auto-Instrumentation leverages a Windows module that injects the RUM SDK into the response body for responses served by the IIS instance.
- In Datadog, navigate to the Digital Experience > Add an Application Page and select the JavaScript (JS) application type.
- Select Auto-Instrumentation and Windows IIS.
- Set up the IIS module using either the GUI installer or command line as described below:
- Download the Datadog RUM installer.
- Follow the installer as an administrator by opening the
.msi file. - Follow the prompts and accept the license agreement.
- Set your Session and Session Replay sample rates. See guidance on configuring sampling.
- Copy and run the config command shown for each IIS site that you wish to inject RUM into.
- Run the Powershell command line as an administrator.
- Set your Session and Session Replay sample rates. See guidance on configuring sampling.
- Copy and run the config command shown for each IIS site that you wish to inject RUM into.
Updating your RUM application
You can adjust your Session Sampling and Session Replay Sampling rates from the Application Management page.
To update your RUM Application:
- Go to your RUM application from the Application Management list.
- On the Instrument your application page, adjust the slider or enter a specific percentage in the input box for Session Sampling or Session Replay Sampling.
- Copy and run the installer command in your
NGINX.conf file.
To update your RUM Application:
- Go to your RUM application from the Application Management list.
- On the Instrument Your Application page, adjust the slider or enter a specific percentage in the input box for Session Sampling or Session Replay Sampling.
- Copy and replace the code in the Datadog RUM config file for the IIS site that you instrumented.
Limitations
The available functionality has the following important limitations:
- If serving compressed traffic, the Auto-Instrumentation method is not able to inject the JS scriptlet into the HTML traffic.
- This instrumentation method does not support any advanced RUM configurations. However,
allowedTracingUrls and excludedActivityUrls are supported for Nginx web servers. - 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.
- (Windows IIS only) Configuration for Auto-Instrumentation is only available per Windows IIS site.
Further reading
Additional helpful documentation, links, and articles:
