Skip to content

Custom Addition of Action

After initializing RUM, use the addAction('<NAME>', '<JSON_OBJECT>') API to add custom Action metric data outside of the collected data.

Adding an Action

Download file and introduce it locally.

const { datafluxRum } = require('./lib/dataflux-rum-miniapp.js')
datafluxRum.addAction('<NAME>', '<JSON_OBJECT>');

// Code example
datafluxRum && datafluxRum.addAction('cart', {
    amount: 42,
    nb_items: 2,
    items: ['socks', 't-shirt'],
});

Introduction

const { datafluxRum } = require('@cloudcare/rum-miniapp')
datafluxRum.addAction('<NAME>', '<JSON_OBJECT>');

// Code example
datafluxRum && datafluxRum.addAction('cart', {
    amount: 42,
    nb_items: 2,
    items: ['socks', 't-shirt'],
});

How to Add Custom Actions Using the RUM SDK and Avoid Field Conflicts

When using window.DATAFLUX_RUM.addAction to add custom data, be cautious to avoid conflicts with pre-defined fields in the SDK. Conflicting fields can result in the data not being set correctly. Below is an incorrect example and some precautions:

Example code (with field conflict)

window.DATAFLUX_RUM.addAction('test action', {
  view_url: 'a', // Conflicts with the pre-defined SDK field "view_url", causing this field to be ignored.
  b: 'b',
  c: 'c',
})

Improved code and explanation

You can avoid conflicts by not using the same names as the pre-defined SDK fields and instead opting for custom field names or prefixes:

// Recommended way to name custom fields to avoid conflicts
window.DATAFLUX_RUM.addAction('test action', {
  custom_view_url: 'a', // Use a custom field name to avoid conflict with the SDK
  b: 'b',
  c: 'c',
})

Precautions

  1. Field naming principles: • Avoid using pre-defined SDK fields (such as view_url, view_name, etc.). These fields may be used internally by the SDK, leading to conflicts. • Add prefixes (like custom_, user_) to distinguish custom data.
  2. Impact of field conflicts: • If there is a field name conflict, the SDK will ignore the custom value for that field. • It is crucial to check for field name conflicts when the required data is not being passed correctly.

Below is a list of reserved fields:

[
  "sdk_name",
  "sdk_version",
  "app_id",
  "env",
  "service",
  "version",
  "source",
  "userid",
  "user_email",
  "user_name",
  "session_id",
  "session_type",
  "session_sampling",
  "is_signin",
  "os",
  "os_version",
  "os_version_major",
  "browser",
  "browser_version",
  "browser_version_major",
  "screen_size",
  "network_type",
  "device",
  "view_id",
  "view_referrer",
  "view_url",
  "view_host",
  "view_path",
  "view_name",
  "view_path_group",
  "view_url_query",
  "action_id",
  "action_ids",
  "view_in_foreground",
  "display",
  "session_has_replay",
  "is_login",
  "page_states",
  "session_sample_rate",
  "session_replay_sample_rate",
  "drift",
  "action_type",
  "action_name",
  "duration",
  "action_error_count",
  "action_resource_count",
  "action_frustration_types",
  "action_long_task_count",
  "action_target",
  "action_position"
]

Feedback

Is this page helpful? ×