Type Alias dtrum

Sets the name of the currently active action, or the action corresponding to the provided ID.

Attaches a listener that is called while entering an action.
Remove the listener if not needed, or filter actions using addActionProperties to prevent sending the same action property for every action. Use this method to hook into the automatic action creation event to influence related concepts such as action naming or action properties.

Attaches a listener that is called when leaving an action.
Remove the listener if not needed, or filter actions using addActionProperties to prevent sending the same action property for every action. Use this method to hook into the out-of-the-box action closing event.

Indicates the start of a user input. Every user input must be concluded by calling endUserInput. RUM JavaScript checks for an active user input when an XHR call or a page load occurs. If a user input is active, that input is marked as having triggered the user action. Use this method when a user input is not automatically detected by RUM JavaScript.

Ends a user input that was started with beginUserInput.

Enters a new custom action. Use this method to create a custom action.
This method must be called before leaveAction, which closes the custom action.

Extends or initiates actions. Use this method when you want to extend an active Load or XHR action with an unlinked XHR call, i.e., an action. It is particularly useful when the XHR call is asynchronous and cannot be automatically correlated with an action, which might otherwise cause the action to close prematurely, leading to inaccurate metrics (such as user action duration). This method must be called before leaveXhrAction.

Indicates that an XHR callback is active (e.g., XMLHttpRequest onreadystatechange) and links subsequently triggered XHR actions to this callback. For example, if an XHR callback adds a script tag to your page and triggers another XHR call, that call would not automatically be added to the current action. Calling this method allows the subsequent XHR call to be linked to its initial action. The XHR callback must be concluded with leaveXhrCallback.

Instructs RUM JavaScript to wait for an additional call to signalOnLoadEnd before closing the 'onload' action. Note: The load action will only use the provided load end event correctly if signalOnLoadEnd is called afterward.

Leaves an action that was previously created using enterAction. Use this method to set the load end event for a custom action and complete its creation. This method must be called after enterAction.

Indicates the end of an XHR action.

Indicates the end of an XHR callback.

Removes a previously attached listener that detects the enter action event.

Removes a previously attached listener that detects the leave action event.

Enables or disables automatic action detection. Use this method when you want to manually instrument your application.

Prevents RUM JavaScript from automatically detecting the load end event. The load end event must be explicitly set using signalLoadEnd. Call this method immediately after injecting RUM JavaScript.

Signals that the page has finished loading. Use in combination with setLoadEndManually to define your own load end times.

Indicates the end of a load action. This method requires that incrementOnLoadEndMarkers has been called beforehand. The action is closed after the final call to signalOnLoadEnd.

Indicates the start of a load action. Frameworks often have their own load callback functions, and this method can be used when a framework begins loading before the 'DOMContentLoaded' event.

Adds custom action properties to the currently active action.
Only accepts valid java long, java double (as a string representation), Date objects, and short strings with a maximum length of 100-1000 characters (as configured under Application Settings).
Action properties must be defined under Application settings and use a lowercase key.

Re-enables automatic page detection after manual detection was enabled via enableManualPageDetection. Once this method is called, RUM JavaScript will resume automatically detecting page and page group names.

Enables manual page detection. Once this method is called, RUM JavaScript will stop automatically detecting page and page group names and will only use the values provided via setPage. It is recommended to call this as early as possible. To resume automatic detection, call enableAutomaticPageDetection.

Retrieves and evaluates metadata for the page, which can be used for troubleshooting RUM monitoring.

Sets the user tag, which is used to identify individual users across different browsers, devices, and sessions.

Reports the HTTP status code and a custom message for the response of the current page. For example, use this method to mark your 404 pages that respond with an HTTP status code of 200. This method must be called before the page's onload event finishes; otherwise, the information will be discarded.

Reports the HTTP status code and an additional message for the response of the current XHR action. For example, use this method when the HTTP status code of your XHR response is 200, but the server's result indicates a failed request. This method must be called before the XHR action finishes and all listeners have been invoked.

Reports custom errors to Dynatrace. Use this method to capture custom errors, such as form validation errors, that are defined in Application settings.

Reports an error to Dynatrace. Use this method when you catch errors in your application code and want to propagate them to Dynatrace, rather than handling them solely with your own logging. If the error is managed by your application, it will not be handled by the global JavaScript onerror event handler, which Dynatrace uses to automatically capture JavaScript errors.

Sends session properties on a beacon currently only accepts valid java long, java double (as a string representation), Date objects, and short strings of a maximum length of 100-1000 characters (as configured under Application Settings).
NOTE: session properties need to have a lower case key!

Make sure to first define session properties under Application settings before making this API call.

Starts a new page view and reports it to the Dynatrace server.

Adds a listener that is called when the user is leaving the page, before the RUM monitoring beacon is sent. Use this method to hook into the page unload event.

Adds a listener that is triggered when the current visit times out and before a new visit ID is generated.

Disables RUM JavaScript and removes all cookies if it was previously enabled with enable, thereby activating the opt-in mode. Use this method along with a user consent tool to disable RUM monitoring when consent is not provided.

Removes all persistent values and disables any functionality that would recreate them. Note that this must be called on every page, as it erases persistent RUM monitoring data, including the information that prevents persistent data from being stored.
Use this method when you want to disable monitoring of returning users. For more information, see cookie storage.

Disables session replay.

Enables RUM JavaScript if it was previously disabled via the opt-in mode. Use this method in conjunction with a user consent tool to enable RUM monitoring once consent has been provided.

Re-enables persistent values if they were previously disabled by calling disablePersistentValues. Use this method when you want to resume monitoring returning users.

Enables session replay.

Immediately ends the current session.

Forces the sending of a beacon to ensure actions are not lost. For example, use this method before a window unload event by adding a addPageLeavingListener.

Returns the current time in milliseconds using the most accurate method available.