Application Real-Time Monitoring Service：Ekstrak parameter bisnis

• Nama Aturan: Nama aturan.

• Nama Atribut: Nama atribut yang sesuai dengan nilai yang diekstrak oleh aturan dalam span. Secara default, nilai terdiri dari awalan biz. dan beberapa kata. Setiap kata hanya dapat berisi huruf, angka, tanda hubung (-), dan garis bawah (_) dan harus dipisahkan oleh titik (.). Maksimal 10 kata diizinkan dalam nama atribut.

• Tipe Ekstraksi Parameter: Tipe parameter yang ingin Anda ekstrak.

• Antarmuka Efektif: Antarmuka HTTP tempat aturan berlaku. ARMS agent mengekstrak parameter hanya dari antarmuka yang cocok. Parameter ini valid hanya jika parameter Tipe Ekstraksi Parameter diatur ke Permintaan Server HTTP atau Tanggapan Server HTTP.

• Nama Kelas Pengecualian: Nama kelas terkait pengecualian. ARMS agent mengekstrak parameter hanya dari pengecualian yang cocok. Parameter ini valid hanya jika parameter Tipe Ekstraksi Parameter diatur ke Informasi Pengecualian.

• Tipe Pengkodean Teks: Format encoding parameter yang ingin Anda ekstrak.

• Aturan Ekstraksi Parameter: Sumber yang berisi parameter yang ingin Anda ekstrak dan metode yang ingin Anda gunakan untuk mengekstrak parameter. Anda dapat menentukan beberapa sumber parameter dan langkah-langkah ekstraksi parameter. Jika parameter dapat diekstrak dari beberapa sumber, parameter diekstrak berdasarkan urutan langkah-langkah ekstraksi parameter. Untuk informasi lebih lanjut, lihat bagian Contoh Aturan Ekstraksi Parameter Bisnis dari topik ini.

  • Sumber Parameter: Sumber dari mana Anda ingin mengekstrak parameter. Jika Anda memilih Header, Cookie, atau Parameter dari daftar drop-down, Anda harus memasukkan kunci untuk ekstraksi awal. Jika Anda memilih Body atau Message dari daftar drop-down, parameter diekstrak dari seluruh body atau pesan.

  • Tambahkan Langkah-Langkah Pemrosesan Parameter: Langkah-langkah untuk mengekstrak parameter. Konfigurasi ini digunakan untuk mengurai nilai parameter yang ingin Anda peroleh dari satu atau lebih sumber. Anda dapat menentukan beberapa langkah ekstraksi parameter. Hasil penguraian suatu langkah adalah input dari langkah berikutnya. Jika Anda tidak menentukan langkah ekstraksi parameter, nilai parameter yang diperoleh adalah teks JSON dari sumber. Untuk informasi lebih lanjut, lihat bagian Praktik Terbaik untuk Langkah-Langkah Ekstraksi Parameter dari topik ini.

    Metode ekstraksi parameter berikut didukung:

    • Ognl: Parameter input harus berupa objek. Ekspresi Object-Graph Navigation Language (OGNL) yang menggunakan notasi titik didukung. Contoh: #this.data.getCode().

    • JsonPath: Parameter input harus berupa string JSON. Ekspresi JsonPath yang menggunakan notasi titik didukung. Contoh: $.data.code.

    • Regex: Parameter input harus berupa string. Ekspresi reguler yang berbasis grup penangkapan bernama didukung. Substring yang akan diekstrak sesuai dengan grup penangkapan bernama res. Contoh: .*from:(?<res>[a-z]+).*.

• Status Pengaktifan: Menentukan apakah akan mengaktifkan aturan.

Verifikasi aturan

Setelah Anda mengonfigurasi aturan ekstraksi parameter bisnis untuk aplikasi, aturan berlaku tanpa perlu me-restart aplikasi. Anda dapat pergi ke halaman Trace Explorer untuk melihat jejak terkait. Jika atribut kustom ditambahkan ke span antarmuka yang sesuai, aturan ekstraksi parameter bisnis berlaku.

1. Temukan nama atribut yang sesuai dengan aturan yang Anda buat.

   

2. Di halaman Trace Explorer, tambahkan attributes.$attributesName sebagai kondisi filter untuk menanyakan spans.

   

3. Klik jejak untuk melihat atribut kustom dari span.

   

Kelola aturan

• Untuk mengaktifkan atau menonaktifkan aturan, nyalakan atau matikan sakelar Status Pengaktifan untuk aturan.

• Untuk memodifikasi atau menghapus aturan, klik Edit atau Hapus di kolom Tindakan Aturan.

• Untuk menghapus beberapa aturan sekaligus, pilih aturan dan klik Hapus Massal di bawah daftar aturan.

