Real User Monitoring
Plugin: dem.plugin Module: rum
Overview
Measure what real visitors experience on your website (Core Web Vitals, load times, JavaScript errors and traffic), straight from their browsers.
Add one script tag to the website, and each site job gives you:
- Web Vitals (LCP, INP, CLS, FCP and TTFB) as p50, p75 and p95, with how many experiences were good, needed improvement or were poor, and alerts when more than a quarter of LCP, INP or CLS experiences miss the good threshold.
- Document load and DOMContentLoaded times, same-site API (fetch and XHR) durations, and resource timings by host.
- Page views, application views, sessions and JavaScript errors, with errors grouped by fingerprint.
- The same measurements broken down by page, country, browser, device type and application version.
- A live feed of recent events and a history of sampled sessions, each with its timeline of pages, errors and events.
- Optionally, rage, dead and error clicks, and browser events and request traces sent to an OpenTelemetry receiver.
The website loads a small script from the Agent's RUM Receiver, which loads the Grafana Faro Web SDK from the same receiver. The SDK reports from each visitor's browser back to the receiver; visitors never contact a third-party service. The receiver accepts reports only from the site's allowed origins and hands them to the site job, which keeps the last few minutes of measurements in memory for the charts and saves the details of sampled sessions to local history on the Agent.
Before anything is charted, saved or exported, URLs lose their query strings, fragments and credentials, and path
segments that look like email addresses, IDs or tokens are replaced. Client IP addresses are used to enforce rate
limits and look up the visitor's location, and are not stored. This is not full anonymization: error messages, page
paths, user IDs that your application sets and exported event attributes can still identify people. Credentials
from the site's configuration, such as an export auth_token, are masked in saved and exported text when they are
at least 4 bytes long; a shorter value is masked only when it looks like a credential (token=... or Bearer ...).
This collector is only supported on the following platforms:
- Linux
This collector supports collecting metrics from multiple instances of this integration.
| Permission | Needed when |
|---|---|
The Netdata service account (usually netdata) can read the tls_ca, tls_cert and tls_key files of an export destination. | Event logs or tracing send to an HTTPS receiver with a custom CA or a client certificate. |
Real User Monitoring can be monitored further using the following other integrations:
Default Behavior
Auto-Detection
This integration doesn't support auto-detection.
Limits
- The charts summarize the reports received in the last
window(5 minutes by default), counted by when the receiver got them. - Breakdown charts show the busiest values in that window and combine the rest as
other: up topage_groupspages and application views andcountriescountries (20 each by default), 20 browsers, 10 application versions, 10 error fingerprints and 10 resource hosts. Therum-pagesFunction lists every page. - The Web Vital alerts need at least 30 observations of that vital in the window, so a quiet site never triggers them. No stock alert fires when traffic stops.
- Session history is shared with the synthetic monitors and kept for about 30 days, or less once it would exceed
1 GiB (
historyindem.conf). Files of up to a day expire together, so records can stay about a day longer; when the size limit is reached, the oldest records go first. Only sessions selected byinvestigateare saved. - Up to 2,000 sessions per site are tracked in memory. A session that goes quiet or is pushed out loses the details held for it, so a later error can no longer save them.
- City locations appear only in the live feed. History and exports keep the country at most.
Performance Impact
The site job runs inside the DEM plugin on the Agent. Decoding reports costs CPU, and memory grows with the number of
distinct page views and sessions received recently: their measurements are kept for window, and the identities used
to recognize repeated reports for 30 minutes. In Netdata's tests, one site that received 450,000 page views in
29 minutes held about 630 MB of Go heap, and the DEM plugin used about two-thirds of a CPU core while it received
1,000 reports per second across 100 sites and scheduled 400 browser jobs (not counting the browsers themselves).
measure_sample_ratemeasures a share of sessions instead of all of them, and a shorterwindowkeeps less in memory.- Each site has about 30 charts plus its breakdown charts. At the default limits a busy site can have about 700
breakdown charts; lower
page_groupsandcountriesto reduce them. - Saving sessions writes to local disk; lower
investigate.sample_rateto save fewer. - Event logs and tracing send data over the network to their destinations.
Setup
Prerequisites
Expose the RUM receiver to your visitors
Browsers send reports to the RUM Receiver, which
listens only on 127.0.0.1:19938 by default. Put an HTTPS reverse proxy in front of it that forwards the whole /rum/
path, then set the receiver's public_url to the public address and trusted_proxies to the proxy's address, in
dem/receiver.conf. The receiver page has the details.
Add a site job
Add one job per website to dem/rum.conf, with the site key (name) and the origins the website is served from
(allowed_origins). See the examples below.
Add the script to your website
Once the receiver has a public URL, the rum-sites Function shows the script tag for each site. It looks like this,
with your receiver address and site key:
<script async src="https://rum.example.org/rum/shop.js"></script>
- Add it to every page as a classic external script tag, with the address exactly as shown. The SDK and the reports
use addresses relative to the tag's
src, so a redirect of only the script does not carry over to them. A tag manager must insert the tag itself; pasting the script's contents inline, loading it as a module or evaluating it does not work. - If the website has a Content Security Policy, allow the receiver's script address in
script-src-elem(orscript-src) and its/rum/address inconnect-src. Anonceon the tag is passed on to the SDK scripts, andstrict-dynamicworks as usual. A policy that requires Trusted Types for script URLs needs your own integration: the script creates no permissive policy. HTTPS pages need an HTTPS receiver address. - Optionally, set
data-version="1.4.2"on the tag to compare application releases, callwindow.netdataRum.setUser({ id: '...' })to find a user's sessions later, and, once the SDK has loaded, report single-page application routes withGrafanaFaroWebSdk.faro.api.setView({ name: '/checkout' }). Use an internal, non-personal user ID of at most 128 bytes, and clear it when the user logs out: it is stored without hashing. It appears in session history only, not in the live feed, the charts or the exports.
Check that reports arrive
Open the website in a regular browser (automated and headless browsers are excluded by default) and look at the
browser's Network panel: the script and SDK load from the receiver, and a POST to /rum/shop/collect returns 202.
rum-sites then shows a recent last accepted report for the site. Charts appear within the next update_every.
A 202 means the report reached the live measurements; it does not prove that it was saved or exported.
Optional - send event logs and traces to OpenTelemetry
Event logs (browser events, custom event attributes and optionally console messages) and browser request traces are
off by default and are exported separately, over OTLP/gRPC. The default destination, http://127.0.0.1:4317, is where
the Agent's OpenTelemetry plugin listens; there, event logs
appear in the Logs tab under the netdata-rum service, and spans in the Traces tab.
To follow a request from the browser into your backend, also instrument the backend services, list their origins in
tracing.propagate_to, allow the traceparent header in their CORS settings, and send their spans to the same tracing
system.
Configuration
Options
Each job is one website. All options apply per job; event logs and tracing each have their own destination.
Configuration options
| Group | Option | Description | Default | Required |
|---|---|---|---|---|
| Site | name | Site key, made of letters, digits, underscores and hyphens. It is part of the script URL and identifies the site in charts and history, so renaming starts a separate history. | yes | |
| display_name | Human-readable site name for charts and Functions. Leave empty to use the site key. | no | ||
| allowed_origins | Origins the website is served from, such as https://shop.example.org; reports from other origins are refused. A leading *. matches any subdomain. | yes | ||
| public_url | Public base URL of the receiver for this site's script tag, such as https://rum.example.org. Leave empty to use the receiver's public URL. | no | ||
| Collection | update_every | Data collection interval, in seconds. | 10 | no |
| window | Time span of recent reports that the charts, alerts and Pages view summarize, from 1m to 30m. | 5m | no | |
| page_groups | How many of the busiest pages and application views get their own breakdown charts, from 1 to 100. The rest are combined as other. | 20 | no | |
| countries | How many of the busiest countries get their own breakdown charts, from 1 to 100. The rest are combined as other. | 20 | no | |
| bots | Whether to drop reports from crawlers, headless browsers and other automation (exclude) or keep them as device bot (include). | exclude | no | |
| Capture | capture | Optional location and interaction data to collect. By default only the visitor's country is looked up and click signals are off. | no | |
| capture.geolocation | Location looked up from the visitor's IP address - off, country, or city, which adds approximate city markers to the live feed. Coordinates are never stored or exported. | country | no | |
| capture.frustration_signals | Detect rage clicks, dead clicks and clicks followed by an error. These are heuristics, not proof of user frustration. | no | no | |
| Sampling | measure_sample_rate | Share of browser sessions that send reports, from 0 to 1. 1 measures every session; 0 stops collection for the site. | 1 | no |
| investigate | Which measured sessions are saved to history with their details, and exported when event logs or tracing are on. Leave empty to save every session. | no | ||
| investigate.sample_rate | Share of measured sessions saved with their details, from 0 to 1. 0 saves only the sessions that always_keep selects. | 1 | no | |
| investigate.always_keep | Sessions to save whatever the sample rate - errors (a JavaScript error) and poor_vitals (a poor Web Vital). An empty list adds none. | ["errors","poor_vitals"] | no | |
| Event logs | event_logs | Export browser events, including custom event attributes, as OpenTelemetry logs. Session history in Netdata works without it. | no | |
| event_logs.enabled | Send event logs to their destination. | no | no | |
| event_logs.include_console_logs | Also export the console info, warning and error messages of saved sessions. Requires event logs. | no | no | |
| event_logs.destination | OTLP/gRPC receiver for this signal. Leave empty to use http://127.0.0.1:4317, where the Netdata OpenTelemetry plugin listens by default. | no | ||
| event_logs.destination.endpoint | Receiver address with a port, http://host:port for plaintext or https://host:port for TLS, without a path or credentials. | http://127.0.0.1:4317 | no | |
| event_logs.destination.auth_token | Bearer token for the receiver. Use a secret reference such as ${env:OTLP_TOKEN}. Leave empty for no authentication. | no | ||
| event_logs.destination.tls_ca | CA certificate file to verify an HTTPS receiver. Leave empty to use the system's trusted CAs. | no | ||
| event_logs.destination.tls_cert | Client certificate file for an HTTPS receiver that requires one. Set together with the client key. | no | ||
| event_logs.destination.tls_key | Client private key file. Set together with the client certificate. | no | ||
| Browser tracing | tracing | Record spans for the browser's requests and pass trace context to your APIs, exported as OpenTelemetry traces. | no | |
| tracing.enabled | Send browser spans to their destination. Independent of event logs. | no | no | |
| tracing.propagate_to | Origins of other APIs, such as https://api.example.org, whose requests also get the traceparent header. Requests to the page's own origin always get it. | no | ||
| tracing.destination | OTLP/gRPC receiver for this signal. Leave empty to use http://127.0.0.1:4317, where the Netdata OpenTelemetry plugin listens by default. | no | ||
| tracing.destination.endpoint | Receiver address with a port, http://host:port for plaintext or https://host:port for TLS, without a path or credentials. | http://127.0.0.1:4317 | no | |
| tracing.destination.auth_token | Bearer token for the receiver. Use a secret reference such as ${env:OTLP_TOKEN}. Leave empty for no authentication. | no | ||
| tracing.destination.tls_ca | CA certificate file to verify an HTTPS receiver. Leave empty to use the system's trusted CAs. | no | ||
| tracing.destination.tls_cert | Client certificate file for an HTTPS receiver that requires one. Set together with the client key. | no | ||
| tracing.destination.tls_key | Client private key file. Set together with the client certificate. | no | ||
| Normalization | redact_paths | Your own replacements for private identifiers in URL paths, applied before the built-in ones. | no | |
| redact_paths[].pattern | Regular expression, in Go syntax, matching the part of a URL path to replace. Empty patterns are ignored. | no | ||
| redact_paths[].replace | Replacement text, such as :account. Leave empty to remove the match. | no | ||
| Virtual Node | vnode | Associates this job with a Virtual Node. | no |
name
Browsers load the site's script from /rum/ followed by the site key and .js, and send reports to /rum/ followed
by the site key and /collect. After a rename, update the script tag on the website.
allowed_origins
An origin is the scheme, host and port of the page, such as https://shop.example.org or http://localhost:8080,
without a path. Scheme and port must match exactly. https://*.example.org matches https://www.example.org and
https://app.example.org, but not https://example.org; list that separately. The rum-sites Function shows the last
refused origin, which helps when reports from your own pages are refused.
window
A longer window smooths percentiles on quiet sites and gives the alerts more observations, and keeps more in memory. Changing it restarts the measurements.
capture.geolocation
City markers need a database with city data on the receiver (see the RUM Receiver page). In YAML, quote 'off';
unquoted, off is read as a boolean and the job does not start.
capture.frustration_signals
A rage click is three clicks on one spot within a second, a dead click is a click on a link or button that changes nothing within a second, and an error click is followed by a JavaScript error within a second. Only a short CSS selector of the clicked element is sent, never its text. Enabling them adds click listeners to every page. They are counted on the frustration chart and, for saved sessions, appear in the session timeline.
measure_sample_rate
The decision is made once per browser session: a session that is not sampled sends nothing, so it cannot be saved or investigated later. A browser session keeps its decision until it ends, even across page reloads, so a new rate reaches a visitor in their next session. At 0 the script stops loading the SDK at the next page load, the receiver discards reports from pages that are still open, and the measurement charts stop.
investigate.sample_rate
Reports that carry no session ID still count in the measurements. They are saved and exported only when
sample_rate is 1 or they match always_keep; their JavaScript errors are then saved as standalone errors,
outside any session.
investigate.always_keep
To save details only for problem sessions, set sample_rate to 0 and keep the default list. When a session starts to
match, the details already held for it (up to 100 entries) are saved, and so is everything after, while the Agent
still tracks the session (up to 2,000 per site; quiet sessions expire).
Event logs and spans sent before the session matched are not exported afterwards.
event_logs
With the default destination, open the Logs tab of the receiving node, select the otel-logs source and the
netdata-rum service (resource.attributes.service.name), then filter by resource.attributes.rum.site (the
site key) and attributes.session.id. Each record's attributes.rum.type is console, event, error,
pageview or vital; look at attributes.console.level, attributes.event.name, attributes.event.attr.KEY,
and for errors attributes.error.type and attributes.error.stack. Viewing logs needs Netdata Cloud sign-in.
event_logs.enabled
Export never blocks measurements or history. On the rum.otlp chart, sent counts records the receiver accepted
(not proof that it stored them), errors counts records whose delivery failed or was refused (a timeout can
leave the outcome unknown), and dropped counts records lost locally because the queue was full or the job
stopped first. Failed records are not retried. Turning the export off keeps its saved settings without checking
them.
event_logs.include_console_logs
Console errors are exported as logs. Uncaught exceptions and unhandled promise rejections are always collected as JavaScript errors, with or without this option.
event_logs.destination.endpoint
Omit the key to use the default; an explicitly empty value is rejected while the export is on. Write IPv6
addresses in brackets, such as https://[2001:db8::1]:4317.
event_logs.destination.auth_token
A secret reference must resolve even while the export is disabled, or the job does not start.
tracing
Browser spans show the browser's side of each request; they do not prove what the backend did. A session can contain several traces, and event logs are not linked to traces automatically: look up a trace ID from the browser in your tracing system.
tracing.enabled
The rum.spans chart counts spans with the same sent, errors and dropped meaning as the event log chart
(see event_logs.enabled). Turning tracing off keeps its saved settings without checking them.
tracing.destination.endpoint
Omit the key to use the default; an explicitly empty value is rejected while tracing is on. Write IPv6
addresses in brackets, such as https://[2001:db8::1]:4317.
tracing.destination.auth_token
A secret reference must resolve even while the export is disabled, or the job does not start.
redact_paths
The built-in rules already replace path segments that look like an email address (:email), a UUID or a number of
six or more digits (:id), or a long token (:token). Add a rule for identifiers they miss, for example
pattern: '/accounts/[^/]+' with replace: '/accounts/:account'. These rules apply to URL paths only; they do not
change user IDs, error messages or event attributes.
vnode
The site's charts and alerts appear under the virtual node instead of this Agent's host, which lets you group the
real-user and synthetic monitoring of one website under one node. Define the virtual node first, as the dem:vnode
dynamic configuration or as a YAML file in the vnodes/ directory of the Netdata configuration directory, then enter
its name, not its GUID. Changing it restarts the measurements; saved sessions keep the virtual node they were
recorded under.
via File
The configuration file name for this integration is dem/rum.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/rum.conf
Examples
Measure a website
The minimal site. It measures every session and saves every session to history.
Config
jobs:
- name: shop
allowed_origins:
- https://shop.example.org
Save details only for problem sessions
Measures every session but saves to history only sessions with a JavaScript error or a poor Web Vital.
Config
jobs:
- name: shop
allowed_origins:
- https://shop.example.org
investigate:
sample_rate: 0
Measure without saving sessions
Keeps the charts and the live feed, and saves and exports no session details.
Config
jobs:
- name: shop
allowed_origins:
- https://shop.example.org
investigate:
sample_rate: 0
always_keep: []
Measure a share of a busy site
Measures one browser session in ten, to cut the traffic and the Agent's work on a high-traffic site.
Config
jobs:
- name: shop
allowed_origins:
- https://shop.example.org
- https://*.shop.example.org
measure_sample_rate: 0.1
Hide account IDs in URLs
Replaces account names in paths such as /accounts/acme/settings before anything is stored.
Config
jobs:
- name: shop
allowed_origins:
- https://shop.example.org
redact_paths:
- pattern: '/accounts/[^/]+'
replace: '/accounts/:account'
Send event logs to the local OpenTelemetry plugin
Exports browser events and console messages to the Agent's OpenTelemetry plugin, where they appear in the Logs tab.
Config
jobs:
- name: shop
allowed_origins:
- https://shop.example.org
event_logs:
enabled: true
include_console_logs: true
Send browser traces to a tracing backend
Exports browser request spans to a remote OTLP/gRPC receiver with a token, and adds trace context to API requests.
Config
jobs:
- name: shop
allowed_origins:
- https://shop.example.org
tracing:
enabled: true
propagate_to:
- https://api.example.org
destination:
endpoint: https://traces.example.org:4317
auth_token: ${env:TRACE_EXPORT_TOKEN}
Group a site under a virtual node
Shows the site's charts and alerts under the shop virtual node, which must be defined first.
Config
jobs:
- name: shop
vnode: shop
allowed_origins:
- https://shop.example.org
Alerts
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| rum_lcp_experience_quality | rum.lcp_population | Largest Contentful Paint exceeds its good threshold for more than 25% of recent observed document experiences; critical when more than 25% exceed its poor threshold. Requires at least 30 observations and a complete local population. |
| rum_inp_experience_quality | rum.inp_population | Interaction to Next Paint exceeds its good threshold for more than 25% of recent observed document experiences; critical when more than 25% exceed its poor threshold. Requires at least 30 observations and a complete local population. |
| rum_cls_experience_quality | rum.cls_population | Cumulative Layout Shift exceeds its good threshold for more than 25% of recent observed document experiences; critical when more than 25% exceed its poor threshold. Requires at least 30 observations and a complete local population. |
| rum_events_dropped | rum.otlp | RUM event log delivery failed or records were locally dropped in the last 5 minutes |
| rum_spans_dropped | rum.spans | RUM browser span delivery failed or spans were locally dropped in the last 5 minutes |
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.
Each site has its own charts, under its virtual node when vnode is set and under this Agent's host otherwise.
- Percentile and count charts describe the reports received in the last
window. Each page view counts once per Web Vital, with its latest value; percentiles cannot be averaged across sites or breakdown values. - A vital with no observations in the window leaves a gap in its percentile chart; a measured zero is a real value.
- A page view is a document load or a return from the browser's back-forward cache. Single-page application route changes are application views, and Web Vitals stay with the page view even when reported after a route change.
- Same-site fetch timing covers the fetch and XHR requests the browser reports for the page's own site, not every backend request; the RUM script's own requests are excluded. JavaScript errors are events, so errors per page view is not a failure rate.
- Breakdown charts exist for the busiest values in the window, plus
otherfor the rest (thebucketlabel). - While the receiver is not serving, or
measure_sample_rateis 0, the measurement charts stop; the receiver availability, history and export charts continue. - The event log and span charts exist only while that export is enabled, and the frustration chart only while
capture.frustration_signalsis on.
Per website
One configured website.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.lcp | Largest Contentful Paint among recent observed document experiences | p50, p75, p95 | milliseconds |
| rum.lcp_population | Largest Contentful Paint observed population | observed, good, needs_improvement, poor | observations |
| rum.fcp | First Contentful Paint among recent observed document experiences | p50, p75, p95 | milliseconds |
| rum.fcp_population | First Contentful Paint observed population | observed, good, needs_improvement, poor | observations |
| rum.ttfb | Time to First Byte among recent observed document experiences | p50, p75, p95 | milliseconds |
| rum.ttfb_population | Time to First Byte observed population | observed, good, needs_improvement, poor | observations |
| rum.inp | Interaction to Next Paint among recent observed document experiences | p50, p75, p95 | milliseconds |
| rum.inp_population | Interaction to Next Paint observed population | observed, good, needs_improvement, poor | observations |
| rum.cls | Cumulative Layout Shift among recent observed document experiences | p50, p75, p95 | score |
| rum.cls_population | Cumulative Layout Shift observed population | observed, good, needs_improvement, poor | observations |
| rum.load | Document load time | p50, p75, p95 | milliseconds |
| rum.dom_content_loaded_handler | DOMContentLoaded handler duration | p50, p75, p95 | milliseconds |
| rum.same_site_fetch | Same-site fetch and XHR duration | p50, p75, p95 | milliseconds |
| rum.load_population | Document load time observation population | observed | observations |
| rum.dom_content_loaded_handler_population | DOMContentLoaded handler duration observation population | observed | observations |
| rum.same_site_fetch_population | Same-site fetch and XHR duration observation population | observed | observations |
| rum.document_views | Document views | views | views/s |
| rum.js_errors | JavaScript errors | errors | errors/s |
| rum.observed_sessions | Sessions observed in the window | observed | sessions |
| rum.window_totals | Document views, application views and JavaScript errors in the window | document_views, application_views, js_errors | events |
| rum.frustration | Frustration heuristics | rage_clicks, dead_clicks, error_clicks | signals/s |
| rum.application_views | Explicit application views | views | views/s |
| rum.resources | Reported application resource entries | same_site, cross_site, unknown | entries/s |
| rum.beacons | RUM beacons | accepted, rejected_origin, rejected_rate, rejected_size, invalid, bots | beacons/s |
| rum.otlp | Event log export outcomes | sent, dropped, errors | records/s |
| rum.history | RUM history writes | written, dropped | records/s |
| rum.spans | Browser span export outcomes | sent, dropped, errors | spans/s |
| rum.ingress_state | RUM ingress availability | available, unavailable | state |
| rum.invalid_measurements | Measurements without valid identity or revision | invalid | reports/s |
Per website resource host
One host that served resources to a website's pages, such as a CDN or API domain, among the busiest in the window.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| host | Host that served the resources. |
| bucket | value for a host charted on its own, other for the combined rest, unknown when the browser did not report the host. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.resource_host_p75 | Resource duration by host in the window | p75 | milliseconds |
| rum.resource_host_count | Reported resource entries by host in the window | count | entries |
| rum.resource_host_population | Resource duration population by host | observed | observations |
Per website error group
One group of identical JavaScript errors on a website, among the most frequent in the window.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| fingerprint | Identifier of the error group. |
| message | Error message, cut to 80 characters. |
| bucket | value for a value charted on its own, other for the combined rest. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.error_groups | JavaScript error reports by fingerprint in the window | errors | reports |
Per website browser
One browser used by a website's visitors, among the busiest in the window.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| browser | Browser name, such as Chrome. |
| bucket | value for a value charted on its own, other for the combined rest. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.browser_lcp | LCP by browser among recent observed document experiences | p75 | milliseconds |
| rum.browser_fcp | FCP by browser among recent observed document experiences | p75 | milliseconds |
| rum.browser_ttfb | TTFB by browser among recent observed document experiences | p75 | milliseconds |
| rum.browser_inp | INP by browser among recent observed document experiences | p75 | milliseconds |
| rum.browser_cls | CLS by browser among recent observed document experiences | p75 | score |
| rum.browser_document_views | Document views by browser in the window | views | views |
| rum.browser_js_errors | JavaScript error reports by browser in the window | errors | reports |
| rum.browser_vital_population | Web Vital observation populations by browser | lcp, fcp, ttfb, inp, cls | observations |
Per website device type
One device type of a website's visitors.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| device | Device type - desktop, mobile, tablet or bot. |
| bucket | value for a value charted on its own, other for the combined rest. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.device_lcp | LCP by device among recent observed document experiences | p75 | milliseconds |
| rum.device_fcp | FCP by device among recent observed document experiences | p75 | milliseconds |
| rum.device_ttfb | TTFB by device among recent observed document experiences | p75 | milliseconds |
| rum.device_inp | INP by device among recent observed document experiences | p75 | milliseconds |
| rum.device_cls | CLS by device among recent observed document experiences | p75 | score |
| rum.device_document_views | Document views by device in the window | views | views |
| rum.device_js_errors | JavaScript error reports by device in the window | errors | reports |
| rum.device_vital_population | Web Vital observation populations by device | lcp, fcp, ttfb, inp, cls | observations |
Per website country
One country of a website's visitors, among the busiest in the window. Requires geolocation.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| country | Two-letter country code. |
| bucket | value for a value charted on its own, other for the combined rest. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.country_lcp | LCP by country among recent observed document experiences | p75 | milliseconds |
| rum.country_fcp | FCP by country among recent observed document experiences | p75 | milliseconds |
| rum.country_ttfb | TTFB by country among recent observed document experiences | p75 | milliseconds |
| rum.country_inp | INP by country among recent observed document experiences | p75 | milliseconds |
| rum.country_cls | CLS by country among recent observed document experiences | p75 | score |
| rum.country_document_views | Document views by country in the window | views | views |
| rum.country_js_errors | JavaScript error reports by country in the window | errors | reports |
| rum.country_vital_population | Web Vital observation populations by country | lcp, fcp, ttfb, inp, cls | observations |
Per website page
One page of a website, as its path with IDs replaced, among the busiest in the window.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| page | Page path, with IDs replaced. |
| bucket | value for a value charted on its own, other for the combined rest. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.page_lcp | LCP by page among recent observed document experiences | p75 | milliseconds |
| rum.page_fcp | FCP by page among recent observed document experiences | p75 | milliseconds |
| rum.page_ttfb | TTFB by page among recent observed document experiences | p75 | milliseconds |
| rum.page_inp | INP by page among recent observed document experiences | p75 | milliseconds |
| rum.page_cls | CLS by page among recent observed document experiences | p75 | score |
| rum.page_document_views | Document views by page in the window | views | views |
| rum.page_js_errors | JavaScript error reports by page in the window | errors | reports |
| rum.page_vital_population | Web Vital observation populations by page | lcp, fcp, ttfb, inp, cls | observations |
Per website application version
One application version of a website, as set by data-version on the script tag, among the busiest in the window.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| version | Application version. |
| bucket | value for a value charted on its own, other for the combined rest. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.version_lcp | LCP by version among recent observed document experiences | p75 | milliseconds |
| rum.version_fcp | FCP by version among recent observed document experiences | p75 | milliseconds |
| rum.version_ttfb | TTFB by version among recent observed document experiences | p75 | milliseconds |
| rum.version_inp | INP by version among recent observed document experiences | p75 | milliseconds |
| rum.version_cls | CLS by version among recent observed document experiences | p75 | score |
| rum.version_document_views | Document views by version in the window | views | views |
| rum.version_js_errors | JavaScript error reports by version in the window | errors | reports |
| rum.version_vital_population | Web Vital observation populations by version | lcp, fcp, ttfb, inp, cls | observations |
Per website application view
One application view (route) of a website, among the busiest in the window.
Labels:
| Label | Description |
|---|---|
| display_name | The site's display_name, when it differs from the site key. |
| view | Application view name. |
| bucket | value for a value charted on its own, other for the combined rest. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| rum.view_activity | Explicit application views and error reports in the window | views, errors | events |
Live Data
These Functions show each site's setup and status, its recent activity, and the saved session history. They serve every site on the Agent and are available while it has an active site or saved RUM history, so history stays readable after a site is removed.
Viewing them requires a signed-in member of the node's Netdata Cloud Space with permission to view sensitive data, on a paid plan or an active trial. Reports are received and history is kept on every plan.
To narrow the results to one virtual node, pass vnode with its configured name, or vnode_guid with its GUID for a
virtual node that was renamed or removed. Pass site for one site.
The plugin-wide dem-history-status Function covers the history that RUM and synthetic monitoring share. It is
available whenever the plugin runs, needs the same access and takes no parameters. It shows the retention in
effect (history in dem.conf), how much disk the history files use, and the latest cleanup, write or
configuration reload error.
RUM Sites
The setup and status of each site - the script tag to install, the allowed origins, the sampling and capture settings, and recent traffic, including the last accepted report and the last refused origin. Start here when a site shows no data.
| Aspect | Description |
|---|---|
| Name | Rum-sites |
| Require Cloud | yes |
| Performance | Reads the sites' current state in memory. Contacts no website. |
| Security | Shows site settings, origins and traffic counts. |
| Availability | While the Agent has an active site or saved RUM history. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
Virtual node name (vnode) | string | Only sites of the configured virtual node with this name. An empty or unknown name is an error. Do not combine with vnode_guid. | no | ||
Virtual node GUID (vnode_guid) | string | Only data recorded under the virtual node with this GUID. Do not combine with vnode. | no | ||
Site (site) | string | Only this site, by its site key. | no |
Returns
One row per active site. The response also shows whether the receiver is serving, its public URL and the state
of its location database (collector.geoip). In that object, selection is auto (empty geoip_db) or
explicit, state is loaded, unavailable or using_previous, source is cache, stock or
explicit, database_type is the database's declared type, and reason explains a missing database
without paths (the Agent log has the details). lookup_errors counts failed lookups, not unmatched addresses, and
loaded does not mean the database is current or complete. Its times (build_at, loaded_at,
last_checked_at) are Unix microseconds.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| site | string | Site key. | ||
| name | string | Display name, or the site key. | ||
| generation | string | Identifier of the running site job. It changes when the job restarts. | ||
| collection_enabled | boolean | Whether measure_sample_rate is above 0, whatever the receiver's state. | ||
| script_url | string | URL of the site's script. Null until the receiver or the site has a public_url. | ||
| snippet | string | Script tag to add to the website. Null until the receiver or the site has a public_url. | ||
| allowed_origins | string | Origins the site accepts reports from. | ||
| beacons_per_min | integer | Reports accepted in the last minute. | ||
| last_beacon_at | timestamp | When the last report was accepted. Null when none since the job started. | ||
| last_beacon_age_s | integer | Seconds since the last accepted report. | ||
| observed_sessions | integer | Browser sessions seen in the window, not people or concurrent visitors. Null while collection is off or the receiver is not serving. | ||
| pageviews_window | integer | Page views in the window. | ||
| js_errors_window | integer | JavaScript errors in the window. | ||
| rejected_per_min | integer | Reports refused in the last minute for origin, rate or size. | ||
| measured | string | Current collection rate, from measure_sample_rate. | ||
| investigated | string | Current share of sessions saved with details, from investigate. | ||
| investigated_sessions | integer | Sessions currently tracked for saving. | ||
| bots_per_min | integer | Reports from automated browsers dropped in the last minute. | ||
| last_rejected_origin | string | Last origin whose reports were refused. Check it before adding it to allowed_origins. | ||
| last_rejected_at | timestamp | When that origin was refused. | ||
| last_rejected_age_s | integer | Seconds since that origin was refused. | ||
| capture_geolocation | string | Current capture.geolocation setting. | ||
| capture_frustration_signals | boolean | Current capture.frustration_signals setting. | ||
| application_views_window | integer | Application views in the window. | ||
| vnode_guid | string | GUID of the virtual node the data was recorded under. Empty when it had none. |
RUM Pages
Every page of each site seen in the window, with its traffic, Web Vital p75 values and the page elements most often involved in poor LCP, INP and CLS. It lists all pages, not only the busiest ones that get breakdown charts.
| Aspect | Description |
|---|---|
| Name | Rum-pages |
| Require Cloud | yes |
| Performance | Reads the sites' current measurements in memory. Contacts no website. |
| Security | Shows page paths and page element selectors. |
| Availability | While the Agent has an active site or saved RUM history. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
Virtual node name (vnode) | string | Only sites of the configured virtual node with this name. An empty or unknown name is an error. Do not combine with vnode_guid. | no | ||
Virtual node GUID (vnode_guid) | string | Only data recorded under the virtual node with this GUID. Do not combine with vnode. | no | ||
Site (site) | string | Only this site, by its site key. | no |
Returns
One row per site and page. A vital without observations is null.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| site | string | Site key. | ||
| page | string | Page path, with IDs replaced. | ||
| pageviews_window | integer | Page views in the window. | ||
| sessions | integer | Browser sessions that viewed the page in the window. | ||
| lcp_p75_ms | integer | Largest Contentful Paint, p75, in milliseconds. | ||
| inp_p75_ms | integer | Interaction to Next Paint, p75, in milliseconds. | ||
| cls_p75 | float | Cumulative Layout Shift, p75. | ||
| errors_window | integer | JavaScript errors in the window. | ||
| lcp_element | string | Page element most often involved in poor LCP, or in any LCP when none was poor. | ||
| inp_element | string | Page element most often involved in poor INP, or in any INP when none was poor. | ||
| cls_element | string | Page element most often involved in poor CLS, or in any CLS when none was poor. | ||
| frustration_window | integer | Frustration signals in the window. Null when they are not collected. | ||
| row_id | string | hidden | Stable row identifier. | |
| lcp_samples | integer | LCP observations behind the p75. | ||
| inp_samples | integer | INP observations behind the p75. | ||
| cls_samples | integer | CLS observations behind the p75. | ||
| vnode_guid | string | GUID of the virtual node the data was recorded under. Empty when it had none. |
RUM Live
The most recent events of each site as they arrive - page views, application views, Web Vital reports and errors, with page, browser, device and location. Pass the next value of a response as cursor to get only newer events.
| Aspect | Description |
|---|---|
| Name | Rum-live |
| Require Cloud | yes |
| Performance | Reads recent events from memory, up to 2000 per request. Contacts no website. |
| Security | Shows page paths, browsers, devices, locations and error messages of visitors. |
| Availability | While the Agent has an active site or saved RUM history. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
Virtual node name (vnode) | string | Only sites of the configured virtual node with this name. An empty or unknown name is an error. Do not combine with vnode_guid. | no | ||
Virtual node GUID (vnode_guid) | string | Only data recorded under the virtual node with this GUID. Do not combine with vnode. | no | ||
Site (site) | string | Only this site, by its site key. | no | ||
Cursor (cursor) | string | The next value of the previous response, unchanged. Empty returns the most recent events. The cursor keeps a position for each site, so a busy site never skips a quiet site's events; a site whose job restarted or was replaced starts a new stream, from that job's first events. | no |
Returns
One row per event, up to 2000 per request. Each site keeps its last 5,000 events in memory. A Web Vital can be reported more than once for the same page view; later reports update it.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| seq | string | Event ID. | ||
| ts | timestamp | When the receiver got the event. | ||
| site | string | Site key. | ||
| country | string | Visitor's country. | ||
| city | string | Visitor's approximate city, with capture.geolocation: city. | ||
| lat | float | Approximate latitude, with capture.geolocation: city. | ||
| lon | float | Approximate longitude, with capture.geolocation: city. | ||
| page | string | Page path, with IDs replaced. | ||
| browser | string | Browser name. | ||
| device | string | Device type. | ||
| pageview | integer | 1 for a page view. | ||
| lcp_ms | float | Largest Contentful Paint, in milliseconds. | ||
| inp_ms | float | Interaction to Next Paint, in milliseconds. | ||
| fcp_ms | float | First Contentful Paint, in milliseconds. | ||
| ttfb_ms | float | Time to First Byte, in milliseconds. | ||
| cls | float | Cumulative Layout Shift. | ||
| errors | integer | JavaScript errors. | ||
| kind | string | Event type, such as a page view, application view, Web Vital or error. | ||
| experience_id | string | Page view the event belongs to. | ||
| view | string | Application view at the time of the event. | ||
| view_id | string | Application view occurrence the event belongs to. | ||
| vital | string | Web Vital that a vital event reports. | ||
| metric_id | string | Identifier of the reported Web Vital measurement. | ||
| revision | integer | Report number of that measurement; a higher number replaces a lower one. | ||
| vnode_guid | string | GUID of the virtual node the data was recorded under. Empty when it had none. |
RUM Sessions
The saved sessions with activity in a time range (the last 15 minutes by default), with their pages, errors, browser, device, country and application version. Find a user's sessions with user_id, then open a session's timeline.
| Aspect | Description |
|---|---|
| Name | Rum-sessions |
| Require Cloud | yes |
| Performance | Reads the saved history from disk; wider time ranges and busier sites take longer. Contacts no website. |
| Security | Shows user IDs, page paths, browsers, devices and countries of visitors. |
| Availability | While the Agent has an active site or saved RUM history. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
Virtual node name (vnode) | string | Only sites of the configured virtual node with this name. An empty or unknown name is an error. Do not combine with vnode_guid. | no | ||
Virtual node GUID (vnode_guid) | string | Only data recorded under the virtual node with this GUID. Do not combine with vnode. | no | ||
Site (site) | string | Only this site, by its site key. | no | ||
User ID (user_id) | string | Only sessions in which the application set this user ID during the time range. The match is exact, on the ID as stored after DEM shortens or masks it, so a displayed [REDACTED] value cannot be used to look a user up. | no | ||
Received after (after) | integer | Start of the time range, in Unix seconds, or seconds before now when negative (-3600 for the last hour). | no | 15 minutes before before | |
Received before (before) | integer | End of the time range, in Unix seconds, or seconds before now when negative. | no | now |
Returns
One row per session, most recently active first, up to 2000; the response sets truncated when more match. Counts and times cover the session's activity inside the time range, not its whole life.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| site | string | Site key. | ||
| session_id | string | Session ID. | ||
| started_age_s | integer | Seconds since the session's first activity in the range. | ||
| duration_s | integer | Seconds between the session's first and last activity in the range. | ||
| pageviews | integer | Page views. | ||
| errors | integer | JavaScript errors. | ||
| browser | string | Browser name. | ||
| device | string | Device type. | ||
| country | string | Visitor's country. | ||
| version | string | Application version. | ||
| entry_page | string | First page in the range. | ||
| last_page | string | Last page in the range. | ||
| user_ids | array | User IDs the application set. | ||
| frustrations | integer | Frustration signals. | ||
| row_id | string | hidden | Stable row identifier. | |
| application_views | integer | Application views. | ||
| last_observed_us | timestamp | When the session was last active in the range. | ||
| vnode_guid | string | GUID of the virtual node the data was recorded under. Empty when it had none. |
RUM Errors
JavaScript errors of saved sessions in a time range (the last 15 minutes by default), grouped by fingerprint, with counts and a sample stack. Select a fingerprint to see how many sessions it affected, its top page and the browsers it occurs in.
| Aspect | Description |
|---|---|
| Name | Rum-errors |
| Require Cloud | yes |
| Performance | Reads the saved history from disk; wider time ranges and busier sites take longer. Contacts no website. |
| Security | Shows error messages, stack traces and page paths, which can contain sensitive text. |
| Availability | While the Agent has an active site or saved RUM history. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
Virtual node name (vnode) | string | Only sites of the configured virtual node with this name. An empty or unknown name is an error. Do not combine with vnode_guid. | no | ||
Virtual node GUID (vnode_guid) | string | Only data recorded under the virtual node with this GUID. Do not combine with vnode. | no | ||
Site (site) | string | Only this site, by its site key. | no | ||
Fingerprint (fingerprint) | string | Error group to analyze in detail. Empty lists all groups. | no | ||
Received after (after) | integer | Start of the time range, in Unix seconds, or seconds before now when negative (-3600 for the last hour). | no | 15 minutes before before | |
Received before (before) | integer | End of the time range, in Unix seconds, or seconds before now when negative. | no | now |
Returns
One row per site and error group. The affected sessions, top page and browsers are filled in only for the selected fingerprint.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| site | string | Site key. | ||
| fingerprint | string | Error group identifier. | ||
| type | string | Error type. | ||
| message | string | Error message. | ||
| count_window | integer | Occurrences in the time range. | ||
| sessions_affected | integer | Sessions with the error, for the selected fingerprint. | ||
| first_seen_age_s | integer | Seconds since the first occurrence in the range. | ||
| last_seen_age_s | integer | Seconds since the last occurrence in the range. | ||
| top_page | string | Page where the error occurs most, for the selected fingerprint. | ||
| browsers | string | Browsers the error occurs in, for the selected fingerprint. | ||
| sample_stack | string | Stack trace of one occurrence. | ||
| row_id | string | hidden | Stable row identifier. | |
| vnode_guid | string | GUID of the virtual node the data was recorded under. Empty when it had none. |
RUM Session Events
The timeline of one session - its page views, application views, errors and other events in order, including events not yet saved, with the trace ID of traced requests.
| Aspect | Description |
|---|---|
| Name | Rum-session-events |
| Require Cloud | yes |
| Performance | Reads one session from disk and memory. Contacts no website. |
| Security | Shows user IDs, page paths and error messages of one visitor's session. |
| Availability | While the Agent has an active site or saved RUM history. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
Virtual node name (vnode) | string | Only sites of the configured virtual node with this name. An empty or unknown name is an error. Do not combine with vnode_guid. | no | ||
Virtual node GUID (vnode_guid) | string | Only data recorded under the virtual node with this GUID. Do not combine with vnode. | no | ||
Site (site) | string | The session's site key. Needed when the same session ID exists on several sites. | no | ||
Session (session_id) | string | Session ID, from rum-sessions. | yes |
Returns
One row per event, oldest first, for the whole saved session regardless of time range. An unknown session returns an error.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| ts | timestamp | When the receiver got the event. | ||
| type | string | Event type. | ||
| page | string | Page path, with IDs replaced. | ||
| text | string | Event details, such as the error message. | ||
| trace_id | string | Trace ID of a traced request. | ||
| user_id | string | User ID the application had set at the time. | ||
| experience_id | string | Page view the event belongs to. | ||
| view | string | Application view at the time of the event. | ||
| view_id | string | Application view occurrence the event belongs to. | ||
| metric_id | string | Identifier of the reported Web Vital measurement. | ||
| revision | integer | Report number of that measurement. | ||
| vnode_guid | string | GUID of the virtual node the data was recorded under. Empty when it had none. |
Troubleshooting
Known Errors
opening DEM history: load journal identity: journalhost: machine id: no machine id found
When
The Agent's log shows this when dem.plugin starts on Linux. The plugin then exits, so no DEM job runs,
whichever modules are enabled.
Cause
DEM keeps its history in journal files, which need the host's machine ID, and none was found. Neither
/etc/machine-id nor /var/lib/dbus/machine-id holds a valid ID, and neither file exists under the
Netdata host prefix (/host in the official Docker image). This is common in minimal containers.
Fix
On a host, create the machine ID with sudo systemd-machine-id-setup (or
sudo dbus-uuidgen --ensure=/etc/machine-id without systemd), then restart the Agent.
In the official Docker image, mount the host's machine ID under the Netdata host prefix: add
-v /etc/machine-id:/host/etc/machine-id:ro to docker run, or the same mount under volumes: in Docker
Compose, then recreate the container. Check first that the host has /etc/machine-id: Docker creates a
missing source path as an empty directory, which DEM rejects.
Netdata RUM: cannot load the core SDK. Check the browser Network and CSP errors for the RUM script requests.
Cause
The browser console shows this when the page cannot load the SDK from the receiver: the reverse proxy does not forward the whole /rum/ path, or the page's Content Security Policy blocks the receiver's address.
Fix
Check the failing request in the browser's Network panel. Forward every path under /rum/ to the receiver, and allow the receiver's address in script-src and connect-src. If several Agents answer for the same public address, run the same Agent version on all of them, so each serves the SDK files the script refers to.
Netdata RUM: cannot load the tracing SDK. Check the browser Network and CSP errors for the RUM script requests.
When
tracing is enabled for the site.
Cause
The page could not load the tracing bundle from the receiver, for the same reasons as the core SDK. RUM keeps working without browser spans.
Fix
Check the failing request in the browser's Network panel. Forward every path under /rum/ to the receiver, and allow the receiver's address in the page's Content Security Policy.
Netdata RUM: cannot determine receiver URL. Use the external script tag from RUM setup.
Cause
The script's contents were pasted into the page, or a tag manager runs them as code, instead of loading them with an external script tag.
Fix
Add the <script async src=...> tag that rum-sites shows. In a tag manager, insert that tag rather than its contents.
Netdata RUM: SDK initialization failed. Check the browser console and site script policy.
Cause
The SDK loaded but could not start, usually because the page's script policy (Content Security Policy or Trusted Types) blocks it.
Fix
Read the browser console errors logged just before this message and adjust the page's policy for the receiver's scripts.
The collect request or its OPTIONS request returns 403
Cause
The page's origin is not in allowed_origins. Scheme, host and port must match, and *.example.org does not cover example.org itself. A refused OPTIONS (preflight) request stops the browser from sending the report.
Fix
rum-sites shows the last refused origin, which can come from a preflight and stays after later reports succeed. If it is your website, add it to allowed_origins.
The collect request returns 400
Cause
The request body is not a valid RUM report. It was cut off or changed on the way, for example by a proxy, or it was not sent by the RUM script.
Fix
Check that the reverse proxy forwards the request body unchanged, and that the page uses the script tag rum-sites shows.
The script or collect request returns 404
Cause
The receiver has no running site job with the key in the URL: the job is disabled or failed to start, its name differs from the key in the script tag, or the reverse proxy changes the path.
Fix
Check the job's status, and that the URL path is /rum/ followed by the site key, exactly as in the script tag from rum-sites.
The collect request returns 429
Cause
A rate limit of the receiver was reached. Behind a reverse proxy without trusted_proxies, every visitor appears to come from the proxy's address and shares one per-client limit (120 requests per minute by default).
Fix
Set trusted_proxies on the receiver to the proxy's address. If traffic is legitimately higher, raise rate_limit on the receiver.
The collect request returns 413
Cause
The report is larger than the receiver's max_body_bytes (256 KiB by default).
Fix
Raise max_body_bytes on the receiver.
The collect request returns 204 and nothing is measured
Cause
The request was excluded on purpose: it came from an automated or headless browser while bots is exclude, or measure_sample_rate is 0.
Fix
Test with a regular browser, or set bots: include to measure automated traffic as device bot.
The script loads but no collect request is sent
Cause
The browser session was not sampled (measure_sample_rate below 1), or the browser is automated and bots is exclude, so nothing is sent.
Fix
For a reliable check, set measure_sample_rate: 1 and open the website in a new private window of a regular browser.
rum/otlp: site "shop" logs export failed: Unavailable
When
Event logs or tracing are enabled. The message is in the Agent's log, at most once a minute per site, signal and status.
Cause
Event logs (logs) or browser spans (traces) could not be delivered to their destination. The last word is the gRPC status: Unavailable means the receiver cannot be reached, Unauthenticated or PermissionDenied means the token was refused.
Fix
Check the destination's endpoint, auth_token and TLS settings, and that the receiver is running (for the default destination, the Agent's OpenTelemetry plugin). The rum.otlp and rum.spans charts and their alerts show delivery failures and dropped records.
rum/otlp: site "shop" logs partial rejection: N
Cause
The destination accepted the export but rejected N of its records.
Fix
Check the destination's own logs for why it rejected them.
allowed origin "https://shop.example.org/home" must be http(s)://host[:port]
Cause
An allowed_origins entry has a path, query, credentials or a scheme other than http or https.
Fix
Keep only the scheme, host and optional port, such as https://shop.example.org.
origin wildcard is only allowed as a leading *.
Cause
An allowed_origins entry uses * somewhere other than as the first label, such as https://shop.*.org.
Fix
Use a leading wildcard, such as https://*.example.org, or list the origins.
name must be a nonempty URL-safe site key: letters, digits, underscores or hyphens
Cause
The site key contains spaces, dots or other characters, or starts with an underscore or hyphen.
Fix
Use letters, digits, underscores and hyphens, starting with a letter or digit, such as shop or shop-eu.
allowed_origins is required
Cause
The site job lists no origins.
Fix
Add the origins the website is served from, such as https://shop.example.org.
page_groups and countries must be between 1 and 100
Cause
page_groups or countries is outside 1 to 100.
Fix
Use a value from 1 to 100, or remove the option to use the default of 20.
bots must be exclude or include
Cause
bots has another value.
Fix
Use exclude or include.
measure_sample_rate must be between 0 and 1
Cause
measure_sample_rate is negative or above 1. A percentage such as 50 is not accepted.
Fix
Use a share from 0 to 1, such as 0.5.
redact_paths pattern "/accounts/[^/" is not a valid regular expression
Cause
A redact_paths pattern is not a valid regular expression in Go syntax.
Fix
Fix the pattern, for example /accounts/[^/]+. Quote it in single quotes in YAML.
tracing.propagate_to entry https://api.example.org/v1 must be http(s)://host[:port] with port 1-65535
Cause
A tracing.propagate_to entry has a path, query or credentials, or is not an http or https origin.
Fix
List origins only, such as https://api.example.org.
capture.geolocation must be off, country or city
Cause
The value is not one of off, country and city. Unquoted off in YAML is read as a boolean.
Fix
Write geolocation: 'off' with quotes, or use country or city.
window must be between 1m and 30m
Cause
window is shorter than one minute or longer than 30 minutes.
Fix
Use a duration such as 5m.
event_logs.destination.endpoint must be http(s)://host:port with port 1-65535
Cause
The event log destination has no port, has a path, or uses another scheme. The same message starts with tracing.destination for traces.
Fix
Use http://host:port or https://host:port, such as http://127.0.0.1:4317.
event_logs.destination.TLS options require an https endpoint
Cause
tls_ca, tls_cert or tls_key is set for an http:// destination. The same message starts with tracing.destination for traces.
Fix
Use an https:// endpoint, or remove the TLS settings.
event_logs.destination: invalid TLS material: could not read certificate "/etc/netdata/ssl/otlp-ca.pem": open "/etc/netdata/ssl/otlp-ca.pem": permission denied
Cause
The Netdata service account cannot read a TLS file of the destination. A client key gives could not read key instead, and traces give the same message starting with tracing.destination.
Fix
Check the path, and make the file readable by the Netdata service account (usually netdata).
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.