API解析

API解析ではサイト上の各APIリクエストのキャッシュヒットや実行時間などの統計情報を確認できます。

API解析の確認方法

[オペレーション] -> [ログ管理]をクリックします。

Image from Gyazo

ページタイトルの上の[ログ管理]をクリックし、表示されたプルダウンの中にある[API解析]を選択します。

Image from Gyazo

API解析の項目説明

Image from Gyazo

絞り込み条件

API解析では簡易的なURIによる絞り込みと、詳細検索を用意しています。

URIによる絞り込み

Image from Gyazo

[URI] テキストボックスに検索するURIを入力します。部分一致でAPI解析を絞り込みます。

詳細検索

[詳細検索] ボタンをクリックすると、絞り込み条件を作成できます。

Image from Gyazo

絞り込み対象として指定できる項目は次の通りです。

項目説明指定できる条件
ログ日時 ログの記録された日時日付範囲
URL リクエストが行われたエンドポイントのURL  検索条件
Hitリクエストのヒットした回数検索条件
処理実行時間サーバーのリクエスト処理時間検索条件
レスポンスサイズ HTTPリクエストのボディサイズ検索条件
キャッシュステータスキャッシュスステータスコード検索条件
API IDAPI ID検索条件
API URI IDAPI URI ID検索条件

詳細検索は複数の条件をAND、またはORで連結できます。ANDの場合は指定した条件すべてにマッチするデータのみを対象とします。OR条件は指定した条件のいずれかにマッチするデータを対象とします。

日付範囲指定について

日付の範囲指定は、次の4条件で指定できます。

  • 日付で範囲指定
  • 相対で日付指定
  • 時間で範囲指定
  • 日時で範囲指定

検索に利用できるオペレーションについて

検索では次のオペレーションが指定できます。

オペレーション対象となるデータ
含む文字列条件が一部に一致するデータ
含まない文字列条件がいずれにも一致しないデータ
=文字列・数値条件に一致するデータ
!=文字列・数値条件に一致しないデータ
<文字列・数値条件未満のデータ
>文字列・数値条件より大きいデータ
<=文字列・数値条件以下のデータ
>=文字列・数値条件以上のデータ
で始まる文字列条件ではじまるデータ
で始まらない文字列条件ではじまらないデータ
で終わる文字列条件で終わるデータ
で終わらない文字列条件で終わらないデータ
どれかを含む文字列・数値条件を複数指定し、いずれかの条件に一致するデータ
どれも含まない文字列・数値条件を複数指定し、いずれの条件にも一致しないデータ
並び順について

ソートキーと表示順を選択することで検索結果の並び順を指定できます。並び順はASC(昇順。小さい方から大きくなっていく)またはDESC(降順。大きい方から小さくなっていく)を指定できます。

ログ一覧項目

ログとして一覧されるデータの項目は次の通りです。

項目説明
API IDAPI IDを表示します。
HTTPメソッドHTTPメソッドを表示します。
API URI IDAPI URI IDを表示します。
キャッシュステータスキャッシュスステータスコードを表示します。詳細はキャッシュステータスについてを参照してください。
ステータスHTTPレスポンスステータスコードを表示します。
Hitリクエストのヒットした回数を表示します。
処理実行時間サーバーのリクエスト処理時間を表示します。
レスポンスサイズ HTTPリクエストのボディサイズを表示します。

キャッシュステータスについて

キャッシュステータスは3つの値を取ります。

項目説明
HITキャッシュからのリクエストがありました。
MISSキャッシュが見つからず、サーバーに到達しました。
PASSキャッシュできませんでした。

ボタンの説明

Image from Gyazo

ボタン説明 
検索する指定した絞り込み条件で検索します。
ダウンロードするログ一覧で表示しているログ情報をダウンロードします。
削除するログ一覧で表示しているログ情報を削除します。

ログ一覧のダウンロード

[ダウンロードする]ボタンをクリックするとダウンロード設定が開きます。

Image from Gyazo

項目説明 
文字コードCSVファイルの文字コードを設定します。
キャンセルダウンロードをキャンセルします。
ダウンロードするダウンロードします。

お探しのページは見つかりましたか?解決しない場合は、問い合わせフォームからお問い合わせいただくか、Slackコミュニティにご参加ください。