Application Real-Time Monitoring Service:SDK reference

Methods in this topic

pid | uid | tag | page | setUsername | enableSPA | parseHash | disableHook | ignoreUrlCase | urlHelper | apiHelper | parseResponse | ignore | disabled | sample | pvSample | sendResource | useFmp | enableLinkTrace | release | environment | behavior | c1\c2\c3 | autoSendPerf

Use SDK configuration items

You can use SDK configuration items by using one of the following methods:

• When you install a Browser Monitoring agent to a page, add parameters to config based on your requirements.

  For example, in the following sample code, aside from the default pid parameter, the enableSPA parameter for single page applications (SPAs) is added to config:

  <script>
  !(function(c,b,d,a){c[a]||(c[a]={});c[a].config={pid:"xxxxxx",enableSPA:true};
  with(b)with(body)with(insertBefore(createElement("script"),firstChild))setAttribute("crossorigin","",src=d)
  })(window,document,"https://retcode.alicdn.com/retcode/bl.js","__bl");
  </script>                    

• After a page is initialized, call the setConfig method in the JavaScript code to modify the configuration items.

  The following table describes the parameter of the __bl.setConfig(next) method.

  Parameter	Type	Description	Required	Default value
  next	Object	The configuration item and its value that you want to modify.	Yes	None

pid

[Back to Top]

uid

The following code provides an example on how to call the setConfig method to modify the SDK configuration item:

__bl.setConfig({
    uid: 12345
});        

[Back to Top]

tag

[Back to Top]

page

[Back to Top]

setUsername

This configuration item is used to create a function. This function is used to obtain a username as a string. After the username is obtained, you can implement end-to-end session tracing and query sessions based on the username to troubleshoot issues.

The following code provides an example on how to call the setConfig method to modify the SDK configuration item:

__bl.setConfig({
    setUsername: function () {
        return "username_xxx";
    }
});            

[Back to Top]

enableSPA

[Back to Top]

parseHash

In an SPA, when the enableSPA parameter is set to true and the page triggers a hashchange event, the parseHash parameter is used to parse the URL hash into the page name indicated by the Page field. For more information about SPAs, see Page data reporting of SPAs.

Default value

The default value is obtained by using the following string processing method:

