Enabling RUM with Node.js
  • 08 Jan 2021
  • 1 Minute To Read
  • Contributors
  • Print
  • Share
  • Dark
    Light

Enabling RUM with Node.js

  • Print
  • Share
  • Dark
    Light

This document details how to enable RUM for the APM Profiler in your Node.js application running on Linux or Windows.

Prerequisites

1. Install the Agent

Required Agent Versions
  • Windows Agent v4.29.29+
  • Linux Agent v2.30.10+
  • Node.js Profiler 1.14.0+

2. Enable RUM and Implement the JavaScript Snippet

Follow the RUM Getting Started guide to Enable RUM on your account and Implement the JavaScript Snippet into the HTML of the application.

3. Setup APM for your Application

Follow the Node.js Getting Started Guide to configure the profiler for your specific setup. The profiler will need to be properly configured for RUM to function.

4. Redeploy your App

Once the previous steps to enable RUM for your account and add the code snippet to your app(s) have been completed, the last step is to deploy the changes to your application.

Disabling the RUM Cookie

By default, the profiler generates a cookie used by RUM to calculate page timings on your monitored applications. In rare edge case scenarios, this cookie can cause issues with page caching. If you experience this, follow the steps below to disable the RUM cookie.

You will need to add the following argument to the file where the Application Name and Environment Name values are configured:

rum_enabled: false

Example:

---
application_name: 'Node Application',
environment_name: 'Production',
rum_enabled: false

Viewing RUM Data

Once the following steps have been taken to set up RUM for your apps, data will be reported in the corresponding App Dashboard. To see more information related to what RUM data is presented in the App Dashboard, see the Viewing RUM Data in Retrace help doc.

Was This Article Helpful?