Terapkan monitoring browser dengan npm SDK - Application Real-Time Monitoring Service

Untuk menggunakan fitur Pemantauan Browser dari Application Real-Time Monitoring Service (ARMS) dalam memantau aplikasi web, Anda perlu menginstal agen ARMS terlebih dahulu melalui Content Delivery Network (CDN) atau Node Package Manager (npm). Topik ini menjelaskan cara menginstal agen Pemantauan Browser ARMS untuk aplikasi web menggunakan npm.

Instalasi

Instal paket @arms/js-sdk dari repositori npm.

npm install @arms/js-sdk --save

Inisialisasi

Inisialisasi SDK menggunakan BrowserLogger.singleton.

const BrowserLogger = require('@arms/js-sdk');
const __bl = BrowserLogger.singleton(
  {
    pid:"your-project-id",
    appType:"web",
    imgUrl:"https://arms-retcode.aliyuncs.com/r.png?",
    // Pengaturan konfigurasi lainnya.
  }
);

Saat menginstal agen Pemantauan Browser ARMS melalui npm, kit pengembangan perangkat lunak (SDK) web secara otomatis menghasilkan ID pengguna (UID) untuk mengumpulkan informasi seperti jumlah pengunjung unik (UV). UID yang dihasilkan dapat digunakan untuk mengidentifikasi pengguna, tetapi tidak mencakup atribut bisnis. Untuk menyesuaikan UID, tambahkan kode berikut:

uid: 'xxx', // UID digunakan untuk mengidentifikasi pengguna. Atur nilainya sesuai kebutuhan.

Contoh:

const BrowserLogger = require('@arms/js-sdk');
const __bl = BrowserLogger.singleton(
  {
    pid:"your-project-id",
    appType:"web",
    uid: 'xxx',
    imgUrl:"https://arms-retcode.aliyuncs.com/r.png?",
    // Pengaturan konfigurasi lainnya.
  }
);

Referensi API

@static singleton(): mendapatkan objek singleton

Catatan

Metode ini hanya berlaku saat Anda mengimpor SDK menggunakan npm.

Sintaksis: BrowserLogger.singleton(config,prePipe)

Ini adalah metode statis yang mengembalikan objek singleton. Parameter config dan prePipe hanya berlaku pada pemanggilan pertama. Pemanggilan berikutnya hanya akan mengembalikan instans yang telah dibuat.

Parameter	Tipe	Deskripsi	Wajib	Nilai default
config	Object	Konfigurasi situs. Untuk informasi mengenai item konfigurasi lainnya dalam config, lihat Referensi SDK.	Ya	Tidak ada
prePipe	Array	Konten yang akan dilaporkan sebelumnya.	Tidak	Tidak ada

Anda dapat menggunakan metode ini untuk menginisialisasi SDK pada titik masuk aplikasi atau mendapatkan instans pada setiap pemanggilan.

API pelaporan lainnya

Dapatkan instans menggunakan BrowserLogger.singleton.

const __bl = BrowserLogger.singleton();

Untuk informasi selengkapnya mengenai API lain dari __bl, lihat Referensi API frontend.

Konfigurasi Config

Parameter config sama dengan parameter yang digunakan pada impor CDN. Untuk informasi selengkapnya, lihat Referensi SDK.

Pelaporan awal

Untuk melaporkan data dari logika yang dieksekusi sebelum pemanggilan BrowserLogger.singleton(), Anda harus menggunakan fitur pelaporan awal. Untuk informasi selengkapnya, lihat Laporkan data sebelumnya.

const BrowserLogger = require('@arms/js-sdk');
                // Struktur pipe sama dengan impor CDN.
                const pipe = [
                // Laporkan halaman HTML saat ini sebagai API.
                ['api', '/index.html', true, performance.now, 'SUCCESS'], // Ini setara dengan __bl.api(api, success, time, code, msg).
                // Setelah SDK diinisialisasi, penguraian SPA otomatis diaktifkan.
                ['setConfig', {enableSPA: true}]
                ];
                const __bl = BrowserLogger.singleton({pid:'ID situs unik'},pipe);

Item konfigurasi SDK umum

Pemantauan Browser menyediakan serangkaian item konfigurasi SDK yang dapat disesuaikan untuk memenuhi kebutuhan tertentu. Tabel berikut menjelaskan item konfigurasi umum tersebut.


pid	String	ID unik proyek. ID ini dihasilkan secara otomatis oleh ARMS saat membuat situs.	Ya	Tidak ada
uid	String	ID pengguna. Nilainya merupakan pengenal pengguna dan dapat digunakan untuk mencari pengguna tersebut. Anda dapat menentukan nilai khusus. Jika Anda tidak menentukan parameter ini, SDK akan menghasilkan dan memperbarui nilai tersebut secara otomatis setiap enam bulan.	Tidak	Dihasilkan secara otomatis oleh SDK
tag	String	Tag input. Setiap log membawa tag.	Tidak	Tidak ada
release	String	Versi aplikasi. Kami merekomendasikan agar Anda mengonfigurasi parameter ini untuk melihat informasi laporan dari versi yang berbeda.	Tidak	`undefined`
environment	String	Bidang lingkungan. Nilai yang valid: prod, gray, pre, daily, dan local. Nilai prod menunjukkan lingkungan online. Nilai gray menunjukkan lingkungan rilis bertahap. Nilai pre menunjukkan lingkungan staging. Nilai daily menunjukkan lingkungan harian. Nilai local menunjukkan lingkungan lokal.	Tidak	`prod`
sample	Integer	Konfigurasi pengambilan sampel log. Nilainya adalah bilangan bulat dari 1 hingga 100. Log performa dan log API sukses diambil sampelnya dengan rasio `1/sample`. Untuk informasi selengkapnya mengenai metrik log performa dan log API sukses, lihat Metrik statistik.	Tidak	`1`
behavior	Boolean	Menentukan apakah akan mencatat perilaku pengguna yang melaporkan error untuk mempermudah pemecahan masalah.	Tidak	`true`
enableSPA	Boolean	Mendengarkan event hashchange pada halaman dan melaporkan PV lagi. Ini berlaku untuk skenario aplikasi halaman tunggal.	Tidak	`false`
enableLinkTrace	Boolean	Untuk informasi selengkapnya mengenai Analisis Tracing back-to-back, lihat Gunakan fitur tracing front-to-back untuk mendiagnosis error API.	Tidak	`false`

Pemantauan Browser juga menyediakan item konfigurasi SDK tambahan untuk kebutuhan lanjutan. Untuk informasi selengkapnya, lihat Referensi SDK.