Application Real-Time Monitoring Service：Konfigurasi contoh SDK RUM untuk mini program

Parameter SDK

pengguna parameter

Contoh

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  user: {
    name: getYourUserName(),
    tags: getYourTags(),
  }
});

parameter reportConfig

Contoh

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  reportConfig: {
    flushTime: 0, // Tentukan bahwa data dilaporkan segera.
    maxEventCount: 50 // Tentukan jumlah maksimum entri data yang dilaporkan dalam satu waktu.
  }
});

KonfigurasiSesi parameter

ID pengguna dan informasi sesi disimpan dalam cache lokal mini program:

• _arms_uid: ID pengguna unik (user.id).

• _arms_session: informasi sesi semantik.

  • sessionId: ID sesi unik.

  • sampled: menunjukkan apakah sampling telah dipicu.

  • startTime: timestamp awal sesi.

  • lastTime: timestamp ketika sesi terakhir aktif.

`${sessionId}-${sampled}-${startTime}-${lastTime}`

Contoh

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  sessionConfig: {
    sampleRate: 0.5, // Tentukan laju sampling 50%. 
    maxDuration: 86400000,
    overtime: 3600000,
  },
});

pengumpul parameter

SDK menggunakan collector seperti API dan static Resource untuk mengumpulkan data pemantauan halaman.

Contoh

Pada contoh berikut, pengumpulan data interaksi pengguna dinonaktifkan.

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  collectors: {
    action: false,
  }
});

evaluateApi parameter

Fungsi evaluateApi memberikan penguraian kustom untuk peristiwa API, termasuk peristiwa request dan httpRequest.

Fungsi ini dapat dipanggil secara asinkron. Promise<IApiBaseAttr> dikembalikan. Tabel berikut menjelaskan IApiBaseAttr.

Contoh

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  evaluateApi: async (options, response, error) => {
    const respText = JSON.stringify(response);

    // Bidang yang dikembalikan akan menimpa konten default. Jika bidang tidak dikembalikan, konten default digunakan.
    return {
      name: 'my-custom-api',
      success: error ? 0 : 1,
      snapshots: JSON.stringify({
        params: 'page=1&size=10', // Parameter input.
        response: respText.substring(0, 2000), // Nilai yang dikembalikan.
        reqHeaders: '', // Header permintaan.
        resHeaders: '' // Header respons.
      })
    }
  }
});

parameter filters

Parameter filters mengecualikan peristiwa sumber daya dan pengecualian yang tidak perlu dilaporkan.

MatchOption

type MatchOption = string | RegExp | ((value: string) => boolean);

• string: cocokkan URL apa pun yang dimulai dengan nilai yang ditentukan. Sebagai contoh, https://api.aliyun.com dapat cocok dengan https://api.aliyun.com/v1/resource.

• RegExp: tentukan ekspresi reguler dan URL.

• function: gunakan fungsi untuk menentukan apakah URL cocok. Jika true dikembalikan, URL cocok.

Ketika input adalah MatchOption[], kondisi sebelumnya dievaluasi secara berurutan, dan akan dikecualikan jika salah satu kondisi terpenuhi.

Contoh

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  filters: {
    // Kecualikan peristiwa pengecualian
    exception: [
      'Test error', // Filter pesan kesalahan yang dimulai dengan 'Test error'.
      /^Script error\.?$/, // Tentukan ekspresi reguler.
      (msg) => {
        return msg.includes('example-error');
      },
    ],
    // Kecualikan peristiwa sumber daya atau API
    resource: [
      'https://example.com/', // Filter sumber daya yang dimulai dengan 'https://example.com/'.
      /localhost/i,
      (url) => {
        return url.includes('example-resource');
      },
    ],
  },
});

parameter properties

Properti yang disediakan oleh RUM dapat dikonfigurasikan untuk semua peristiwa.

Anda dapat menggunakan evaluateApi, sendCustom, sendException, dan sendResource untuk menambahkan properti ke peristiwa. Properti tersebut hanya berlaku untuk peristiwa itu.

Properti global dan properti peristiwa digabungkan saat disimpan. Properti peristiwa memiliki prioritas lebih tinggi daripada properti global. Jika kunci properti peristiwa sama dengan kunci properti global, properti peristiwa menimpa properti global. Jumlah pasangan kunci-nilai tidak boleh melebihi 20 setelah digabungkan. Jika jumlahnya melebihi 20, pasangan diurutkan berdasarkan kunci dan yang berlebih dihapus.

Contoh

Properti yang dikonfigurasikan secara global dilampirkan ke semua peristiwa yang dilaporkan.

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  properties: {
    prop_string: 'xx',
    prop_number: 2,
    // Jika panjang kunci atau nilai melebihi batas, bagian yang berlebih dipotong.
    more_than_50_key_limit_012345678901234567890123456789: 'yy',
    more_than_2000_value_limit: new Array(2003).join('1'),
    // Pasangan kunci-nilai berikut yang tidak valid akan dihapus.
    prop_null: null,
    prop_undefined: undefined,
    prop_bool: true,
  },
});

Parameter Lainnya

SDK RUM memungkinkan Anda mengonfigurasi properti umum yang diselesaikan berdasarkan alamat IP dan UserAgent. Parameter yang dikonfigurasi secara proaktif memiliki prioritas lebih tinggi daripada parameter yang diselesaikan secara otomatis.

Untuk informasi lebih lanjut tentang item konfigurasi terkait parameter di atas, lihat Atribut umum.

Contoh

ArmsRum.init({
  pid: "your app id",
  endpoint: "your endpoint",
  geo: {
    country: 'informasi negara kustom Anda',
    city: 'informasi kota kustom Anda',
  },
});

API SDK

SDK menyediakan API untuk memodifikasi dan melaporkan data kustom serta memodifikasi konfigurasi SDK secara dinamis.

getConfig

Gunakan fungsi ini untuk mendapatkan konfigurasi SDK.

setConfig

Gunakan fungsi ini untuk memodifikasi konfigurasi SDK.

// Tetapkan kunci tertentu
ArmsRum.setConfig('env', 'pre');

// Timpa pengaturan berikut
const config = ArmsRum.getConfig();
ArmsRum.setConfig({
  ...config,
  version: '1.0.0',
  env: 'pre',
});

sendCustom

Untuk melaporkan data kustom, tentukan parameter type dan name. Tabel berikut menjelaskan parameter terkait pelaporan data. Definisikan semantik bisnis Anda.

ArmsRum.sendCustom({
  type: 'CustomEvnetType1',
  name: 'customEventName2',
  group: 'customEventGroup3',
  value: 111.11
});

sendException

Untuk melaporkan data pengecualian kustom, tentukan parameter name dan message.

ArmsRUM.sendException({
  // Diperlukan.
  name: 'customErrorName',
  message: 'custom error message',
  // Opsional.
  file: 'custom exception filename',
  stack: 'custom exception error.stack',
  line: 1,
  column: 2
});

sendResource

Untuk melaporkan data sumber daya kustom, tentukan parameter name, type, dan duration.

ArmsRum.sendResource({
  // Diperlukan.
  name: 'getListByPage',
  message: 'success',
  duration: 800,
  // Opsional.
  url: 'https://www.aliyun.com/data/getListByPage',
});