• Untuk menyinkronkan beberapa aturan ke aplikasi lain sekaligus, pilih aturan dan klik Salin Massal ke Aplikasi Lain di bawah daftar aturan. Di kotak dialog yang muncul, tentukan apakah akan menyinkronkan aturan ke semua aplikasi lain atau aplikasi tertentu.

  Catatan

  • Tunggu 1 hingga 2 menit agar operasi berlaku.

  • Hanya aturan ekstraksi parameter bisnis yang disinkronkan. Kesalahan terkait tidak disinkronkan.

  • Nama atribut yang sesuai dengan aturan ekstraksi parameter bisnis harus unik. Jika atribut dengan nama yang sama sudah ada di aplikasi tujuan, aturan tidak disinkronkan ke aplikasi.

  

Contoh aturan ekstraksi parameter bisnis

@RestController
@RequestMapping("/components/api/v1/mall")
public class MallController {
  @RequestMapping("/product")
  @ResponseBody
  public ResponseBody product(@RequestBody RequestBody req) {
    // Kode bisnis
  }
  
  static class RequestBody {
    String requestId;
    Map<String, String> queryParam;
    
    public String getQueryJsonStr() {
      return JSON.toJsonString(queryParam);
    }
  }
  
  static class ResponseBody {
    int code;
    boolean success;
    String message;
  }
}

{
  "code": 200,
  "message": "Query success.",
  "success": true,
  "data": {
    "name": "John",
    "age": 21
  }
}

https://test.aliyun.com/v2/workitem#requestId=0c978f115b6f7&cityCode=34&env=online

Kelas sampel

Kelas berikut berisi objek Body dari aplikasi:

class DemoResponse {
    int code = 200;
    boolean success = true;
    String message = "text content";
    String extraInfo = "{\"id\": 15, \"cityInfo\": \"from:hangzhou,to:beijing\"}";

    public String getExtraInfo() {
        return this.extraInfo;
    }
}

Ekstrak nama kota yang ditunjukkan oleh "from" di sub-bidang cityInfo dari bidang extraInfo, seperti yang ditunjukkan pada gambar berikut.

ARMS agent melakukan langkah-langkah berikut untuk mengekstrak parameter:

1. Dapatkan objek DemoResponse dari respons.

2. Eksekusi pernyataan #this.getExtraInfo() untuk mendapatkan bidang extraInfo.

3. Eksekusi pernyataan $.cityInfo untuk mengurai nilai bidang extraInfo sebagai string JSON dan mendapatkan sub-bidang cityInfo.

4. Eksekusi pernyataan ^from:(?<res>[a-z]+).* untuk mengurai nilai sub-bidang cityInfo sebagai string dan mencocokkannya dengan grup penangkapan bernama "res", yaitu substring hangzhou.

5. Tulis hangzhou sebagai hasil ekstraksi ke atribut span.

Langkah-langkah ekstraksi parameter

Cara kerjanya

Anda dapat menentukan langkah-langkah ekstraksi parameter untuk lebih mengambil dan mencari informasi yang diperlukan dari sumber. Langkah-langkah ini dapat dianggap sebagai aturan pemetaan aliran di mana output langkah sebelumnya digunakan sebagai input langkah berikutnya.

Setiap metode ekstraksi parameter memberlakukan persyaratan unik pada tipe data input. Jika tipe data input tidak memenuhi persyaratan, proses berikutnya dihentikan dan hasil saat ini dicatat sebagai nilai akhir.

Overhead kinerja

Eksekusi langkah-langkah ekstraksi parameter menimbulkan overhead kinerja tertinggi dalam proses ekstraksi parameter bisnis karena melibatkan serialisasi atau deserialisasi, refleksi Java, dan ekspresi reguler dalam langkah-langkah ini. Kami merekomendasikan agar Anda tidak menentukan banyak langkah untuk antarmuka yang memiliki persyaratan tinggi pada waktu respons (RT) dan kinerja. Jika Anda ingin mengekstrak parameter untuk antarmuka yang memiliki persyaratan tinggi pada RT dan kinerja, Anda dapat memodifikasi kode bisnis Anda.

1. Sebagai contoh, jika persyaratan kepatuhan keamanan terpenuhi, Anda dapat menulis parameter ke header dalam kode bisnis Anda.

2. Untuk informasi tentang cara menulis parameter secara manual ke atribut span menggunakan OpenTelemetry SDK untuk Java, lihat Gunakan OpenTelemetry SDK untuk Java untuk menambahkan kode instrumen kustom untuk aplikasi.

Pernyataan valid untuk ekstraksi parameter

Untuk memastikan keamanan logika ekstraksi, ARMS memberlakukan batasan yang lebih ketat pada pernyataan untuk mengekstrak parameter daripada OGNL open source, JsonPath, dan ekspresi reguler.