Methods user guide

api() for reporting the API call success rate

This method reports the API call success rate on the page. The SDK listens for AJAX requests on the page and calls this method for reporting by default. If data on the page is requested using JSONP or other custom methods (such as the client SDK), you can call api() in the data request method for manual reporting.

Call parameter description:__bl.api(api, success, time, code, msg)

Example

var begin = Date.now(),
    url = '/data/getTodoList.json';

$.ajax({
    url: url,
    data: {id: 123456}
}).done(function (result) {
    var time = Date.now() - begin;
    // Reports that the method call is successful.
    window.__bl && __bl.api(url, true, time, result.code, result.msg);
    // do something ....
}).fail(function (error) {
    var time = Date.now() - begin;
    // Reports that the method call fails.
    window.__bl && __bl.api(url, false, time, 'ERROR', error.message);
    // do something ...
});
			

error() for reporting the error information

This method reports JavaScript (JS) errors or exceptions you want to capture on the page.

Generally, the SDK listens for global errors on the page and calls this method to report exceptions. However, due to the same-origin policy of the browser, error details are usually out of reach. In this case, you must manually report such errors.

Call parameter description: __bl.error(error, pos)

Example 1: Listen to and report JS errors on the page.

window.addEventListener('error', function (ex) {
    // Event parameters usually contain position information.
    window.__bl && __bl.error(ex.error, ex);
});
			

Example 2: Report a custom error.

window.__bl && __bl.error(new Error('A custom error occurs.'), {
    filename: 'app.js', 
    lineno: 10, 
    colno: 15
});
			

sum() for summation

This methods counts how many times a specific business event occurs.

Call parameter description: __bl.sum(key, value)

Example

__bl.sum('event-a');

__bl.sum('event-b', 3);

__bl.sum('group-x::event-c', 2);
			

avg() for average value calculation

This method counts how many times a specific event occurs on average in a business scenario.

Call parameter description: __bl.avg(key, value)

Example

__bl.avg('event-a', 1);
__bl.avg('event-b', 3);

__bl.avg('events::event-c', 10);
__bl.avg('speed::event-d', 142.42);
			

addBehavior() for adding a user behavior

This method adds a custom user behavior to the end of the current behavior queue.

The SDK maintains a user behavior queue with a maximum of 100 records. When a JS error occurs, the SDK reports the current behavior queue and clears the queue. You can call this method to add a custom behavior to the end of the current behavior queue.

Call parameter description: __bl.addBehavior(behavior)

Example

{
  data: {
    name: 'string',
    message: 'string',
  },
  page: 'string'
}

reportBehavior() for user behavior reporting

When you call this method, the current behavior queue is reported immediately. This method is optional.

If you do not manually call this method, when a JS error occurs, the current behavior queue is automatically reported, with a maximum size of 100. If the queue contains more than 100 behavior records, behavior records are discarded from the header of the queue.

Call parameter description: __bl.reportBehavior()

No request parameters.

Other methods

Non-log reporting methods are usually used for modifying some configuration items of the SDK.

setConfig() for modifying configuration items

This method allows you to modify some of the configuration items after SDK initialization. For detailed configuration, see Configuration items of the browser monitoring SDK.

Call parameter description: __bl.setConfig(next)

Example: Change the value disableHook to true to disable automatic API reporting.

__bl.setConfig({
    disableHook: true
});
			

setPage() for setting the name of the current page

This method resets the page name of a page. PV will be reported again by default. This method is generally used for SPAs. For more information, seeAdvanced browser monitoring scenarios.

Call parameter description: __bl.setPage(next, sendPv)

Example 1: Set the name of the current page to the current URL hash, and report PV again.

__bl.setPage(location.hash);
			

Example 2: Set the name of the current page to 'homepage' without triggering PV reporting.

__bl.setPage('homepage', false);