OpenAPI 使用状況の監査

OpenAPI QueryBuilder のパフォーマンスを追跡するには、使用率統計を参照してください。 OpenAPI QueryBuilder の使用状況の統計を表示するには、OpenAPI ログ ファイルを確認または OpenAPI クエリを作成します。 OpenAPI の使用状況の監査は、システム パフォーマンスの問題の診断に役立ちます。
capm270
OpenAPI QueryBuilder のパフォーマンスを追跡するには、使用率統計を参照してください。 OpenAPI QueryBuilder の使用状況の統計を表示するには、OpenAPI ログ ファイルを確認または OpenAPI クエリを作成します。 OpenAPI の使用状況の監査は、システム パフォーマンスの問題の診断に役立ちます。
OpenAPI の使用状況のログ ファイル
ログ ファイルには、実行される各クエリに関する詳細情報と、クエリが成功したかどうかが示されます。 ログ ファイル内の 1 つのクエリに対する各エントリには、リクエストの開始および終了が記録されます。 ログ ファイルは、以下のディレクトリにあります。
/opt/IMDataAggregator/apache-karaf-<
vers
>/data/log/odata-services.impl.log
以下のクエリの詳細は、ログ ファイルに記載されています。
  • API コールを実行したホスト
  • テナント
  • User
  • URL
  • リクエストの期間
以下のエントリは、成功したクエリ リクエストの例です。
INFO | qtp1695827227-67 | 2015-06-01 12:17:55,207 | ODataRequestProcessor | odata.impl.ODataRequestProcessor 910 || Start request (Thread id 67):
host
: '10.42.200.100'
tenant
: 'Default Tenant'
user
: 'admin'
url
: 'http://da.ca.com:8581/odata/api/components?$expand=device&$select=ID,Name,device/ID,device/Name&$format=json&$top=20000' - Run budget 30000 ms (30 seconds).
INFO | qtp1695827227-67 | 2015-06-01 12:17:55,482 | ODataRequestProcessor | odata.impl.ODataRequestProcessor 948 || Done request (Thread id 67):
host
: '10.42.200.100'
tenant
: 'Default Tenant'
user
: 'admin'
url
: 'http://da.ca.com:8581/odata/api/components?$expand=device&$select=ID,Name,device/ID,device/Name&$format=json&$top=20000' - Execution time
273 ms
.
以下のエントリは、失敗したクエリ リクエストの例です。
INFO | p1695827227-1474 | 2015-06-01 12:33:30,892 | ODataRequestProcessor | odata.impl.ODataRequestProcessor 910 || Start request (Thread id 1474): host: '10.42.200.100' tenant: 'Default Tenant' user: 'admin' url: 'http://da.ca.com:8581/odata/api/components?$expand=device&$select=ID,Name,device/ID,device/Name&$format=json&$top=500000' - Run budget 30000 ms (30 seconds).
ERROR | p1695827227-1474 | 2015-06-01 12:33:30,894 | ODataRequestProcessor | odata.impl.ODataRequestProcessor 1047 || Failed to complete request (Thread id 1474): host: '10.42.200.100' tenant: 'Default Tenant' user: 'admin' url: 'http://da.ca.com:8581/odata/api/components?$expand=device&$select=ID,Name,device/ID,device/Name&$format=json&$top=500000' - Execution time 0 ms. Error: The top value must be in the range (0 .. 20000).
OpenAPI の使用状況の追跡
OpenAPI の全体的な使用状況を追跡する OpenAPI クエリを実行します。 このクエリは、特定の期間中または平均処理時間内のクエリの数を表示できます。 以下の統計情報を使用できます。
  • クエリ数
    最終読み取り後に発生したクエリの数
  • 成功クエリ数
    最終読み取り後に発生した成功クエリ数
  • 失敗クエリ数
    最終読み取り後に発生した失敗クエリの数
  • クエリの処理時間
    クエリを処理する平均時間
データは 5 分ごとに収集されます。
以下の手順に従います。
  1. [クエリ式]フィールドで[
    クリックしてクエリを開始
    ]を選択します。
  2. [クエリ式]フィールドから、
    [metric family]-[openapiquerymf]
    を選択します。
  3. [クエリ式]フィールドから[
    選択
    ]を選択します。
  4. 表示する統計を選択します。 たとえば、以下のメトリックを選択します。
    • ID
    • im_TimeToProcessQuery
    • im_NumberOfQueries
  5. [実行]
    をクリックします。
    以下の例に示されているように、OpenAPI の使用状況の統計が表示されます。
auditOpenAPI.JPG