Application Real-Time Monitoring Service:ビジネス パラメーターの抽出

• ルール名: ルールの名前。

• 属性名: スパン内のルールによって抽出された値に対応する属性の名前。デフォルトでは、値はプレフィックス biz. と複数の単語で構成されます。各単語には、文字、数字、ハイフン（-）、およびアンダースコア（_）のみを含めることができ、ピリオド（.）で区切る必要があります。属性名には最大 10 個の単語を使用できます。

• パラメーター抽出タイプ: 抽出するパラメーターのタイプ。

• 有効インターフェイス: ルールが適用される HTTP インターフェイス。ARMS エージェントは、一致するインターフェイスからのみパラメーターを抽出します。このパラメーターは、パラメーター抽出タイプ パラメーターが HTTP サーバー リクエストまたは HTTP サーバー 応答に設定されている場合にのみ有効です。

• 例外クラス名: 例外に関連するクラス名。ARMS エージェントは、一致する例外からのみパラメーターを抽出します。このパラメーターは、パラメーター抽出タイプ パラメーターが例外情報に設定されている場合にのみ有効です。

• テキスト エンコード タイプ: 抽出するパラメーターのエンコード形式。

• パラメーター抽出ルール: 抽出するパラメーターを含むソースと、パラメーターの抽出に使用するメソッド。複数のパラメーター ソースとパラメーター抽出ステップを指定できます。複数ソースからパラメーターを抽出できる場合、パラメーターはパラメーター抽出ステップの順序に基づいて抽出されます。詳細については、このトピックのビジネス パラメーター抽出ルールの例セクションをご参照ください。

  • パラメーター ソース: パラメーターを抽出するソース。ドロップダウン リストからヘッダー、Cookie、またはパラメーターを選択した場合は、初期抽出のキーを入力する必要があります。ドロップダウン リストから本文またはメッセージを選択した場合は、本文またはメッセージ全体からパラメーターが抽出されます。

  • パラメーター処理ステップを追加する: パラメーターを抽出するためのステップ。この構成は、1 つ以上のソースから取得するパラメーター値を解析するために使用されます。複数のパラメーター抽出ステップを指定できます。ステップの解析結果は、次のステップの入力になります。パラメーター抽出ステップを指定しない場合、取得されるパラメーター値は、ソースの JSON テキストです。詳細については、このトピックのパラメーター抽出ステップのベスト プラクティスセクションをご参照ください。

    次のパラメーター抽出メソッドがサポートされています。

    • Ognl: 入力パラメーターはオブジェクトである必要があります。ドット表記を使用する Object-Graph Navigation Language（OGNL）式がサポートされています。例: #this.data.getCode()。

    • JsonPath: 入力パラメーターは JSON 文字列である必要があります。ドット表記を使用する JsonPath 式がサポートされています。例: $.data.code。

    • Regex: 入力パラメーターは文字列である必要があります。名前付きキャプチャ グループに基づく正規表現がサポートされています。抽出される部分文字列は、res という名前のキャプチャ グループに対応します。例: .*from:(?<res>[a-z]+).*。

• 有効化ステータス: ルールを有効にするかどうかを指定します。

ルールの検証

アプリケーションのビジネス・パラメーター抽出ルールを設定した後、アプリケーションを再起動しなくてもルールは有効になります。 [トレースエクスプローラー] ページに移動して、関連するトレースを表示できます。対応するインターフェイスの スパン にカスタム属性が追加されている場合、ビジネス・パラメーター抽出ルールは有効になります。

1. 作成したルールに対応する属性の名前を見つけます。

   

2. [トレースエクスプローラー] ページで、attributes.$attributesName をフィルター条件として追加して、スパンをクエリします。

   

3. トレースをクリックして、スパンのカスタム属性を表示します。

   

ルールを管理する

• ルールを有効または無効にするには、ルールの 有効化ステータス スイッチをオンまたはオフにします。

• ルールを変更または削除するには、ルールの [操作] 列で [編集] または [削除] をクリックします。

• 複数のルールを一度に削除するには、ルールを選択し、ルール リストの下にある [一括削除] をクリックします。

• 複数のルールを一度に他のアプリケーションに同期するには、ルールを選択し、ルール リストの下にある [他のアプリケーションに一括コピー] をクリックします。 表示されるダイアログボックスで、ルールを他のすべてのアプリケーションに同期するか、特定のアプリケーションに同期するかを指定します。

  説明

  • 操作が有効になるまで 1 ～ 2 分待ちます。

  • ビジネス パラメーター抽出ルールのみが同期されます。 関連するエラーは同期されません。

  • ビジネス パラメーター抽出ルールに対応する属性の名前は一意である必要があります。 同じ名前の属性が宛先アプリケーションに既に存在する場合、ルールはアプリケーションに同期されません。

  

ビジネス パラメーター抽出ルールの例

@RestController
@RequestMapping("/components/api/v1/mall")
public class MallController {
  @RequestMapping("/product")
  @ResponseBody
  public ResponseBody product(@RequestBody RequestBody req) {
    // ビジネス コード
  }
  
  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

サンプル クラス

次のクラスには、アプリケーションの Body オブジェクトが含まれています。

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

extraInfo フィールドの cityInfo サブフィールドで「from」によって示される都市名を抽出します（次の図を参照）。

ARMS エージェントは、次の手順を実行してパラメーターを抽出します。

1. レスポンスから DemoResponse オブジェクトを取得します。

2. #this.getExtraInfo() 文を実行して、extraInfo フィールドを取得します。

3. $.cityInfo 文を実行して、extraInfo フィールドの値を JSON 文字列として解析し、cityInfo サブフィールドを取得します。

4. ^from:(?<res>[a-z]+).* 文を実行して、cityInfo サブフィールドの値を文字列として解析し、hangzhou 部分文字列である「res」という名前のキャプチャ グループと照合します。

5. 抽出結果として hangzhou を span の属性に書き込みます。

パラメータ抽出ステップ

仕組み

パラメータ抽出ステップを指定して、ソースから必要な情報をさらに取得および検索できます。これらのステップは、前のステップの出力が次のステップの入力として使用されるストリームマッピングルールと見なすことができます。

各パラメータ抽出メソッドは、入力データ型に固有の要件を課します。入力データ型が要件を満たしていない場合、後続の処理は終了し、現在の結果が最終値として記録されます。

パフォーマンスオーバーヘッド

パラメータ抽出ステップの実行は、シリアル化または逆シリアル化、Java リフレクション、および正規表現がこれらのステップに含まれるため、ビジネスパラメータ抽出プロセスで最も高いパフォーマンスオーバーヘッドが発生します。応答時間 ( RT ) とパフォーマンスに高い要件があるインターフェイスには、多数のステップを指定しないことをお勧めします。 RT とパフォーマンスに高い要件があるインターフェイスのパラメータを抽出する場合は、ビジネスコードを変更できます。

1. たとえば、セキュリティコンプライアンス要件が満たされている場合は、ビジネスコードのヘッダーにパラメータを書き込むことができます。

2. OpenTelemetry SDK for Java を使用してスパンの属性に手動でパラメータを書き込む方法については、「OpenTelemetry SDK for Java を使用してアプリケーションのカスタムイベントトラッキングコードを追加する」をご参照ください。

パラメータ抽出の有効な文

抽出ロジックのセキュリティを確保するために、ARMS は、オープンソースの OGNL、JsonPath、および正規表現よりもパラメータを抽出するための文に厳しい制限を課しています。