Application Real-Time Monitoring Service:Konfigurasi SDK Pemantauan Browser

Contoh inisialisasi

Skrip berikut menginstal agen dengan pid wajib ditambah tiga parameter opsional — enableSPA, sendResource, dan release:

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

Pembaruan runtime dengan setConfig

Panggil __bl.setConfig(next) untuk mengubah konfigurasi setelah halaman dimuat.

__bl.setConfig({
    uid: "user-12345",
    tag: "checkout-flow"
});

Identitas

Halaman dan URL

Dukungan SPA

Filtering data

Pengambilan sampel

Pelacakan performa dan resource

Pelacakan dan diagnostik

Metadata aplikasi

Bidang kustom

pid

ID proyek unik, dihasilkan secara otomatis saat ARMS membuat situs.

uid

Identifier pengguna untuk pencarian dan pelacakan pengguna individu. Tentukan nilai kustom, atau biarkan SDK menghasilkannya secara otomatis.

__bl.setConfig({
    uid: "user-12345"
});

setUsername

Panggilan balik yang mengembalikan string username. Setelah diatur, mengaktifkan pelacakan sesi end-to-end dan pencarian sesi berdasarkan username untuk troubleshooting.

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

Perilaku:

• Jika username tidak tersedia saat pemuatan halaman, kembalikan null — bukan placeholder. SDK akan memanggil setUsername lagi saat mengirim log. Mengembalikan placeholder berarti nilai tersebut digunakan dan setUsername tidak dipanggil lagi.

• setUsername hanya menerima satu penugasan per waktu proses. Mulai ulang aplikasi untuk menetapkannya kembali.

page

Mengganti nama halaman yang terdeteksi otomatis dengan nilai kustom.

tag

Tag kustom yang dilampirkan pada setiap entri log. Gunakan tag untuk mengkategorikan atau memfilter log di Konsol ARMS.

ignoreUrlCase

Jika diatur ke true, pencocokan URL halaman tidak membedakan huruf besar/kecil.

urlHelper

Menormalisasi URL halaman dengan menghapus segmen dinamis agar halaman serupa teragregasi dalam satu entri. Menggantikan parameter lama ignoreUrlPath.

