Tüm Ürünler
Search
Belge Merkezi

Application Real-Time Monitoring Service:SDK yöntemleri

Son Güncelleme:Oct 05, 2026

Alibaba Cloud Tarayıcı İzleme SDK'sı, veri raporlama ve SDK yapılandırması değişikliği için yöntemler sağlar. Bu konuda ayrıca birden çok SDK örneğinin nasıl oluşturulacağı açıklanmaktadır.

Bu konudaki yöntemler

api()

Bir sayfadaki API çağrılarının başarı oranını raporlamak için api() yöntemini kullanın.

SDK varsayılan olarak sayfadaki AJAX isteklerini izler ve verileri raporlamak için bu API'yi çağırır. Sayfanız JSONP veya istemci SDK'sı gibi özel yöntemlerle veri talep ediyorsa, verileri manuel olarak raporlamak için api() yöntemini çağırmanız gerekir.

Not

Bu yöntemi çağırmak için SDK yapılandırmalarında disableHook parametresini true olarak ayarlamanızı öneririz. Daha fazla bilgi için bkz. disableHook.

api() sözdizimi:

__bl.api(api, success, time, code, msg, begin, traceId, sid)

veya

__bl.api({api: xxx, success: xxx, time: xxx, code: xx, msg: xx, begin: xx, traceId: xx, sid: xx})


Parametre


Tür


Açıklama


Gerekli


Varsayılan değer


api


String


Yöntemin adı.


Evet


Yok


success


Boolean


Çağrının başarılı olup olmadığını belirtir.


Evet


Yok


time


Number


Çağrının harcadığı süre.


Evet


Yok


code


String/Number


Dönüş kodu.


Hayır


Yok


msg


String


Yanıt bilgisi.


Hayır


Yok


begin


Number


İsteğin başlatıldığı zaman. Değer bir zaman damgasıdır.


Hayır


Yok


traceId


String


EagleEye-TraceID değeri.


Hayır


Yok


sid


String


EagleEye-SessionID değeri.


Hayır


Yok

api() örneği:

var begin = Date.now(),
    url = '/data/getTodoList.json',
    traceId = window.__bl && __bl.getTraceId('EagleEye-TraceID'),
    sid = window.__bl && __bl.getSessionId('EagleEye-SessionID');
// Note: Include EagleEye-TraceID and EagleEye-SessionID in the request header.
fetch(url, {
    headers: {
        'EagleEye-TraceID': traceId,
        'EagleEye-SessionID': sid
    }
}).then(function (result) {
    var time = Date.now() - begin;
    // Report a successful API call.
    window.__bl && __bl.api(url, true, time, result.code, result.msg, begin, traceId, sid);
    // do something...
}).catch(function (error) {
    var time = Date.now() - begin;
    // Report a failed API call.
    window.__bl && __bl.api(url, false, time, 'ERROR', error.message, begin, traceId, sid);
    // do something...
});

