RUM Receiver
RUM Receiver
Plugin: dem.plugin Module: receiver
Overview
Monitor the availability and HTTP request outcomes of the browser telemetry receiver.
Netdata accepts browser telemetry over HTTP or HTTPS and routes each request to its configured site. One receiver serves all sites; a receiver outage creates measurement gaps while site jobs remain available.
This collector is only supported on the following platforms:
- Linux
- macOS
This collector only supports collecting metrics from a single instance of this integration.
The Netdata service needs write access to its DEM state directory. Configured TLS and GeoIP files must be readable by the Netdata service account.
Default Behavior
Auto-Detection
The stock receiver starts on loopback. Sites require explicit configuration.
Limits
Browser payloads and request rates are limited by receiver settings.
Performance Impact
Resource usage depends on accepted browser traffic and the configured measurement window. Optional OTLP export and investigation history add network and local disk work.
Setup
Prerequisites
Install the DEM plugin
DEM is experimental and opt-in. Build Netdata with -DENABLE_PLUGIN_DEM=ON, or use --enable-plugin-dem with the source installer. Install the resulting DEM plugin package.
Expose the receiver
Expose the listener through an HTTPS reverse proxy before sending traffic from remote websites. Set public_url and restrict trusted_proxies to that proxy. The default listener is local to this host.
Configuration
Options
Options apply to the canonical receiver.
| Group | Option | Description | Default | Required |
|---|---|---|---|---|
| Connection | listen | Address and port that accept browser telemetry. The default accepts connections from this host only. | 127.0.0.1:19938 | no |
| public_url | Externally reachable collector base URL. Leave empty to derive it from the listener or a trusted proxy. | no | ||
| tls_cert | Server certificate file. Leave empty with TLS key to serve HTTP. | no | ||
| tls_key | Server private key file. Set together with TLS certificate to serve HTTPS. | no | ||
| trusted_proxies | Proxy IP addresses or CIDR ranges allowed to supply forwarded client addresses and public URLs. Leave empty to distrust forwarded headers. | no | ||
| Limits | max_body_bytes | Maximum accepted browser payload size, in bytes. Larger requests are rejected. | 262144 | no |
| rate_limit | Limits for browser telemetry requests. | no | ||
| rate_limit.per_ip_per_min | Maximum requests per client IP per minute. | 120 | no | |
| rate_limit.per_site_per_sec | Maximum requests per site per second. | 500 | no | |
| Collection | update_every | Data collection interval, in seconds. | 10 | no |
| geoip_db | MaxMind city database file. Leave empty to use the Agent IP intelligence database; unavailable data produces unknown locations. | no |
via File
The configuration file name for this integration is dem/receiver.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config dem/receiver.conf
Examples
Local receiver
Minimal native configuration.
jobs:
- name: receiver
listen: 127.0.0.1:19938
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
The availability state distinguishes an unavailable receiver from measured request outcomes.
Per receiver
One configured receiver; breakdowns appear when matching observations are available.
This scope has no labels.
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| dem_receiver.state | RUM receiver availability | serving, unavailable | state |
| dem_receiver.requests | RUM HTTP requests | success, client_errors, server_errors | requests/s |
Alerts
There are no alerts configured by default for this integration.
Troubleshooting
Other Problems
No browser measurements
Check receiver availability, the installed snippet URL and the site allowed origins. Open the rum-sites Function for reachability and rejected-origin diagnostics. Missing vital samples produce gaps, including when the receiver is unavailable.
The observability platform companies need to succeed
Sign up for freeWant a personalised demo of Netdata for your use case?