すべてのプロダクト
Search

このプロダクト

    Application Real-Time Monitoring Service:SaveTraceAppConfig

    ドキュメントセンター

    Application Real-Time Monitoring Service:SaveTraceAppConfig

    最終更新日:Apr 10, 2026

    トレースサンプリングやエージェントスイッチの設定など、アプリケーションモニタリングの設定を変更します。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Pid

    string

    必須

    アプリケーションのプロセス ID (PID) です。

    ARMS コンソールにログインします。左側のナビゲーションウィンドウで、[アプリケーションモニタリング] > [アプリケーションリスト] を選択します。[アプリケーションリスト] ページで、アプリケーションの名前をクリックします。アドレスバーの URL に、アプリケーションの PID が含まれています。PID は `pid=xxx` の形式で表示されます。PID は通常、`xxx%40xxx` のようにパーセントエンコーディングされています。この値を変更して、パーセントエンコーディングを削除する必要があります。たとえば、URL の PID が `xxx%4074xxx` の場合、`%40` をアットマーク (@) に置き換えて `xxx@74xxx` を取得する必要があります。

    a2n80plglh@745eddxxx
    Settings

    array<object>

    任意

    アプリケーションモニタリングの設定項目です。

    object

    任意

    Key

    string

    任意

    変更する設定項目のキーです。サポートされている設定項目の詳細については、次のセクションをご参照ください。

    • トレースサンプリング設定

    • エージェントスイッチ設定

    • しきい値設定

    • 詳細設定

    • スレッド設定

    • メモリスナップショット設定

    • URL 収束設定

    • ビジネスログ関連付け設定

    sampling.enable
    Value

    string

    任意

    変更する設定項目の値です。サポートされている設定項目の詳細については、次のセクションをご参照ください。

    • トレースサンプリング設定

    • エージェントスイッチ設定

    • しきい値設定

    • 詳細設定

    • スレッド設定

    • メモリスナップショット設定

    • URL 収束設定

    • ビジネスログ関連付け設定

    true

    トレースサンプリング設定

    キー説明値
    sampling.enableサンプリングスイッチをオンにするかどうかを指定します。有効値：- true：サンプリングスイッチをオンにします- false：サンプリングスイッチをオフにします
    sampling.rateサンプリングレートです。有効値：0～100。デフォルト値：10。

    エージェントスイッチ設定

    キー説明値
    enableエージェントスイッチをオンにするかどうかを指定します。有効値：- true：エージェントスイッチをオンにします- false：エージェントスイッチをオフにします

    しきい値設定

    キー説明値
    thresholds.limit速度制限のしきい値です。デフォルト値：100。
    thresholds.interfaceAPI 呼び出しの応答時間のしきい値です。デフォルト値：500。単位：ms。
    thresholds.sql低速 SQL クエリの所要時間のしきい値です。デフォルト値：500。単位：ms。

    詳細設定

    キー説明値
    defined.excludeurl除外する無効な API 呼び出しです。複数の API 呼び出しはコンマ (,) で区切ります。デフォルト値：/**/*.jpg,/**/*.png,/**/*.js,/**/*.jpeg。例：/service/taobao,/service/status。
    callstack.maxLengthメソッドスタックの最大長です。デフォルト値：128。最大値：400。
    exception.stacktraceシステムが同じ種類の例外を識別する基準となるスタックの深さです。デフォルト値：2。システムは、指定されたスタックの深さに基づいて同じ種類の例外を識別します。値を変更すると、予期しない統計が発生する可能性があります。注意して実行してください。
    callsql.maxLength収集される SQL ステートメントの最大長です。収集される SQL ステートメントは、256～4096 文字である必要があります。デフォルト値：1024。
    jdbc.tracesqlbindvaluePrepareStatement パラメーターにバインドされた変数をキャプチャするかどうかを指定します。有効値：-true：PrepareStatement パラメーターにバインドされた変数をキャプチャするスイッチをオンにします- false：PrepareStatement パラメーターにバインドされた変数をキャプチャするスイッチをオフにします
    jdbc.tracesqlrawRAW SQL ステートメントをキャプチャするかどうかを指定します。有効値：- true：RAW SQL ステートメントをキャプチャするスイッチをオンにします- false：RAW SQL ステートメントをキャプチャするスイッチをオフにします
    exception.whitelist除外する例外です。値は、例外カテゴリの名前を指定する正規表現である必要があります。複数の例外カテゴリはコンマ (,) で区切ります。例：java.lang.InterrupetedException,java.lang.IndexOutOfBoundsException。指定したカテゴリの例外は、[アプリケーション詳細] ページと [例外診断] ページのチャートには表示されません。
    error.skip除外するエラーです。デフォルトでは、400 を超えるすべての HTTP ステータスコードがエラーとしてカウントされます。400 を超える特定の HTTP ステータスコードを無視するには、このキーの値として指定します。これにより、エラーとしてカウントされなくなります。複数の HTTP ステータスコードはコンマ (,) で区切ります。例：429 および 429,512。このキーは、エージェントバージョン 2.5.7.2 以降でサポートされています。
    compress.enableトレース圧縮スイッチをオンにするかどうかを指定します。有効値：- true：トレース圧縮スイッチをオンにします- false：トレース圧縮スイッチをオフにします
    param.maxLengthリクエストパラメーターの最大長です。デフォルト値：512。値がデフォルト値より大きい場合、追加のシステムリソースが消費されます。このキーを設定する際は注意してください。
    quantile.enable分位数統計スイッチをオンにするかどうかを指定します。有効値：- true：分位数統計スイッチをオンにします- false：分位数統計スイッチをオフにします
    threadpoolmonitor.enableスレッドプールと接続プールのモニタリングを有効にするかどうかを指定します。このキーの設定は、アプリケーションを再起動した後に有効になります。有効値：- true：スレッドプールと接続プールのモニタリングを有効にします- false：スレッドプールと接続プールのモニタリングを無効にします
    async.autoTransmit自動非同期伝播スイッチをオンにするかどうかを指定します。このキーは、エージェントバージョンが 2.8.3 以降の場合にのみ有効です。このキーの設定は、アプリケーションを再起動した後に有効になります。この機能は、スレッドプールに送信された Runnable タスクと Callable タスクをカプセル化して、コンテキストを伝播します。潜在的なリスクが発生する可能性があります。このキーを設定する際は注意してください。有効値：-true：自動非同期伝播スイッチをオンにします- false：自動非同期伝播スイッチをオフにします
    thread.match.package非同期伝播用のパッケージ名です。このキーは、エージェントバージョンが 2.7.1.3 以降の場合にのみ有効です。このキーの設定は、アプリケーションを再起動した後に有効になります。指定されたパッケージの下で Runnable、Callable、Supplier が作成されると、トレースコンテキストが自動的にキャプチャされ、新しいスレッドに伝播されます。複数のパッケージ名はコンマ (,) で区切ります。
    responseInject.enableリクエストでトレース ID を返すスイッチをオンにするかどうかを指定します。有効値：- true：スイッチをオンにします- false：スイッチをオフにします

    スレッド設定

    キー説明値
    tprof.enableThreadProfilerスレッドプロファイリングのメインスイッチをオンにするかどうかを指定します。有効値：- true：スイッチをオンにします- false：スイッチをオフにしますこのスイッチをオンにすると、低速 API 呼び出しのネイティブメソッドスタックが自動的に保存されます。
    tprof.threadProfilerSlowInteractionRt低速 API 呼び出しの所要時間のしきい値です。デフォルト値：2000。低速 API 呼び出しの所要時間がしきい値を超えると、スレッドプロファイリングが有効になります。値は、所要時間の 99 パーセンタイルに設定することを推奨します。2000 より小さい値を設定すると、CPU 消費量が増加します。500 以上の値を設定することを推奨します。
    tprof.enableThreadStackRecorderメソッドスタックのスレッドプロファイリングを有効にするかどうかを指定します。有効値：- true：メソッドスタックのスレッドプロファイリングを有効にします- false：メソッドスタックのスレッドプロファイリングを無効にしますスレッドプロファイリングを有効にすると、メソッドスタックは 5 分ごとに収集されます。

    ビジネスログ関連付け設定

    キー説明値
    logging.enableトレース ID をビジネスログに関連付けるスイッチをオンにするかどうかを指定します。有効値：- true：スイッチをオンにします- false：スイッチをオフにしますこのスイッチをオンにすると、アプリケーションのビジネスログにトレース ID が自動的に生成されます。この設定は、アプリケーションを再起動した後に有効になります。Log4j、Log4j2、Logback などのロギングユーティリティがサポートされています。トレース ID を生成するには、ログレイアウトに %X{EagleEye-TraceID} を追加する必要があります。
    SLS.project現在のリージョンで生成されたビジネスログを格納する Simple Log Service プロジェクトです。現在のリージョンで生成されたビジネスログを格納する Simple Log Service プロジェクトの名前を指定できます。
    SLS.logStore現在のリージョンで生成されたビジネスログを格納する Simple Log Service Logstore です。現在のリージョンで生成されたビジネスログを格納する Simple Log Service Logstore の名前を指定できます。
    SLS.index現在のリージョンで生成されたビジネスログのインデックスのタイプです。有効値：- フルテキストインデックスを使用する場合は、このキーを設定しないでください。- フィールド固有のインデックスを使用する場合は、値をフィールド名に設定します。例：SLS.index: tag。フィールド固有のインデックスとフルテキストインデックスの違いの詳細については、「インデックスの設定」をご参照ください。

    URL 収束設定

    キー説明値
    convergence.enableURL 収束機能を有効にするかどうかを指定します。有効値：- true：URL 収束機能を有効にします- false：URL 収束機能を無効にします
    convergence.minServerSize収束のしきい値です。しきい値を超えると、収束が実行されます。
    convergence.pattern収束ルールの正規表現です。正規表現を使用して収束ルールを設定できます。複数の正規表現はコンマ (,) で区切ります。元のテキストに URL を入力して、URL が収束されないことを示します。例：/service/(.*?)/demo。

    Arthas 診断設定

    注意：Arthas 診断設定は、エージェントバージョンが 2.7.1.3 以降の場合にのみ有効です。その他の前提条件の詳細については、「Arthas 診断」をご参照ください。

    キー説明値
    arthas.enableArthas スイッチをオンにするかどうかを指定します。有効値：- true：Arthas スイッチをオンにします- false：Arthas スイッチをオフにします
    arthas.enableIpsArthas 診断機能が有効になっている IP アドレスです。このキーを設定すると、Arthas 診断機能は指定された IP アドレスでのみ有効になります。このキーを設定しない場合、Arthas 診断機能はデフォルトですべての IP アドレスで有効になります。複数の IP アドレスはコンマ (,) で区切ります。

    継続的プロファイリング設定

    注意：継続的プロファイリング設定は、エージェントバージョンが 2.7.3.5 以降の場合にのみ有効です。その他の前提条件の詳細については、「継続的プロファイリング」をご参照ください。

    キー説明値
    cp.enable継続的プロファイリングスイッチをオンにするかどうかを指定します。有効値：- true：継続的プロファイリングスイッチをオンにします- false：継続的プロファイリングスイッチをオフにします* このスイッチをオンにする場合は、スイッチが有効になる IP アドレスを設定する必要があります。そうしないと、スイッチは有効になりません。IP アドレスは、次の 2 つのモードで設定できます。
    モードキー説明値
    IP アドレスホワイトリストcp.allowIPsIP アドレスホワイトリスト継続的プロファイリングが有効になっているインスタンスの IP アドレスです。複数の IP アドレスはコンマ (,) で区切ります。例：192.168.0.1,192.168.0.2
    cp.allowNetworkCIDR ブロック空の文字列を指定します。そうしないと、継続的プロファイリングが正常に機能しません。
    CIDR ブロックcp.allowIPsIP アドレスホワイトリスト空の文字列を指定します。そうしないと、継続的プロファイリングが正常に機能しません。
    cp.allowNetworkCIDR ブロック継続的プロファイリングが有効になっているインスタンスの CIDR ブロックです。例：192.168.2.0/24/24

    データマスキング設定 注意：データマスキング設定は、エージェントバージョンが 2.9.0 以降の場合にのみ有効です。

    キー説明値
    sanitizer.enableデータマスキングスイッチをオンにするかどうかを指定します。有効値：- true：データマスキングスイッチをオンにします- false：データマスキングスイッチをオフにします
    sanitizer.keysデータマスキングルールです。例に示すように、データマスキングのルールを指定できます。指定されたルールは、完全一致のキーとして使用されます。たとえば、password を指定した場合、ルールは正規表現 .*password.* と同等です。キーでは大文字と小文字は区別されません。複数のルールはコンマ (,) で区切ります。例：password,secret,key,token, and credentials

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    Data

    string

    呼び出しが成功したかどうかを示します。

    success
    RequestId

    string

    リクエスト ID です。

    78901766-3806-4E96-8E47-CFEF59E4****
    Message

    string

    返されたメッセージです。

    message
    Code

    integer

    HTTP ステータスコードです。2XX はリクエストが成功したことを示します。3XX はリクエストがリダイレクトされたことを示します。4XX はリクエストエラーが発生したことを示します。5XX はサーバーエラーが発生したことを示します。

    200
    Success

    boolean

    リクエストが成功したかどうかを示します。有効値：

    • true

    • false

    true

    例

    成功レスポンス

    JSONJSON

    {
  "Data": "success",
  "RequestId": "78901766-3806-4E96-8E47-CFEF59E4****",
  "Message": "message",
  "Code": 200,
  "Success": true
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 ParameterMissing You must specify the parameter.
    400 ParameterTraceAppSettingKeyIllegal The application configuration key is invalid.
    400 ParameterTraceAppSettingValueIllegal The application configuration value is invalid.
    400 InternalError InterPlease try again. Contact the DingTalk service account if the issue persists after multiple retries.
    404 AppNotExist The application does not exist.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。