Skip to content

RUM Headless

RUM is used to collect Real User Monitoring data reported from web pages or mobile apps. After successfully activating RUM Headless, it will be automatically deployed on the cloud hosts of Guance, completing a series of operations such as DataKit installation and RUM Collector deployment.

Note

To activate the RUM Headless platform, you need to contact the Billing Center to enable the whitelist channel. You need to contact your Account Manager and provide the site and ID of your workspace.

One-click Activation

Go to Integrations > RUM Headless or Integrations > Extensions > RUM Headless and click to enter the activation process:

Permissions and Charges
  • Only one instance can be activated per workspace, and only the Owner has the permission to activate and configure.
  • RUM Headless is charged monthly. The fee for one month is deducted once upon successful activation, and the fee for the next month is automatically deducted one day before the expiration date (e.g., if you activate on 04/13, the fee is deducted on 04/12, and then on 05/12, and so on...).
  1. Click Activate;
  2. Fill in the HTTP service address;
  3. Select the required specifications;
  4. Click Activate immediately.
Note

HTTP service address: This is the HTTP service address of DataKit, through which external data is received. It needs to be filled in when connecting the application.

The automated deployment process is expected to take 10–15 minutes. After activation, you can directly enter the console from Integrations > Func > Extensions. Click Configuration > Overview to view the related information of RUM Headless.

After RUM Headless is activated, if you need to modify the configuration, refer to the following content.

Modify the Service Address

  1. Click Modify;
  2. Obtain and enter the email verification code;
  3. Confirm to complete identity verification, then you can modify the current HTTP service address.
Note

The service address can be modified up to 3 times per day.

Modify the Specifications

  1. Click Modify;
  2. Obtain and enter the email verification code;
  3. Confirm to complete identity verification, then you can modify the current specifications.
Note

After the specification is modified, it takes effect immediately on the same day, and charges will be based on the new specifications. The old specifications will be discarded and no refund will be issued.

Sourcemap Configuration

Sourcemap (source map) is used to map compressed code in the production environment back to the original source code.

When uploading files, select the application type, configure the Sourcemap after packaging, then drag and drop or click to upload.

Below the 🔍 bar, you can view the uploaded file names and application types. You can search by entering the file name; click to delete the current file.

Upload Notes
  • The file size must not exceed 500 MB;
  • The file format must be .zip;
  • The file naming format is <app_id>-<env>-<version>, where app_id is required. If the format is incorrect, the file will not take effect. Ensure that the extracted file paths in the zip archive match the URL paths in error_stack;
  • Multiple files cannot be uploaded simultaneously;
  • Uploading a file with the same name will prompt an overwrite warning, please note.

Status

On the RUM Headless configuration page, you can view the current application status.

Your application may have the following five statuses:

Status Description
Activating Indicates that the one-click activation of RUM Headless is in progress.
Activated Indicates that the one-click activation of RUM Headless is complete.
Plan Changing Indicates that the service address or specifications are being modified.
Upgrading Indicates that the current application service is being upgraded.
Operation Failed Indicates that there is an operational issue during the activation process. You can view the error feedback or directly contact us.

Application Expiration

Three days before the application expiration and deduction, the system will check whether the balance is sufficient for renewal. If the balance is insufficient, the system will send an email and system notification to the workspace Owner.

If you have used RUM Headless before, reactivating the application before its expiration can restore all data from the application. If you fail to renew before the expiration, the data will be permanently deleted. The system will retain the most recent 7 days of data. Within these 7 days, if you choose to activate the application again, you can choose to restore all data or not restore any data.

  • Restore data: Backup the previously retained data to the newly activated RUM.
  • Do not restore data: Discard all previous data and reactivate the application.

Deactivate the Application

If you need to deactivate the current application service, click Deactivate Application, complete identity verification, and the confirmation page will open. You can view the application expiration date.

RUM Headless adopts a monthly billing model. Before the billing expires, you can still use the RUM service and can optionally reactivate RUM Headless as needed.

Feedback

Is this page helpful?