Application Real-Time Monitoring Service:Ekstrak parameter bisnis untuk aplikasi Java Anda

Aturan ekstraksi parameter

Tentukan sumber yang berisi parameter yang akan diekstrak dan metode ekstraksinya. Beberapa sumber parameter dan langkah pemrosesan didukung. Jika parameter dapat diekstrak dari beberapa sumber, ekstraksi dilakukan sesuai urutan langkah yang ditentukan. Untuk informasi selengkapnya, lihat Contoh aturan ekstraksi.

• Parameter Source: Sumber tempat parameter diekstrak. Jika Anda memilih Header, Cookie, atau Parameter, masukkan kunci untuk ekstraksi awal. Jika Anda memilih Body atau Message, parameter diekstrak dari seluruh body atau message.

• Add parameter processing steps: Tentukan langkah-langkah untuk mengurai nilai parameter dari satu atau beberapa sumber. Output setiap langkah menjadi input langkah berikutnya. Jika tidak ada langkah yang ditentukan, teks JSON mentah dari sumber digunakan. Untuk informasi selengkapnya, lihat Langkah ekstraksi parameter. Metode ekstraksi berikut didukung:

  Metode	Deskripsi	Contoh
  OGNL	Input harus berupa objek Java. Mendukung ekspresi OGNL dengan notasi titik.	#this.data.getCode()
  JsonPath	Input harus berupa string JSON. Mendukung ekspresi JsonPath dengan notasi titik.	$.data.code
  Regex	Input harus berupa string. Menggunakan grup penangkapan bernama. Substring yang diekstrak harus sesuai dengan grup penangkapan bernama res.	.*from:(?<res>[a-z]+).*

Buat aturan kode kesalahan kustom

1. Di bagian Customizing Error Settings, aktifkan sakelar Custom error code.

2. Klik Add matching rules.

3. Pilih aturan ekstraksi dan konfigurasikan kondisi filter.

   Setelah Anda mengaktifkan sakelar Custom error code, tambahkan aturan pencocokan: sebuah rentang ditandai sebagai kesalahan ketika nilai atribut biz.resp.body lebih besar dari 200, dan ketika nilai atribut biz.exception lebih besar dari 0.

4. Klik Save. Aturan berlaku dalam 1 hingga 2 menit tanpa restart aplikasi.

Verifikasi aturan kode kesalahan kustom

Setelah Anda mengonfigurasi aturan, periksa halaman Trace Explorer untuk rentang yang gagal dan sesuai dengan kondisi aturan.

1. Konfirmasi nama atribut dan kondisi yang digunakan oleh aturan.

2. Di halaman Trace Explorer, filter rentang yang gagal.

   Di halaman Trace Explorer, gunakan area filter cepat di sebelah kiri untuk memfilter rentang dengan status error. Kondisi kueri yang dihasilkan adalah serviceName="arms-custom-extraction-demoextracted" AND statusCode IN (2, 3) AND spanName="/api/v1/http_server/body". Dalam contoh ini, kueri mengembalikan 3.642 panggilan error, masing-masing dengan durasi 0 ms dan status error.

3. Klik jejak dan periksa apakah nilai atribut sesuai dengan kondisi aturan. Dalam contoh berikut, nilai atribut biz.resp.body adalah 670, yang lebih besar dari 499 (ambang batas yang ditentukan oleh aturan pencocokan error).

4. Di halaman Overview, verifikasi bahwa jumlah error tercermin dengan benar di dasbor error.

   

OGNL

Object-Graph Navigation Language (OGNL) membaca dan mengatur properti objek Java. Gunakan untuk mengekstrak bidang dari objek yang dianotasi dengan @ResponseBody atau @RequestBody. Hasilnya dikonversi ke string. Jika nilai yang diekstrak adalah objek Java, objek tersebut diserialisasi ke string JSON untuk ekstraksi lebih lanjut.