[[Başa Dön]](#sc_index)

error()

İzlenen sayfalardaki JS hatalarını veya özel durumları raporlamak için error() yöntemini çağırın. Ayrıntıları Tarayıcı İzleme'nin JS Error Diagnostics sayfasında görüntüleyebilirsiniz.

Genellikle SDK, sayfadaki genel hataları dinler ve özel durumları raporlamak için bu yöntemi çağırır. Ancak, tarayıcının aynı kaynak ilkesi nedeniyle hata ayrıntılarına genellikle erişilemez. Bu durumda, bu tür hataları manuel olarak raporlamanız gerekir.

error() sözdizimi:

__bl.error(error, pos)


Parametre


Tür


Açıklama


Gerekli


Varsayılan değer


error


Error


JS hata nesnesi.


Evet


Yok


pos


Object


Hatanın oluştuğu konum. Konum aşağıdaki nitelikleri içerir: pos.filename, pos.lineno ve pos.colno.


Hayır


Yok


pos.filename


String


Hatanın oluştuğu dosyanın adı.


Hayır


Yok


pos.lineno


Number


Hatanın oluştuğu satır numarası.


Hayır


Yok


pos.colno


Number


Hatanın oluştuğu sütun numarası.


Hayır


Yok

error() örneği 1: Sayfadaki JS hatalarını dinleyin ve raporlayın.

window.addEventListener('error', function (ex) {
    // The event argument usually contains location information.
    window.__bl && __bl.error(ex.error, ex);
});

error() örneği 2: Özel bir hata mesajı raporlayın.

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

error() örneği 3: Özel bir türdeki hata mesajını raporlayın.

__bl.error({name:'CustomErrorLog',message:'this is an error'}, {
    filename: 'app.js', 
    lineno: 10, 
    colno: 15
});

[[Başa Dön]](#sc_index)

sum()

Özel istatistikleri raporlamak için sum() yöntemini kullanın. Bu yöntem genellikle bir iş olayının gerçekleşme sayısını hesaplamak için kullanılır. sum() yöntemiyle raporlanan verileri Custom Statistics sayfasında görüntüleyebilirsiniz:

  • Özel olayların trend grafiği

  • Bir olayın sayfa görüntülemeleri (PV'ler) ve tekil ziyaretçileri (UV'ler)

  • Boyut dağılım bilgileri

Not

Verileri raporladıktan sonra, birkaç dakika içinde Custom Statistics sayfasında görünür.

sum() sözdizimi:

__bl.sum(key, value)


Parametre


Tür


Açıklama


Gerekli


Varsayılan değer


key


String


Olayın adı.


Evet


Yok


value


Number


Bir seferde raporlanan öğe sayısı.


Hayır


1

sum() örneği:

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

[[Başa Dön]](#sc_index)

avg()

Özel verileri raporlamak için avg() yöntemini kullanın. Bu yöntem genellikle belirli bir iş olayının ortalama gerçekleşme sayısını veya değerini hesaplamak için kullanılır. avg() ile raporlanan verileri Custom Statistics sayfasında görüntüleyebilirsiniz:

  • Özel olayların trend grafiği

  • Bir olayın PV'leri ve UV'leri

  • Boyut dağılım bilgileri

avg() sözdizimi:

__bl.avg(key, value)


Parametre


Tür


Açıklama


Gerekli


Varsayılan değer


key


String


Olayın adı.


Evet


Yok


value


Number


Raporlanan öğe sayısı.


Hayır


0

avg() örneği:

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

[[Başa Dön]](#sc_index)

reportBehavior()

Geçerli davranış kuyruğunu hemen raporlamak için reportBehavior() yöntemini çağırın.

Bu yöntemi manuel olarak çağırmazsanız, bir JS hatası oluştuğunda geçerli davranış kuyruğu otomatik olarak raporlanır. Bir kuyruğun maksimum boyutu 100'dür. Kuyruk 100'den fazla davranış kaydı içeriyorsa, davranış kayıtları kuyruğun başından itibaren atılır.

Not

Bu yöntemi çağırmak için SDK yapılandırmalarında behavior parametresini true olarak ayarlamanız gerekir.

reportBehavior() sözdizimi:

__bl.reportBehavior()

reportBehavior() yöntemi herhangi bir parametre kabul etmez.

[[Başa Dön]](#sc_index)

addBehavior()

Geçerli davranış kuyruğuna özel bir kullanıcı davranışı eklemek için addBehavior() yöntemini çağırın.

SDK, maksimum uzunluğu 100 giriş olan bir kullanıcı davranışı kuyruğunu korur. Kuyruğa özel bir kullanıcı davranışı eklemek için addBehavior() yöntemini çağırabilirsiniz. Bir JS hatası oluştuğunda, SDK geçerli davranış kuyruğunu raporlar ve temizler.

Kullanıcı davranışı geri izlemesini JS Error Diagnostics sayfasında görüntüleyebilirsiniz. Talimatlar için bkz. JS hatalarını teşhis etmek için kullanıcı davranışı geri izlemesini kullanma.

Not

Bu yöntemi çağırmak için SDK yapılandırmalarında behavior parametresini true olarak ayarlamanız gerekir.

addBehavior() sözdizimi:

__bl.addBehavior(behavior)

Parametre

Tür

Açıklama

Gerekli

Varsayılan değer

data

Object

Davranış verileri. Bu parametre aşağıdaki iki zorunlu alana sahiptir:

  • name: STRING türündeki davranış adı. Ad en fazla 20 karakter uzunluğunda olabilir.

  • message: STRING türündeki davranış içeriği. Değer en fazla 200 karakter uzunluğunda olabilir.

Evet

Yok

page

String

Davranışın gerçekleştiği sayfa.

Hayır

location.pathname parametresinin değeri

addBehavior() örneği:

__bl.addBehavior({
  data:{name:'string',message:'string'},
  page:'string'
})

[[Başa Dön]](#sc_index)

performance()

Önemli

Bu yöntem yalnızca web istemcileri için geçerlidir.

Varsayılan performans ölçümlerine ek olarak özel performans ölçümlerini raporlamak için sayfa onLoad olayından sonra performance() yöntemini çağırın.

Not

Bu yöntemi yalnızca onLoad olayı gerçekleştikten sonra çağırabilirsiniz. Aksi takdirde, varsayılan performans ölçümlerinin toplanması eksik olduğundan çağrı başarısız olur. performance() yöntemi her PV sırasında yalnızca bir kez çağrılabilir.

performance() yöntemini kullanmak için aşağıdaki adımları uygulayın:

  1. Performans ölçümlerinin otomatik raporlanmasını devre dışı bırakmak ve manuel raporlamayı beklemek için autoSendPerf parametresini false olarak ayarlayın.

  2. Özel ölçümleri manuel olarak raporlamak için __bl.performance(Object) yöntemini çağırın. Bu çağrı, hem özel ölçümlerinizi hem de SDK tarafından toplanan varsayılan performans ölçümlerini gönderir.

performance() örneği 1: CDN ile.

window.onload = () => {
 setTimeout(()=>{
  __bl.performance({cfpt:100, ctti:200, t1:300, …});
 }, 1000); // Delay to ensure all default performance metrics are collected before manual reporting.
};

performance() örneği 2: npm paketi ile.

const BrowserLogger = require('@arms/js-sdk');
const __bl = BrowserLogger.singleton({pid:'Your unique site ID'});
window.onload = () => {
 setTimeout(()=>{
  __bl.performance({cfpt:100, ctti:200, t1:300, …});
 }, 1000);// Delay to ensure all default performance metrics are collected before manual reporting.
};
Not

Özel performans ölçümlerinin açıklamaları:

  • cfpt: özel ilk boyama zamanı

  • ctti: etkileşim için ilk özel zaman

  • t1 ila t10: 10 özel performans ölçümü

[[Başa Dön]](#sc_index)

setConfig()

Belirli yapılandırma öğelerini değiştirmek için SDK başlatıldıktan sonra setConfig() yöntemini çağırın. Daha fazla bilgi için bkz. SDK referansı.

setConfig() sözdizimi:

__bl.setConfig(next)


Parametre


Tür


Açıklama


Gerekli


Varsayılan değer


next


Object


Değiştirmek istediğiniz parametre ve yeni parametre değeri.


Evet


Yok

[[Başa Dön]](#sc_index)

setPage()

Sayfa adını sıfırlamak için setPage() yöntemini kullanın; bu işlem varsayılan olarak yeni bir PV raporu tetikler. Bu yöntem genellikle tek sayfalı uygulama (SPA) için kullanılır. Daha fazla bilgi için bkz. SPA'ların sayfa veri raporlaması.

Not

PV verileri tekrar raporlandığında, mevcut verilerin üzerine yazılmaz. Yeni bir veri girişi eklenir.

setPage() sözdizimi:

__bl.setPage(page, sendPv)


Parametre


Tür


Açıklama


Gerekli


Varsayılan değer


page


String


Yeni sayfa adı.


Evet


Yok


sendPv


Boolean


PV verilerinin raporlanıp raporlanmayacağını belirtir. Varsayılan olarak PV verileri raporlanır.


Hayır


true

setPage() örneği:

// Set the page name to the current URL hash and report a new PV.
__bl.setPage(location.hash);

// Set the page name to 'homepage' without reporting a new PV.
__bl.setPage('homepage', false);

[[Başa Dön]](#sc_index)

setCommonInfo()

Ortak alanları ayarlamak için setCommonInfo() yöntemini kullanın.

setCommonInfo() sözdizimi:

__bl.setCommonInfo(obj)

setCommonInfo() yöntemi bir nesne parametresi kabul eder:

__bl.setCommonInfo({
  name: 'xxx',
  common: 'xxx'
});
Not

Nesne boyutunu sınırlayın. Büyük bir nesne uzun bir GET isteğine neden olabilir ve bu durum isteğin başarısız olmasına yol açabilir.

[[Başa Dön]](#sc_index)

Birden çok örnek oluşturun

Birden çok örnek oluşturmak için @arms/js-sdk npm paketini kullanın.

Web sayfaları

  • Örnek:

    const BrowerLogger = require('@arms/js-sdk');
    const bl2 = BrowerLogger.createExtraInstance(props); // Create an instance using the createExtraInstance method.
    bl2.custom({
      key: 'biz',
      msg: 'msg info'
    });
    Not

    props parametresi Object türündedir. props parametresinde bulunan parametreler, temel olarak SDK yapılandırmalarındaki parametrelerle aynıdır.

  • Yeni örnekler yalnızca özel bilgileri raporlar:

    var props = {
      pid: 'xxxx', // The site ID where the new instance reports data.
      region: 'cn',
      page: '',
      uid: ''
    }

Weex sayfaları

  • Örnek:

    const WeexLogger = require('@arms/js-sdk/weex');
    const wl2 = WeexLogger.createExtraInstance(props); // Create an instance using the createExtraInstance method.
    wl2.custom({
      key: 'biz',
      msg: 'msg info'
    });
    Not

    props parametresi Object türündedir. props parametresinde bulunan parametreler, temel olarak SDK yapılandırmalarındaki parametrelerle aynıdır.

  • Yeni örnekler yalnızca özel bilgileri raporlar:

    var props = {
      pid: 'xxxx', // The site ID where the new instance reports data.
      region: 'cn',
      sendRequest: function(data, imgUrl) {
        // The method for sending logs using GET requests.
      },
      postRequest: function(data, imgUrl) {
        // The method for sending logs using POST requests.
      }
    }

Mini programlar

Örnek: Mini program türünüzle eşleşen içe aktarma yolunu seçin (örneğin, DingTalk mini programı veya Alipay mini programı). region parametresi, günlüklerin nerede raporlandığını belirtir: Günlükleri Çin'deki sunuculara raporlamak için cn olarak, Singapur'daki sunuculara raporlamak için ise sg olarak ayarlayın. Bu parametreyi belirtmezseniz, günlükler Çin'deki sunuculara raporlanır.

import MiniProgramLogger from '@arms/js-sdk/miniapp'; // Select the path that matches your mini program type, such as a DingTalk mini program or an Alipay mini program.
const MiniInstance = MiniProgramLogger.createExtraInstance({
  pid: 'xxxinstance',
  uid: 'userxxx', // User ID for collecting UV data.
  region: 'cn', // The region where logs are reported. Set the value to `cn` for China or `sg` for Singapore. Defaults to `cn` if unspecified.
  // For basic mini program monitoring, you must manually pass the remote procedure call (RPC) method. Implement the method based on your business requirements.
  sendRequest: (url, resData) => {
    // The method for sending data.
  }
});