Memantau program mini DingTalk - Application Real-Time Monitoring Service

Topik ini menjelaskan cara menggunakan fitur pemantauan frontend dari Application Real-Time Monitoring Service (ARMS) untuk memantau program mini DingTalk. Topik ini juga mencakup konfigurasi umum, metode, dan skenario lanjutan terkait fitur tersebut.

Prosedur

Untuk memantau program mini DingTalk, impor dan inisialisasi paket npm yang diperlukan untuk pemantauan, instrumentasikan program mini untuk melaporkan log, lalu konfigurasikan domain keamanan.

Impor dan Inisialisasi Paket npm

Impor paket npm bernama arms/js-sdk ke dalam program mini DingTalk. Paket npm ini digunakan untuk melaporkan log.
```
npm install @arms/js-sdk                      
```

Tambahkan kode berikut ke file monitor.js di direktori /utils untuk menginisialisasi paket npm.

Catatan

Anda dapat menyesuaikan nama dan jalur penyimpanan file JS.

import EAppLogger from 'arms/js-sdk/miniapp';
const Monitor = EAppLogger.init({
    pid: 'xxx',
    region: "cn", // Wilayah tempat program mini diterapkan. Atur parameter wilayah ke cn jika program mini diterapkan di Tiongkok. Atur parameter wilayah ke sg jika program mini diterapkan di atau dekat Singapura. Atur parameter wilayah ke us jika program mini diterapkan di atau dekat Amerika Serikat.
});

export default Monitor;

Catatan

Untuk informasi lebih lanjut tentang pengaturan parameter, lihat Parameter SDK Umum.

Konfigurasikan Domain Keamanan
- Jika parameter region diatur ke cn, tambahkan arms-retcode.aliyuncs.com ke domain keamanan HTTP.
- Jika parameter region diatur ke sg, tambahkan arms-retcode-sg.aliyuncs.com ke domain keamanan HTTP.
- Jika parameter region diatur ke us, tambahkan arms-retcode-us.aliyuncs.com ke domain keamanan HTTP.

Metode API lainnya

Metode	Sintaks	Deskripsi
setCommonInfo	{[key: string]: string;}	Setel field log dasar untuk skenario seperti rilis canary.
setConfig	{[key: string]: string;}	Setel field config. Untuk informasi lebih lanjut, lihat Referensi SDK.
pageShow	{}	Instrumen log PV.
pageHide	{}	Instrumen log kesehatan.
error	String/Object	Instrumen log kesalahan.
api	Untuk informasi lebih lanjut, lihat Metode SDK.	Laporkan log permintaan API.
sum/avg	String	Laporkan log jumlah dan rata-rata kustom.

Skenario lanjutan

Berikut adalah beberapa skenario lanjutan yang dapat Anda gunakan jika metode dasar tidak memenuhi kebutuhan Anda:

Laporkan log permintaan API secara manual dengan pelaporan otomatis dinonaktifkan.
1. Atur parameter disableHook ke true. Log metode dd.httpRequest tidak dilaporkan secara otomatis.
2. Panggil metode api secara manual untuk melaporkan log permintaan API.
Nonaktifkan pelaporan otomatis dan aktifkan instrumentasi manual.
1. Metode hookApp dan hookPage tidak lagi digunakan di file app.js dan page.js.
2. Untuk melaporkan log PV halaman, panggil metode pageShow di metode onShow.
  Catatan
  Jangan panggil metode pageShow bersama dengan metode hookPage. Jika tidak, log PV dilaporkan berulang kali.
```
import Monitor from '/util/monitor';
Page({
    onShow: function() {
        Monitor.pageShow();
    }
})                         
```
3. Untuk melaporkan log kesehatan yang menunjukkan tingkat kesehatan dan waktu penelusuran di halaman, panggil metode pageHide di metode onHide dan onUnload.
  Catatan
  Jangan panggil metode pageHide bersama dengan metode hookPage. Jika tidak, log kesehatan dilaporkan berulang kali.
```
import Monitor from '/util/monitor';
  Page({

      onHide: function() {
          Monitor.pageHide();
      },
      onUnload: function() {
          Monitor.pageHide();
      }
      ... 
  })                    
```

Parameter SDK Umum

Fitur pemantauan frontend ARMS memungkinkan Anda mengatur berbagai parameter SDK untuk memenuhi persyaratan tambahan. Tabel berikut menjelaskan parameter umum yang sesuai untuk skenario yang dijelaskan dalam topik ini.


pid	String	ID unik proyek. Ini dibuat secara otomatis oleh ARMS saat membuat situs.	Ya	Tidak ada
uid	String	ID pengguna. Nilainya adalah pengenal pengguna dan dapat digunakan untuk mencari pengguna. Anda dapat menentukan nilai kustom. Jika Anda tidak menentukan parameter ini, SDK akan dibuat secara otomatis dan diperbarui setiap enam bulan.	Tidak	Dibuat secara otomatis oleh SDK
tag	String	Tag input. Setiap log membawa tag.	Tidak	Tidak ada
release	String	Versi aplikasi. Kami sarankan Anda mengonfigurasi parameter ini untuk melihat informasi laporan versi yang berbeda.	Tidak	`undefined`
environment	String	Bidang lingkungan. Nilai valid: prod, gray, pre, daily, dan local. Nilai prod menunjukkan lingkungan online. Nilai gray menunjukkan lingkungan rilis bertahap. Nilai pre menunjukkan lingkungan pra-produksi. 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 kinerja dan log API sukses diambil sampelnya pada rasio `1/sample`. Untuk informasi lebih lanjut tentang metrik log kinerja dan log API sukses, lihat Metrik statistik.	Tidak	`1`
behavior	Boolean	Menentukan apakah akan mencatat perilaku pengguna yang melaporkan kesalahan untuk mempermudah pemecahan masalah.	Tidak	`false`
enableLinkTrace	Boolean	Untuk informasi lebih lanjut tentang Analisis Tracing ujung-ke-ujung, lihat Gunakan fitur tracing ujung-ke-ujung untuk mendiagnosis kesalahan API.	Tidak	`false`

Fitur pemantauan frontend ARMS juga menyediakan parameter SDK lainnya untuk memenuhi kebutuhan bisnis Anda. Untuk informasi lebih lanjut, lihat Referensi SDK.