@RestController
@RequestMapping("/components/api/v1/mall")
public class MallController {
  @RequestMapping("/product")
  @ResponseBody
  public ResponseBody product(@RequestBody RequestBody req) {
    // Business code
  }

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

Ekstrak bidang requestId dari RequestBody.

Ekstrak bidang code dari ResponseBody.

Panggil metode getter untuk mengekstrak hasil dari getQueryJsonStr().

JsonPath

Ekspresi JsonPath mengekstrak properti dari string JSON.

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

Ekstrak data.age dari data JSON.

Regex

Ekspresi reguler mencocokkan kombinasi karakter dalam string. Gunakan grup penangkapan bernama res untuk menentukan hasil ekstraksi.

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

Ekstrak nilai cityCode dari URL.

Ekstraksi multi-langkah

Contoh ini merangkai OGNL, JsonPath, dan Regex untuk mengekstrak nilai bersarang dari badan tanggapan.

Kelas berikut berisi objek badan tanggapan:

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

Tujuan: Ekstrak nama kota yang ditunjukkan oleh "from" di sub-bidang cityInfo dari extraInfo.

Agen ARMS memproses ekstraksi dalam langkah-langkah berikut:

1. Ambil objek DemoResponse dari badan tanggapan.

2. Jalankan #this.getExtraInfo() (OGNL) untuk mendapatkan bidang extraInfo.

3. Jalankan $.cityInfo (JsonPath) untuk mengurai extraInfo sebagai JSON dan mendapatkan sub-bidang cityInfo.

4. Jalankan ^from:(?<res>[a-z]+).* (Regex) untuk mencocokkan grup penangkapan bernama res, yang mengembalikan hangzhou.

5. Tulis hangzhou sebagai nilai atribut pada rentang.

Cara kerja langkah

Langkah ekstraksi mengambil dan mengurai nilai dari data sumber. Langkah-langkah membentuk pipeline: output setiap langkah menjadi input langkah berikutnya.

Setiap metode memerlukan jenis input tertentu. Jika input tidak sesuai, pipeline berhenti dan mencatat hasil saat ini sebagai nilai akhir.

Batasan sintaksis

ARMS memberlakukan batasan sintaksis yang lebih ketat daripada OGNL, JsonPath, dan regex open-source untuk menjaga keamanan.

Pertimbangan performa

Langkah ekstraksi melibatkan serialisasi/deserialisasi, refleksi Java, dan pemrosesan regex—operasi paling intensif sumber daya dalam pipeline ekstraksi. Untuk antarmuka yang sensitif terhadap latensi, pertimbangkan alternatif berikut:

• Tulis parameter ke header HTTP dalam kode bisnis Anda (jika kepatuhan keamanan memungkinkan).

• Gunakan OpenTelemetry SDK untuk Java untuk menulis atribut langsung ke rentang. Untuk informasi selengkapnya, lihat Gunakan OpenTelemetry SDK untuk Java untuk menambahkan kode instrumentasi kustom pada aplikasi.

Apa yang harus saya lakukan jika ekstraksi parameter gagal?

Penyebabnya bergantung pada sumber parameter:

• Body: Pastikan Spring MVC digunakan, kelas memiliki anotasi @Controller, dan metode memiliki anotasi @RequestBody atau @ResponseBody.

• Response Cookie: Pastikan Anda menjalankan Tomcat v7.0.4-9.x atau Undertow v1.4.0.Final+. Jika tidak, gunakan request Cookie sebagai gantinya.

Apa cakupan ekstraksi pengecualian?

Agen ARMS untuk Java hanya menangkap pengecualian kustom yang dilempar di luar rentang. Untuk mengekstrak pengecualian dari metode panggilan utama di dalam rentang dan menandainya sebagai error, instrumentasikan metode panggilan tersebut. Untuk informasi selengkapnya, lihat Tambahkan metode kustom untuk pemantauan.

Bagaimana cara memetakan anotasi Spring MVC ke aturan ekstraksi?

Bagaimana cara mengekstrak jenis parameter yang tidak didukung?

Gunakan SDK OpenTelemetry untuk menginstrumentasi aplikasi Anda dan menulis parameter tersebut sebagai atribut rentang secara langsung. Untuk informasi selengkapnya, lihat Gunakan OpenTelemetry SDK untuk Java untuk menambahkan kode instrumentasi kustom ke jejak.

Apakah ekstraksi mendukung objek Body dengan RequestBodyAdvice dan ResponseBodyAdvice?

Ya. Agen ARMS mengekstrak parameter setelah BodyAdvice yang ditentukan pengguna dijalankan, tetapi sebelum BodyAdvice bawaan Spring.