RUM OpenTelemetry Assets

Use this package to get a dashboard which displays metrics from your web applications instrumented by Opentelemetry JS SDK. The metrics diplayed are:

• page load and visits: these metrics are calculated from the telemetry captured by NavigationTimingInstrumentation within @opentelemetry/browser-instrumentation package. For backwards compatibility it also queries for data collected by @opentelemetry/instrumentation-document-load instrumentation.
• errors: the top errors are calculated from the telemetry captured by ErrorsInstrumentation within @opentelemetry/browser-instrumentation package. For backwards compatibility it also queries for data collected by @opentelemetry/instrumentation-web-exception instrumentation.
• web vitals: the web vitals are calculated from the telemetry captured by WebVitalsInstrumentation within @opentelemetry/browser-instrumentation package.

You should have all instrumentations enabled in your web application to get the metrics populated in this dashboard.

This package has been tested with OpenTelemetry Browser SDK 0.3.0 and with OpenTelemetry semantic conventions 1.38.0. It should work with later versions as long as there are no breaking changes in browser.* namespace of semantic conventions.

This package requires that your log record and trace exports contain a resource attribute named user_agent.original as defined in semantic conventions. Such field is used to resolve which browser and OS the data is coming from.

This package will show metrics only if you are monitoring web applications with OpenTelemetry JS SDK. If you are new to OpenTelemetry RUM you can check the guide on how to start with the Elastic stack.

1. In the top search bar in Kibana, search for Dashboards.
2. In the search bar, type RUM OTel.
3. Select a dashboard for the dataset you are collecting, and verify the dashboard information is populated.

If you do not see data in the dashboard make sure that:

• Elastic search has recevied the documents from Opentelemetry JS SDK. You can search for them in discover with the filter telemetry.sdk.language : "webjs"
• You can run more detailed searches to ensure the data is available for specific sections of the dashboard:
  • use the filter scope.name : "@opentelemetry/instrumentation-document-load" or scope.name : "@opentelemetry/browser-instrumentation/navigation-timing" to check if the data for page load metrics is present.
  • use the filter scope.name : "@opentelemetry/instrumentation-web-exception" or scope.name : "@opentelemetry/browser-instrumentation/errors" to check if the data for error metrics is present.
  • use the filter scope.name : "@opentelemetry/browser-instrumentation/web-vitals" to check if the data for web vitals metrics is present.
  • use the filter resource.attributes.user_agent.original : * to check if the logs/traces contain the right resource attribute.

This integration includes one or more Kibana dashboards that visualizes the data collected by the integration. The screenshots below illustrate how the ingested data is displayed.