製品説明
テナントのSQLパフォーマンス統計を照会し、指定された時間範囲内でSQLのパフォーマンスを集計します。パフォーマンスデータには、クラスタ、テナント、サーバー、データベース、ユーザー、SQL_ID、応答時間、CPU時間、実行回数、エラー回数などが含まれます。内部SQLかどうか、SQLテキストのキーワード、詳細検索 などの条件を使用して、特定のSQLのパフォーマンス指標を照会できます。
説明
このインターフェースのクエリは時間がかかります。応答時間が長い場合は、クエリの頻度、クエリの時間範囲、または同時リクエストの数を適宜減らしてください。同時に、OCP ServerとMonitor DBのリソース使用状況を確認し、必要に応じてスペック設定を調整することもできます。
呼び出しの説明
インターフェース制約
呼び出し元は、指定したテナントに対する読み取り権限を持っている必要があります。
リクエストパス
GET /api/v2/ob/clusters/{clusterId}/tenants/{tenantId}/topSql
リクエストパラメータ
パラメータ |
型 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|---|
| clusterId | Integer | はい | 1 | クラスタのID |
| tenantId | Integer | はい | 1001 | テナントのID |
| startTime | Datetime | はい | 2020-02-16T05:32:16+08:00 | 開始時間 |
| endTime | Datetime | はい | 2020-02-16T07:32:16+08:00 | 終了時間 |
| serverId | Integer | いいえ | 300 | 指定されたOceanBaseサーバーで実行されたSQLを照会します。指定しない場合、すべてのOceanBaseサーバーで実行されたSQLを照会します。 |
| inner | Boolean | いいえ | false | 内部SQLを含むかどうかを示します。内部SQLとは、OceanBaseが発信するSQLを指します。デフォルトはfalse、つまり内部SQLは含まれません。 |
| sqlText | String | いいえ | hello | SQLに含まれるキーワードです。キーワードは大文字小文字を区別しません。 |
| searchAttr | String | いいえ | executions | 詳細検索の指標名。searchOpとseachValを同時に指定する必要があります。 |
| searchOp | String | いいえ | GT | 詳細検索の演算子。searchAttrとsearchValを同時に指定する必要があります。 値の範囲: |
| searchVal | String | いいえ | 1543 | 詳細検索の値。searchAttrとsearchOpを同時に指定する必要があります。 |
戻り値
基本データ構造
パラメータ型説明data Object リクエストされた業務データ ├─ contents Array SQLパフォーマンス指標データのリスト、後の表を参照。 successful Boolean リクエストが成功したかどうか timestamp Datetime サーバーがリクエストを完了したタイムスタンプ duration Integer サーバーがリクエストを処理した時間(ミリ秒) status Integer HTTP Status仕様に準拠したコード traceId String リクエストのTrace Id。問題のトラブルシューティングに使用されます。 server String リクエストに応答したサーバーのアドレス
SQLパフォーマンス指標のデータ構造
パラメータ型説明sqlId String SQLのID。 server String OceanBaseサーバーのアドレス。 dbName String SQLが実行されたデータベース。 userName String SQLを実行したユーザー。 sqlType String SQLのタイプ。値の範囲: - SELECT:クエリ文
- INSERT:挿入文
- UPDATE:更新文
- DELETE:削除文
- REPLACE:置換文
- EXPLAIN:計画解析
- UNKNOWN:その他の文
sqlTextShort String SQLテキストの最初の100文字。 inner Boolean 内部SQLかどうか。 waitEvent String 指定された時間範囲内において、このSQLで最も時間を消費した内部イベント。値の範囲: - system internal wait
- mysql response wait client
- sync rpc
- db file data read
executions Integer 期間内のSQLの総実行回数。 execPs Float 期間内のSQLの1秒あたりの平均実行回数。小数点以下2桁を保持します。 avgAffectedRows Float 期間内のSQLの平均更新行数。小数点以下2桁を保持します。 avgReturnRows Float 期間内のSQLの平均返却行数。小数点以下2桁を保持します。 avgPartitionCount Float 期間内のSQLの平均アクセスパーティション数。 failCount Integer 期間内のSQLの総エラー回数。 failPercentage Float 期間内のSQLのエラー率。戻り値 [0, 1]、小数点以下4桁を保持します。 retCode4012Count Integer 期間内にタイムアウトエラー(エラーコード4012)が発生した総回数。 retCode4013Count Integer 期間内にメモリ不足エラー(エラーコード4013)が発生した総回数。 retCode5001Count Integer 期間内に構文解析エラー(エラーコード5001)が発生した総回数。 retCode5024Count Integer 期間内にキー値競合エラー(エラーコード5024)が発生した総回数。 retCode5167Count Integer 期間内にデータ長エラー(エラーコード5167)が発生した総回数。 retCode5217Count Integer 期間内に未知列エラー(エラーコード5217)が発生した総回数。 retCode6002Count Integer 期間内にトランザクションロールバックエラー(エラーコード6002)が発生した総回数。 avgWaitTime Float 期間内のSQLの平均待機時間。 avgWaitCount Float 期間内のSQLの平均待機回数。 avgRpcCount Float 期間内のSQLの平均RPC送信回数。 localPlanPercentage Float 期間内のSQLのローカル計画の割合。 remotePlanPercentage Float 期間内のSQLのリモート計画の割合。 disPlanPercentage Float 期間内のSQLの分散計画の割合。 avgElapsedTime Float 期間内のSQLの平均応答時間(ミリ秒)。 maxElapsedTime Float 期間内のSQLの最大応答時間(ミリ秒)。 avgCpuTime Float 期間内のSQLの平均CPU時間(ミリ秒)。 maxCpuTime Float 期間内のSQLの最大CPU時間(ミリ秒)。 avgNetTime Float 期間内のSQLの平均ネットワーク転送時間(ミリ秒)。 avgNetWaitTime Float 期間内のSQLの平均ネットワークキュー待ち時間(ミリ秒)。 avgQueueTime Float 期間内のSQLの平均キュー待ち時間(ミリ秒)。 avgDecodeTime Float 期間内のSQLの平均構文解析時間(ミリ秒)。 avgGetPlanTime Float 期間内のSQLの平均計画生成時間(ミリ秒)。 avgExecuteTime Float 期間内のSQLの平均計画実行時間(ミリ秒)。 avgExecutorRpcCount Float 期間内のSQLの平均実行RPCリクエスト回数。 missPlanPercentage Float 期間内のSQLの計画未ヒット率。戻り値 [0, 1]、小数点以下4桁を保持します。 avgApplicationWaitTime Float 期間内のSQLの平均Applicationイベント待機時間(ミリ秒)。 avgConcurrencyWaitTime Float 期間内のSQLの平均Concurrencyイベント待機時間(ミリ秒)。 avgUserIoWaitTime Float 期間内のSQLの平均UserIOイベント待機時間(ミリ秒)。 avgScheduleTime Float 期間内のSQLの平均Scheduleイベント待機時間(ミリ秒)。 avgRowCacheHit Float 期間内のSQLの平均RowCacheヒット数。 avgBloomFilterCacheHit Float 期間内のSQLの平均BloomFilterCacheヒット数。 avgBlockCacheHit Float 期間内のSQLの平均BlockCacheヒット数。 avgBlockIndexCacheHit Float 期間内のSQLの平均BlockIndexCacheヒット数。 avgDiskReads Float 期間中のSQLの平均ディスク読み取り回数。 retryCount Integer 期間中のSQLの合計リトライ回数。 tableScanPercentage Float 期間中のSQLのテーブルスキャン割合。 strongConsistencyPercentage Float 期間中のSQLの強整合性トランザクションの割合。戻り値は [0, 1] で、小数点以下4桁を保持します。 weakConsistencyPercentage Float 期間中のSQLの弱整合性トランザクションの割合。戻り値は [0, 1] で、小数点以下4桁を保持します。 avgMemstoreReadRows Float 期間中のSQLの平均MemStore読み取り行数。 avgSsstoreReadRows Float 期間中のSQLの平均SsStore読み取り行数。 avgLogicalReads Double 期間内のSQLの平均論理読み取り回数。 cpuPercentage Double 期間中のTOPSQLのCPU時間に占める、該当SQLのCPU時間の割合。 dynamicSql Boolean 動的SQLかどうか。 lastFailCode Integer 期間中の最後のエラーコード。 lastFailTimestamp Integer 期間中の最後のエラー時刻。 obDbId Integer OceanBaseデータベースID。 obTenantId Integer OceanBaseテナントID。 serverIp String OBServer IPアドレス。 sumCpuTimeMs Double 期間中の総CPU消費量。 sumElapsedTime Double 期間中の総応答時間(ミリ秒)。 sumLogicalReads Integer SQLの総論理読み取り回数。 sumWaitTime Double 期間中の総待機時間(ミリ秒)。 tenantId Integer テナントID。 tenantName String テナント名。 説明
返されるSQLテキストは最初の100文字のみを含みます。SQLの全文を確認するには、SQLテキストを照会するインターフェースを使用してください。
例
リクエスト例
クラスタIDが1、テナントIDが1001のSQLパフォーマンスを照会します。時間範囲は2020-11-03T19:00:00+08:00 から 2020-11-03T20:00 です。高度な検索条件として、実行回数が500以上であることを指定します。
GET /api/v2/ob/clusters/1/tenants/1001/topSql?searchAttr=executions&searchOp=GE&searchVal=500&startTime=2020-11-03T19%3A00%3A00%2B08%3A00&endTime=2020-11-03T20%3A00%3A00%2B08%3A00
レスポンス例
実際に返されるパフォーマンスデータの数は、データベースの負荷とクエリの時間区間に関連しています。ここでは、2件のパフォーマンスデータのみを表示します。
{
"duration": 1435,
"server": "a83ad33525",
"status": 200,
"successful": true,
"timestamp": "2020-11-04T11:49:03.802+08:00",
"traceId": "ead2abb032cc464b",
"data": {
"contents": [
{
"avgAffectedRows": 0.00,
"avgApplicationWaitTime": 0.00,
"avgBlockCacheHit": 0.00,
"avgBlockIndexCacheHit": 0.00,
"avgBloomFilterCacheHit": 0.00,
"avgConcurrencyWaitTime": 0.00,
"avgCpuTime": 0.09,
"avgDecodeTime": 0.00,
"avgDiskReads": 0.00,
"avgElapsedTime": 0.09,
"avgExecuteTime": 0.04,
"avgExecutorRpcCount": 0.00,
"avgGetPlanTime": 0.05,
"avgMemstoreReadRows": 0.00,
"avgNetTime": 0.00,
"avgNetWaitTime": 0.00,
"avgPartitionCount": 1.00,
"avgQueueTime": 0.00,
"avgReturnRows": 0.00,
"avgRowCacheHit": 0.00,
"avgRpcCount": 0.00,
"avgScheduleTime": 0.00,
"avgSsstoreReadRows": 0.00,
"avgUserIoWaitTime": 0.00,
"avgWaitCount": 0.00,
"avgWaitTime": 0.00,
"dbName": "bar",
"distPlanPercentage": 0.00,
"execPs": 2.11,
"executions": 7522,
"failCount": 0,
"failPercentage": 0.00,
"inner": true,
"localPlanPercentage": 1.00,
"maxCpuTime": 0.00,
"maxElapsedTime": 0.00,
"missPlanPercentage": 0.00,
"remotePlanPercentage": 0.00,
"retCode4012Count": 0,
"retCode4013Count": 0,
"retCode5001Count": 0,
"retCode5024Count": 0,
"retCode5167Count": 0,
"retCode5217Count": 0,
"retCode6002Count": 0,
"retryCount": 0,
"server": "xxx.xxx.xxx.1:2882",
"sqlId": "89FF9AC900FA242F1DEF8B2211377F60",
"sqlTextShort": "DELETE FROM X WHERE ID = 3",
"sqlType": "DELETE",
"strongConsistencyPercentage": 1.00,
"tableScanPercentage": 0.00,
"userName": "test",
"waitEvent": "none",
"weakConsistencyPercentage": 0.00
},
{
"avgAffectedRows": 0.00,
"avgApplicationWaitTime": 0.00,
"avgBlockCacheHit": 1.00,
"avgBlockIndexCacheHit": 1.00,
"avgBloomFilterCacheHit": 0.00,
"avgConcurrencyWaitTime": 0.00,
"avgCpuTime": 0.39,
"avgDecodeTime": 0.00,
"avgDiskReads": 0.00,
"avgElapsedTime": 0.42,
"avgExecuteTime": 0.28,
"avgExecutorRpcCount": 0.00,
"avgGetPlanTime": 0.11,
"avgMemstoreReadRows": 1.00,
"avgNetTime": 0.00,
"avgNetWaitTime": 0.00,
"avgPartitionCount": 2.00,
"avgQueueTime": 0.02,
"avgReturnRows": 2.00,
"avgRowCacheHit": 0.00,
"avgRpcCount": 0.00,
"avgScheduleTime": 0.00,
"avgSsstoreReadRows": 1.00,
"avgUserIoWaitTime": 0.00,
"avgWaitCount": 0.00,
"avgWaitTime": 0.00,
"dbName": "oceanbase",
"distPlanPercentage": 0.00,
"execPs": 1.00,
"executions": 3568,
"failCount": 0,
"failPercentage": 0.00,
"inner": false,
"localPlanPercentage": 1.00,
"maxCpuTime": 0.00,
"maxElapsedTime": 0.00,
"missPlanPercentage": 0.00,
"remotePlanPercentage": 0.00,
"retCode4012Count": 0,
"retCode4013Count": 0,
"retCode5001Count": 0,
"retCode5024Count": 0,
"retCode5167Count": 0,
"retCode5217Count": 0,
"retCode6002Count": 0,
"retryCount": 0,
"server": "xxx.xxx.xxx.2:2882",
"sqlId": "9CFB17EA7B3F88B92C6BD433D845963A",
"sqlTextShort": "select 1",
"sqlType": "SELECT",
"strongConsistencyPercentage": 0.00,
"tableScanPercentage": 0.00,
"userName": "foo",
"waitEvent": "none",
"weakConsistencyPercentage": 1.00
}
]
}
}