Mengapa menormalisasi URL: URL seperti example.com/projects/123456 menghasilkan nama halaman unik per ID proyek. urlHelper menghapus segmen dinamis sehingga semua halaman proyek teragregasi sebagai example.com/projects/**.

Default value:

[
    // Ganti rangkaian digit (2–20 karakter) dengan **
    {rule: /\/([a-z\-_]+)?\d{2,20}/g, target: '/$1**'},
    // Hapus slash akhir
    /\/$/
]

Tipe nilai yang didukung:

apiHelper

Menormalisasi URL API dengan menghapus segmen dinamis, sama seperti cara urlHelper menormalisasi URL halaman. Menggantikan parameter lama ignoreApiPath.

Melaporkan parameter kueri dalam data API: Untuk menyertakan parameter kueri (misalnya, pid dalam https://arms.console.aliyun.com/apm?pid=fr6fbgbeot), nonaktifkan pelaporan otomatis dengan parameter ignore dan panggil api() secara manual. Untuk detailnya, lihat api().

enableSPA

Mendengarkan event hashchange dan melaporkan tampilan halaman baru (PV) pada setiap perubahan rute. Aktifkan ini untuk aplikasi halaman tunggal (SPAs).

parseHash

Digunakan bersama enableSPA. Saat enableSPA bernilai true dan event hashchange terpicu, parseHash mengonversi hash URL menjadi nama halaman untuk bidang Page. Untuk detailnya, lihat Pelaporan data halaman SPAs.

Default value:

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

Umumnya, nilai bawaan sudah cukup. Untuk memetakan hash ke nama halaman kustom, timpa fungsi ini:

var PAGE_MAP = {
    '/': 'Homepage',
    '/contact': 'Contact us',
    '/list': 'Data list'
};

window.addEventListener('load', function (e) {
    __bl.setConfig({
        parseHash: function (hash) {
            var key = hash.replace(/\?.*$/, '');
            return PAGE_MAP[key] || 'Unknown page';
        }
    });
});

ignore

Menekan pelaporan log untuk URL, API, error JavaScript, atau error pemuatan resource yang cocok dengan aturan tertentu. Berisi empat sub-properti.

Setiap sub-properti menerima String, RegExp, Function, atau Array dari tipe-tipe tersebut.

__bl.setConfig({
    ignore: {
        ignoreUrls: [
            'http://host1/',                     // Pencocokan string eksak
            /.+?host2.+/,                        // Pencocokan regex
            function(str) {                      // Fungsi kustom
                if (str && str.indexOf('host3') >= 0) {
                    return true;   // Tekan
                }
                return false;      // Laporkan
            }
        ]
    }
});

__bl.setConfig({
    ignore: {
        ignoreApis: [
            'api1', 'api2', 'api3',              // Pencocokan string
            /^random/,                            // Pencocokan regex
            function(str) {                       // Fungsi kustom
                if (str && str.indexOf('api3') >= 0) return true;
                return false;
            }
        ]
    }
});

__bl.setConfig({
    ignore: {
        ignoreErrors: [
            'test error',                         // Pencocokan string
            /^Script error\.?$/,                  // Pencocokan regex
            function(str) {                       // Fungsi kustom
                if (str && str.indexOf('Unknown error') >= 0) return true;
                return false;
            }
        ]
    }
});

__bl.setConfig({
    ignore: {
        ignoreResErrors: [
            'http://xx/picture.jpg',              // Pencocokan string
            /jpg$/,                               // Pencocokan regex
            function(str) {                       // Fungsi kustom
                if (str && str.indexOf('xx.jpg') >= 0) return true;
                return false;
            }
        ]
    }
});

parseResponse

Mengurai data respons API selama pelaporan otomatis. Mengekstrak msg dan code dari objek respons.

Default value:

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};
}

Timpa fungsi ini jika struktur respons API Anda berbeda.

sample

Mengontrol laju pengambilan sampel untuk log performa dan log API sukses. Laju pengambilan sampel = 1 / sample:

Pengambilan sampel mengurangi volume data dan overhead pengumpulan. Untuk mengurangi biaya, Anda juga dapat menggunakan parameter ignore untuk menghentikan pelaporan data yang tidak perlu dipantau. Untuk informasi lebih lanjut, lihat ignore.

ARMS melakukan kompensasi terhadap pengambilan sampel selama pemrosesan, sehingga metrik agregat seperti laju error JS dan laju kegagalan API tetap akurat. Namun, detail log individual mungkin hilang.

Untuk informasi lebih lanjut tentang metrik yang terpengaruh, lihat Metrik statistik.

pvSample

Mengontrol laju pengambilan sampel untuk log tampilan halaman (PV). Rumusnya sama seperti sample: laju pengambilan sampel = 1 / pvSample.

ARMS melakukan kompensasi terhadap pengambilan sampel selama pemrosesan, sehingga metrik agregat seperti laju error JS tetap akurat.

sendResource

Jika diatur ke true, melaporkan semua resource statis yang dimuat pada halaman saat event load. Gunakan grafik air terjun Pelacakan Sesi untuk mengidentifikasi resource yang menyebabkan pemuatan halaman lambat.

<script>
!(function(c,b,d,a){c[a]||(c[a]={});c[a].config={pid:"<your-pid>",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>

useFmp

Mengaktifkan pengumpulan data First Meaningful Paint (FMP) untuk analisis rendering layar pertama.

autoSendPerf

Mengontrol apakah log performa dikirim secara otomatis.

disableHook

Menonaktifkan pendengar permintaan AJAX. Secara default, SDK mencegat panggilan AJAX untuk melaporkan laju keberhasilan API.

enableLinkTrace

Mengaktifkan pelacakan front-to-back, menghubungkan permintaan browser dengan jejak sisi server. Untuk detailnya, lihat Gunakan fitur pelacakan front-to-back untuk mendiagnosis error API.

behavior

Merekam urutan aksi pengguna menjelang terjadinya error, membantu troubleshooting.

release

String versi aplikasi. Atur ini untuk membandingkan data pemantauan antar rilis berbeda.

environment

Label lingkungan penyebaran. Nilai yang valid:

disabled

Jika diatur ke true, menonaktifkan semua pelaporan log.

c1, c2, c3

Tiga bidang kustom yang dilampirkan pada setiap entri log. Membawa data spesifik bisnis seperti level VIP pengguna, grup uji A/B, atau flag fitur.

__bl.setConfig({
    c1: "premium",
    c2: "experiment-group-B",
    c3: "feature-darkmode"
});