function (hash) {
    var page = hash ? hash.replace(/^#/, '').replace(/\?.*$/, '') : '';
    return page || '[index]';
}           

Typically, you do not need to modify this parameter. However, if you want to use a custom page name to report page-specific data, or if the URL hash is complex, you can modify this configuration item. Example:

// Define the mapping between the URL hashes and page names. 
var PAGE_MAP = {
    '/': 'Homepage',
    '/contact': 'Contact us',
    '/list': 'Data list',
    // ...
};
// Call the SDK method after the page is loaded. 
window.addEventListener('load', function (e) {
    // Call the setConfig method to modify the parseHash configuration item. 
    __bl.setConfig({
        parseHash: function (hash) {
            key = hash.replace(/\?.*$/, '');
            return PAGE_MAP[key] || 'Unknown page';
        }
    });
});

[Back to Top]

disableHook

[Back to Top]

ignoreUrlCase

[Back to Top]

urlHelper

When a page URL is in the format of http://example.com/projects/123456 (where the value that follows projects is the project ID), page-specific data is reported with the page name as example.com/projects/123456. In this case, data of similar pages about projects cannot be aggregated. If you want to aggregate data of similar pages, set the urlHelper parameter to remove non-key characters from the page URLs, such as the project ID in this example.

Default value

The default value of this configuration item is the array in the following sample code. In most cases, you do not need to modify the value:

[
    // Replace all digits in the URL with asterisks (*). 
    {rule: /\/([a-z\-_]+)?\d{2,20}/g, target: '/$1**'},
    // Remove the forward slash (/) at the end of the URL. 
    /\/$/
]                    

The default value of this parameter is used to replace digits with asterisks (*) in strings such as xxxx/123456. For example, xxxx/00001 and xxxx/00002 are changed to xxxx/**.

Value types

The value of the urlHelper parameter can be of the following types:

• String or RegExp (regular expression): The matched strings are removed.

• Object<rule, target>: The object contains two keys, rule and target, which are the input parameters of the replace method in the JavaScript string. For more information, see the String::replace method described in related JavaScript tutorials.

• Function: The original string is used as the input parameter for creating a function. The return value of the function is used as the page name

• Array: This value type is used to set multiple rules for removing non-key characters in page URLs. The value of each rule can be one of the preceding types.

[Back to Top]

apiHelper

This parameter is used to remove non-key characters in page URLs when page-specific data about API operations is automatically reported. The usage and function of this parameter are the same as those of urlHelper.

Default value

The default value of this parameter is an object and does not need to be modified:

{rule: /(\w+)\/\d{2,}/g, target: '$1'}                    

The default value of this parameter is used to remove the digits in URL strings such as xxxx/123456.

If you want to report parameters after ? in the page-specific data of API operations, such as the pid parameter in https://arms.console.aliyun.com/apm?pid=fr6fbgbeot, perform the following steps to manually report the data:

• Call the ignore method to disable automatic data reporting. For more information, see ignore.

• Call the api() method to manually report the page-specific data about API operations. For more information, see api().

[Back to Top]

parseResponse

This configuration item is used to parse the data returned when the page-specific data of API operations is automatically reported.

Default value

The following sample code shows the default configurations:

function (res) {
    if (!res || typeof res !== 'object') return {};
    var code = res.code;
    var msg = res.msg || res.message || res.subMsg || res.errorMsg || res.ret || res.errorResponse || '';
    if (typeof msg === 'object') {
        code = code || msg.code;
        msg = msg.msg || msg.message || msg.info || msg.ret || JSON.stringify(msg);
    }
    return {msg: msg, code: code, success: true};
}                    

The preceding code is used to parse the returned data and extract the msg and code parameters. Typically, you do not need to modify the default configurations. You can also modify the configurations based on your business requirements.

[Back to Top]

ignore

The value of the ignore parameter is an object that contains four properties: ignoreUrls, ignoreApis, ignoreErrors, and ignoreResErrors. You can set one or more properties of the parameter value.

Default value

The following sample code shows the default configurations:

ignore: {
        ignoreUrls: [],
        ignoreApis: [],
        ignoreErrors: [],
        ignoreResErrors: []
    },                    

ignoreUrls

The ignoreUrls property is used to ignore URLs that comply with the rule you specified. Logs from these URLs are not reported. The value of this property can be a string (indicated by the String type), a regular expression (indicated by the RegExp type), a method (indicated by the Function type), or an array that contains data of the preceding types. Example:

__bl.setConfig({
                ignore: {
                    ignoreUrls: [
                    'http://host1/',  // Specify a string.
                    /.+?host2.+/,     // Specify a regular expression.
                    function(str) {   // Specify a method.
                        if (str && str.indexOf('host3') >= 0) {
                            return true; // The data is not reported.
                        }
                        return false; // The data is reported.
                    }]
                }
            });                    

ignoreApis

The ignoreApis property is used to ignore APIs that comply with the rule you specified. The value of this property can be a string (indicated by the String type), a regular expression (indicated by the RegExp type), a method (indicated by the Function type), or an array that contains data of the preceding types. Example:

__bl.setConfig({
                ignore: {
                    ignoreApis: [
                    'api1','api2','api3', // Specify a string.
                    /^random/,  // Specify a regular expression.
                    function(str) { // Specify a method.
                        if (str && str.indexOf('api3') >= 0) return true; // The data is not reported.
                        return false; // The data is reported.
                    }]
                }
            });                    

ignoreErrors

The ignoreErrors property is used to ignore JS errors that comply with the rule you specified. The value of this property can be a string (indicated by the String type), a regular expression (indicated by the RegExp type), a method (indicated by the Function type), or an array that contains data of the preceding types. Example:

__bl.setConfig({
                ignore: {
                    ignoreErrors: [
                    'test error', // Specify a string.
                    /^Script error\.?$/, // Specify a regular expression.
                    function(str) { // Specify a method.
                        if (str && str.indexOf('Unknown error') >= 0) return true;   // The data is not reported.
                        return false; // The data is reported.
                    }]
                }
            });            

ignoreResErrors

The ignoreResErrors property is used to ignore resource errors that comply with the rule you specified. The value of this property can be a string (indicated by the String type), a regular expression (indicated by the RegExp type), a method (indicated by the Function type), or an array that contains data of the preceding types. Example:

__bl.setConfig({
                ignore: {
                    ignoreResErrors: [
                    'http://xx/picture.jpg', // Specify a string.
                    /jpg$/, // Specify a regular expression.
                    function(str) { // Specify a method.
                        if (str && str.indexOf('xx.jpg') >= 0) return true;   // The data is not reported.
                        return false; // The data is reported.
                    }]
                }
            });

[Back to Top]

disabled

[Back to Top]

sample

Benefits:

• Reduces costs by reporting only sampled API data. We recommend that you identify the data that does not require monitoring by setting the ignore parameter. For more information, see ignore.

• Reduces the performance overhead of data collection.

Description:

• You can set this configuration item to randomly select and report performance logs and logs about successful API operations. This reduces the volume of reported data and the workloads. When ARMS processes the reported logs in the background, ARMS restores the data based on the sampling configurations. In this way, metrics such as the JS error rate or API failure rate are not affected by sampling and remain accurate. However, when you set this parameter, you may be unable to obtain the detailed data such as the API details.

• The default value of the sample parameter is 1. The valid values of this parameter are integers from 1 to 100. The sampling rate can be calculated by using the following formula: 1/Value of sample. For example, the parameter values 1, 10, and 100 indicate the sampling rates of 100%, 10%, and 1%.

[Back to Top]

pvSample

Benefits:

• Reduces costs by reporting only sampled PV data.

• Reduces the performance overhead of data collection.

Description:

• You can set this configuration item to randomly select and report PV logs. This reduces the volume of reported data and the workloads. When ARMS processes the reported logs in the background, ARMS restores the data based on the sampling configurations. In this way, metrics such as the JS error rate are not affected by sampling and remain accurate.

• The default value of the pvSample parameter is 1. The valid values of this parameter are integers from 1 to 100. The sampling rate can be calculated by using the following formula: 1/Value of pvSample. For example, the parameter values 1, 10, and 100 indicate the sampling rates of 100%, 10%, and 1%.

[Back to Top]

sendResource

If the sendResource parameter is set to true, the static resources loaded to the current page are reported when the load event is triggered for the page. If the page loading is slow, you can view the waterfall chart of static resources on the Session Traces page to determine the cause.

The following code provides an example on how to set the sendResource parameter:

<script>
!(function(c,b,d,a){c[a]||(c[a]={});c[a].config={pid:"xxxxxx",sendResource:true};
with(b)with(body)with(insertBefore(createElement("script"),firstChild))setAttribute("crossorigin","",src=d)
})(window,document,"https://retcode.alicdn.com/retcode/bl.js","__bl");
</script>            

[Back to Top]

useFmp

[Back to Top]

enableLinkTrace

[Back to Top]

release

[Back to Top]

environment

[Back to Top]

behavior

[Back to Top]

autoSendPerf

[Back to Top]

c1\c2\c3

In addition to the preceding configuration items, the ARMS SDK provides three custom configuration items that you can configure fields to meet your business requirements. After you configure the fields, the fields values are included in all reported logs.

[Back to Top]