Application Monitoring によって監視されているアプリケーションのすべてのカスタム設定 (トレースサンプリング設定やエージェントスイッチなど) を照会します。この操作は、Application Monitoring によって監視されているアプリケーションにのみ適用されます。OpenTelemetry 向けマネージドサービスによって監視されているアプリケーションには適用されません。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Pid |
string |
必須 |
アプリケーションのプロセス ID (PID) です。 以下のいずれかの方法で PID を取得できます:
説明
|
a2n80plglh@745eddxxx |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスのスキーマ |
||
| RequestId |
string |
リクエスト ID です。 |
78901766-3806-4E96-8E47-CFEF59E4**** |
| Data |
string |
アプリケーションのカスタム設定です。JSON 文字列形式です。詳細については、レスポンスパラメーターの追加説明をご参照ください。 |
{"profiler":{"enable":true}} |
| Message |
string |
返されたメッセージです。 |
查询应用配置成功 |
| Code |
integer |
HTTP ステータスコードです。 有効な値:
列挙値:
|
200 |
| Success |
boolean |
リクエストが成功したかどうかを示します。 有効な値:
列挙値:
|
true |
以下の表は、各カスタム設定に対応する JSONPath パラメーターを示しています。注意:一部のカスタム設定は、変更されるタイミングが異なるため、レスポンスで返されない場合があります。この場合、デフォルト値が有効になります。
サンプリング設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| サンプリングポリシー | profiler.sampling.useSamplingStrategyV2 | boolean | 有効な値: - true:適応型サンプリング- false:固定レートサンプリング | false |
| サンプリングレート | profiler.sampling.rate | double | 0%~100% この設定は固定レートサンプリングで有効になります。 | 10 |
| フルコレクション用の API エンドポイント | profiler.sampling.v2config.spanNames4FullSampleStr | String | トレースデータが収集される API エンドポイントです。複数の値をコンマ (,) で区切ります。 | "" |
| フルコレクション用の API エンドポイントプレフィックス | profiler.sampling.v2config.spanNamePrefixes4FullSampleStr | String | トレースデータが収集される API エンドポイントのプレフィックスです。 | "" |
| フルコレクション用の API エンドポイントサフィックス | profiler.sampling.v2config.spanNameSuffixes4FullSampleStr | String | トレースデータが収集される API エンドポイントのサフィックスです。 | "" |
エージェントスイッチ設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| アプリケーションモニタリングスイッチ | profiler.enable | boolean | 有効な値: - true:アプリケーションモニタリングを有効にします- false:アプリケーションモニタリングを無効にします | true |
| Dubbo プラグインスイッチ | profiler.dubbo.enable | boolean | 有効な値: - true:Dubbo プラグインを有効にします- false:Dubbo プラグインを無効にします | true |
| MongoDB プラグインスイッチ | profiler.mongodb.enable | boolean | 有効な値: - true:MongoDB プラグインを有効にします- false:MongoDB プラグインを無効にします | true |
| HSF プラグインスイッチ | profiler.hsf.enable | boolean | 有効な値: - true:HSF プラグインを有効にします- false:HSF プラグインを無効にします | true |
| HttpClient 3 プラグインスイッチ | profiler.httpclient3.enable | boolean | 有効な値: - true:HttpClient 3 プラグインを有効にします- false:HttpClient 3 プラグインを無効にします | true |
| HttpClient 4 プラグインスイッチ | profiler.httpclient4.enable | boolean | 有効な値: - true:HttpClient 4 プラグインを有効にします- false:HttpClient 4 プラグインを無効にします | true |
| JDK HTTP プラグインスイッチ | profiler.jdkhttp.enable | boolean | 有効な値: - true:JDK HTTP プラグインを有効にします- false:JDK HTTP プラグインを無効にします | true |
| Jetty プラグインスイッチ | profiler.jetty.enable | boolean | 有効な値: - true:Jetty プラグインを有効にします- false:Jetty プラグインを無効にします | true |
| MyBatis プラグインスイッチ | profiler.mybatis.enable | boolean | 有効な値: - true:MyBatis プラグインを有効にします- false:MyBatis プラグインを無効にします | true |
| MySQL プラグインスイッチ | profiler.mysql.enable | boolean | 有効な値: - true:MySQL プラグインを有効にします- false:MySQL プラグインを無効にします | true |
| OkHttp プラグインスイッチ | profiler.okhttp.enable | boolean | 有効な値: - true:OkHttp プラグインを有効にします- false:OkHttp プラグインを無効にします | true |
| Oracle プラグインスイッチ | profiler.oracle.enable | boolean | 有効な値: - true:Oracle プラグインを有効にします- false:Oracle プラグインを無効にします | true |
| PostgreSQL プラグインスイッチ | profiler.postgresql.enable | boolean | 有効な値: - true:PostgreSQL プラグインを有効にします- false:PostgreSQL プラグインを無効にします | true |
| Redis プラグインスイッチ | profiler.redis.enable | boolean | 有効な値: - true:Redis プラグインを有効にします- false:Redis プラグインを無効にします | true |
| Spring プラグインスイッチ | profiler.spring.enable | boolean | 有効な値: - true:Spring プラグインを有効にします- false:Spring プラグインを無効にします | true |
| Spring Boot プラグインスイッチ | profiler.springboot.enable | boolean | 有効な値: - true:Spring Boot プラグインを有効にします- false:Spring Boot プラグインを無効にします | true |
| Tomcat プラグインスイッチ | profiler.tomcat.enable | boolean | 有効な値: - true:Tomcat プラグインを有効にします- false:Tomcat プラグインを無効にします | true |
| Lettuce プラグインスイッチ | profiler.lettuce.enable | boolean | 有効な値: - true:Lettuce プラグインを有効にします- false:Lettuce プラグインを無効にします | true |
| gRPC プラグインスイッチ | profiler.grpc.enable | boolean | 有効な値: - true:gRPC プラグインを有効にします- false:gRPC プラグインを無効にします | true |
| Thrift プラグインスイッチ | profiler.thrift.enable | boolean | 有効な値: - true:Thrift プラグインを有効にします- false:Thrift プラグインを無効にします | true |
| Hystrix プラグインスイッチ | profiler.hystrix.enable | boolean | 有効な値: - true:Hystrix プラグインを有効にします- false:Hystrix プラグインを無効にします | true |
| RxJava プラグインスイッチ | profiler.rxjava.enable | boolean | 有効な値: - true:RxJava プラグインを有効にします- false:RxJava プラグインを無効にします | true |
| Memcached プラグインスイッチ | profiler.memcached.enable | boolean | 有効な値: - true:Memcached プラグインを有効にします- false:Memcached プラグインを無効にします | true |
| Druid プラグインスイッチ | profiler.jdbc.druid.enable | boolean | 有効な値: - true:Druid プラグインを有効にします- false:Druid プラグインを無効にします | true |
| WebLogic プラグインスイッチ | profiler.weblogic.enable | boolean | 有効な値: - true:WebLogic プラグインを有効にします- false:WebLogic プラグインを無効にします | true |
| ElasticJob プラグインスイッチ | profiler.elasticjob.enable | boolean | 有効な値: - true:ElasticJob プラグインを有効にします- false:ElasticJob プラグインを無効にします | true |
| Elasticsearch プラグインスイッチ | profiler.elasticsearch.enable | boolean | 有効な値: - true:Elasticsearch プラグインを有効にします- false:Elasticsearch プラグインを無効にします | true |
| HikariCP プラグインスイッチ | profiler.jdbc.hikaricp.enable | boolean | 有効な値: - true:HikariCP プラグインを有効にします- false:HikariCP プラグインを無効にします | true |
| InfluxDB プラグインスイッチ | profiler.influxdb.enable | boolean | 有効な値: - true:InfluxDB プラグインを有効にします- false:InfluxDB プラグインを無効にします | true |
| Kafka プラグインスイッチ | profiler.kafka.enable | boolean | 有効な値: - true:Kafka プラグインを有効にします- false:Kafka プラグインを無効にします | true |
| Netty プラグインスイッチ | profiler.netty.enable | boolean | 有効な値: - true:Netty プラグインを有効にします- false:Netty プラグインを無効にします | true |
| Play プラグインスイッチ | profiler.play.enable | boolean | 有効な値: - true:Play プラグインを有効にします- false:Play プラグインを無効にします | true |
| Reactor プラグインスイッチ | profiler.reactor.enable | boolean | 有効な値: - true:Reactor プラグインを有効にします- false:Reactor プラグインを無効にします | true |
| Redisson プラグインスイッチ | profiler.redis.redisson.enable | boolean | 有効な値: - true:Redisson プラグインを有効にします- false:Redisson プラグインを無効にします | true |
| RabbitMQ プラグインスイッチ | profiler.rabbitmq.client.enable | boolean | 有効な値: - true:RabbitMQ プラグインを有効にします- false:RabbitMQ プラグインを無効にします | true |
| SchedulerX プラグインスイッチ | profiler.schedulerx.enable | boolean | 有効な値: - true:SchedulerX プラグインを有効にします- false:SchedulerX プラグインを無効にします | true |
| Undertow プラグインスイッチ | profiler.undertow.enable | boolean | 有効な値: - true:Undertow プラグインを有効にします- false:Undertow プラグインを無効にします | true |
| Vert.x プラグインスイッチ | profiler.vertx.enable | boolean | 有効な値: - true:Vert.x プラグインを有効にします- false:Vert.x プラグインを無効にします | true |
| XXL-JOB プラグインスイッチ | profiler.xxljob.enable | boolean | 有効な値: - true:XXL-JOB プラグインを有効にします- false:XXL-JOB プラグインを無効にします | true |
| ONS Client プラグインスイッチ | profiler.onsclient.enable | boolean | 有効な値: - true:ONS Client プラグインを有効にします- false:ONS Client プラグインを無効にします | true |
| Quartz プラグインスイッチ | profiler.quartz.enable | boolean | 有効な値: - true:Quartz プラグインを有効にします- false:Quartz プラグインを無効にします | true |
| Servlet プラグインスイッチ | profiler.servlet.enable | boolean | 有効な値: - true:Servlet プラグインを有効にします- false:Servlet プラグインを無効にします | true |
| Liberty プラグインスイッチ | profiler.liberty.enable | boolean | 有効な値: - true:Liberty プラグインを有効にします- false:Liberty プラグインを無効にします | true |
| Akka プラグインスイッチ | profiler.akka.enable | boolean | 有効な値: - true:Akka プラグインを有効にします- false:Akka プラグインを無効にします | true |
| Cassandra プラグインスイッチ | profiler.cassandra.enable | boolean | 有効な値: - true:Cassandra プラグインを有効にします- false:Cassandra プラグインを無効にします | true |
| OpenTelemetry プラグインスイッチ | profiler.opentelemetry.enable | boolean | 有効な値: - true:OpenTelemetry プラグインを有効にします- false:OpenTelemetry プラグインを無効にします | true |
| Google HTTP Client プラグインスイッチ | profiler.googlehttpclient.enable | boolean | 有効な値: - true:Google HTTP Client プラグインを有効にします- false:Google HTTP Client プラグインを無効にします | true |
| Ning プラグインスイッチ | profiler.ning.asynchttpclient.enable | boolean | 有効な値: - true:Ning プラグインを有効にします- false:Ning プラグインを無効にします | true |
スレッドプロファイリング設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| スレッドプロファイリングスイッチ | profiler.tprof.enableJvmThreadStatistic | boolean | 有効な値: - true:スレッドプロファイリングを有効にします- false:スレッドプロファイリングを無効にします | true |
| ローカルメソッドスタックを定期的に保存するためのスイッチ | profiler.tprof.enableThreadStackRecorder | boolean | 有効な値: - true:ローカルメソッドスタックの定期的なストレージを有効にします- false:ローカルメソッドスタックの定期的なストレージを無効にします | false |
| 時間のかかる呼び出しのしきい値 | profiler.tprof. threadProfilerSlowInteractionRt | int | 単位:ms。持続時間がしきい値を超えると、ローカルメソッドスタックが自動的に保存されます。 | 2000 |
アプリケーションログの関連付け設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| ログソース | profiler.logSource | String | 有効な値: - sls:Simple Log Service | sls |
| ビジネスログとトレース ID を自動的に関連付けるためのスイッチ | profiler.logging.enable | boolean | 有効な値: - true:ビジネスログとトレース ID の関連付けを有効にします- false:ビジネスログとトレース ID の関連付けを無効にします | true |
| ログにトレース ID を自動的に入力するためのスイッチ | profiler.logging.injectTraceId2Log.enable | boolean | 有効な値: - true:ログへのスパン ID の自動入力を有効にします- false:ログへのスパン ID の自動入力を無効にしますこの設定は、ARMS エージェント V4.1.6 以降で有効になります。 | true |
| ログにスパン ID を自動的に入力するためのスイッチ | profiler.logging.injectSpanId2Log.enable | boolean | 有効な値: - true:ログへのスパン ID の自動入力を有効にします- false:ログへのスパン ID の自動入力を無効にしますこの設定は、ARMS エージェント V4.1.6 以降で有効になります。 | true |
| Simple Log Service の関連付け - リージョン | profiler.SLS.regionId | String | 関連付けられたログソースが存在するリージョンです。 | "" |
| Simple Log Service の関連付け - プロジェクト | profiler.SLS.project | String | 関連付けられたログソースが属するプロジェクトです。 | "" |
| Simple Log Service の関連付け - Logstore | profiler.SLS.logStore | String | 関連付けられたログソースが属する Logstore です。 | "" |
| Simple Log Service の関連付け - インデックス | profiler.SLS.index | String | 関連付けられたログソースのインデックスです。 | "" |
URL 収束設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| 収束 URL | profiler.convergence.enable | boolean | 有効な値: - true:URL 収束機能を有効にします- false:URL 収束機能を無効にします | true |
| 収束しきい値 | profiler.convergence.minServerSize | long | しきい値に達すると URL が収束します。 | 1000 |
| 収束ルール | profiler.convergence.pattern | String | 各ルールは正規表現です。 例: /service/(.*?)/demo。複数のルールをコンマ (,) で区切ります。 | "" |
Arthas 設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| Arthas スイッチ | profiler.arthas.enable | boolean | 有効な値: - true:Arthas 診断機能を有効にします- false:Arthas 診断機能を無効にします | false |
| リアルタイムで有効な IP アドレス | profiler.arthas.enableIps | string | Arthas 診断機能が有効になっている IP アドレスです。複数の IP アドレスをコンマ (,) で区切ります。 空の文字列は、すべての IP アドレスに対して Arthas 診断機能が有効であることを示します。 | "" |
継続的プロファイリング設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| スイッチ | profiler.cp.enable | boolean | 有効な値: - true:継続的プロファイリング機能を有効にします- false:継続的プロファイリング機能を無効にします* スイッチをオンにすると、次の表に示すように 2 つの構成モードが利用可能になります。 | false |
| CPU ホットスポット | profiler.cp.cpuEnable | boolean | 有効な値: - true:CPU ホットスポット機能を有効にします- false:CPU ホットスポット機能を無効にします | false |
| メモリホットスポット | profiler.cp.allocEnable | boolean | 有効な値: - true:メモリホットスポット機能を有効にします- false:メモリホットスポット機能を無効にします | false |
| コードホットスポット | profiler.cp.wallClockEnable | boolean | 有効な値: - true:コードホットスポット機能を有効にします- false:コードホットスポット機能を無効にします | false |
| モード | キー | フィールド | 値 |
| IP アドレスホワイトリスト | cp.allowIPs | IP アドレスホワイトリスト | 継続的プロファイリングが有効になっているインスタンスの IP アドレスです。複数の値をコンマ (,) で区切ります。 例:192.168.0.1,192.168.0.2 |
| cp.allowNetwork | CIDR ブロック | 空の文字列を指定します。そうしないと、この機能は正常に動作しません。 | |
| CIDR ブロック | cp.allowIPs | IP アドレスホワイトリスト | 空の文字列を指定します。そうしないと、この機能は正常に動作しません。 |
| cp.allowNetwork | CIDR ブロック | 継続的プロファイリングが有効になっているインスタンスの CIDR ブロックです。 例:192.168.2.0/24/24 |
データマスキング設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| データマスキングスイッチ | profiler.sanitizer.enable | boolean | 有効な値: - true:データマスキング機能を有効にします- false:データマスキング機能を無効にします | true |
| データマスキングルール | profiler.sanitizer.keys | String | 指定された用語を含む機密キーの大文字と小文字を区別しないマッチング。複数の IP アドレスをコンマ (,) で区切ります。 | true |
操作呼び出し設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| 低速リクエストしきい値 | profiler.thresholds.interface | long | 単位:ms。応答時間がこのしきい値を超えると、リクエストは低速としてマークされます。 | 500 |
| 例外ホワイトリスト | profiler.exception.whitelist | String | 例外名の正規表現を指定します。一致する例外は統計チャートから除外されます。複数のルールをコンマ (,) で区切ります。 | "" |
| 親クラスの継承による例外フィルタリング | profiler.exception.filterByParentClass | boolean | 有効な値: - true:機能を有効にします- false:機能を無効にします機能を有効にすると、例外フィルタリングで親例外を構成できます。 この設定は、ARMS エージェント V4.1.6 以降で有効になります。 | true |
| HTTP ステータスコードホワイトリスト | profiler.error.skip | String | 無視する HTTP ステータスコードです。複数の値をコンマ (,) で区切ります。 | "" |
| 無効な API 呼び出しのフィルタリング | profiler.defined.excludeurl | String | 無視される API 呼び出しです。各ルールは正規表現です。複数の値をコンマ (,) で区切ります。 | /**/*.jpg,/**/*.png,/**/*.js, /**/*.jpeg,/**/*.pdf,/**/*.xlsx, /**/*.txt,/**/*.docs,/**/*.gif, /**/*.csv |
データベース呼び出し設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| 低速 SQL クエリしきい値 | profiler.thresholds.sql | long | 単位:ms。SQL クエリの持続時間がしきい値を超えると、クエリは低速としてマークされます。 | 500 |
| SQL キャプチャの最大保持長 | profiler.callsql.maxLength | long | SQL ステートメントの値がしきい値を超えると、SQL ステートメントは切り捨てられます。 | 1024 |
| SQL ステートメントにバインド変数を表示するためのスイッチ | profiler.jdbc.tracesqlbindvalue | boolean | 有効な値: - true:機能を有効にします- false:機能を無効にしますこのスイッチをオンにすると、PrepareStatement パラメーターにバインドされた変数値がキャプチャされ、ページに表示されます。MySQL のみがサポートされています。 | false |
| SQL ステートメントに定数を表示するためのスイッチ | profiler.jdbc. tracesqlraw | boolean | 有効な値: - true:機能を有効にします- false:機能を無効にします機能を有効にすると、生の SQL ステートメントがキャプチャされます。 | false |
トレースプロトコル設定
注意:コンテキスト伝播プロトコルの設定は、ARMS エージェント V4.1.x 以降でのみ有効です。
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| コンテキスト伝播プロトコル | profiler.trace.protocol.name | String | 有効な値: - Unset:未設定- W3C:OpenTelemetry W3C- SkyWalking- Zipkin:Zipkin B3- Jaeger- EagleEye | Unset |
| コンテキスト伝播モード | profiler.trace.protocol. strategy | String | 有効な値: - PriorityUse- ForceUse | PriorityUse |
詳細設定
| 設定 | JSONPath | タイプ | 説明 | デフォルト値 |
| エージェントが 1 秒あたりに収集するトレースの最大数 | profiler.thresholds.limit | int | 高トラフィック時にトレース収集がビジネス運用に影響を与えないようにするための保護措置です。 | 100 |
| メソッドスタックの保持制限 | profiler.callstack.maxLength | int | メソッドスタックの長さがしきい値を超えると、収集中にメソッドスタックが切り捨てられます。 この設定は、ARMS エージェント V4.0.0 以降では非推奨です。 | 128 |
| 同じタイプの例外のスタックの深さ | profiler.exception.stacktrace | int | システムが同じタイプの例外を識別するためのスタックの深さです。 | 2 |
| リクエストパラメーターの最大表示長 | profiler.param.maxLength | int | リクエストパラメーターの最大表示長です。 | 512 |
| カスタム RabbitMQ コンシューマー | profiler.rabbitmq.client.consumer.classes | String | RabbitMQ コンシューマーの完全修飾クラス名です。複数のコンシューマーをコンマ (,) で区切ります。 この設定は、ARMS エージェント V4.0.0 以降では非推奨です。 | "" |
| カスタム Kafka 消費メソッド | profiler.kafka.consumer.entryPoint | String | Kafka コンシューマーの消費メソッドです。 この設定は、ARMS エージェント V4.0.0 以降では非推奨です。 | "" |
| Kafka がメッセージを送信するときにコンテキストを自動的に伝播するためのスイッチ | profiler.kafka.enableInjectKafkaHeaders | boolean | Kafka メッセージにトレースヘッダーを自動的に挿入して、送信トレースと消費トレースを関連付けるかどうかを指定します。 この設定は、ARMS エージェント V4.0.0 以降では非推奨です。 | false |
| 非同期伝播のパッケージ名 | profiler.thread.match.package | String | 指定されたパッケージの下で Runnable、Callable、Supplier が作成されると、トレースコンテキストが自動的にキャプチャされ、新しいスレッドに伝播されます。複数のパッケージ名をコンマ (,) で区切ります。 この設定は、ARMS エージェント V4.0.0 以降では非推奨です。 | "" |
| HTTP レスポンスへのトレース ID の包含 | profiler.responseInject.enable | boolean | 有効な値: - true:機能を有効にします- false:機能を無効にします | false |
例
成功レスポンス
JSONJSON
{
"RequestId": "78901766-3806-4E96-8E47-CFEF59E4****\n",
"Data": "{\"profiler\":{\"enable\":true}}",
"Message": "查询应用配置成功",
"Code": 200,
"Success": true
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | ParameterPidMissing | You must specify pid. | |
| 500 | InternalError | Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries. | |
| 404 | AppNotExist | The application does not exist. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。