レスポンスログは、Webページ利用者の視点でCGIプログラムのレスポンス時間のデータを採取し、蓄積されるログです。
Webページ利用者がCGIプログラム呼び出しを伴うサービスを実行し、CGIプログラムからの結果を受け取るまでにかかった時間をレスポンス時間としてログに蓄積します。
例えば、検索を行うWebページの場合、検索実行開始時から検索結果を表示するまでにかかった時間がレスポンス時間となります。
レスポンスログは以下の3つの機能により採取・蓄積されます。
■データ採取機能1
Webブラウザ上で動作するJava(TM)アプレット(ResLog1.class)です。Webページ利用者がWebページを参照し、CGIプログラム呼び出しを伴うサービスを実行することで起動され、サービスを実行した時点のデータを採取します。
なお、この機能が動作するには、あらかじめWebページに設定が必要です。
■データ採取機能2
Webブラウザ上で動作するJava(TM)アプレット(ResLog2.class)です。Webページ利用者がCGIプログラム呼び出しを伴うサービスの結果を受け取ることで起動され、結果を受け取った時点のデータを採取し、データ採取機能1のデータとあわせてレスポンス時間を計算してデータ蓄積機能へ送信します。
なお、この機能が動作するには、あらかじめWebページに設定が必要です。
■データ蓄積機能
Webサーバ(インストールマシン)上で動作するCGIプログラム(reslog.cgi)です。データ蓄積機能は、データ採取機能2が起動されることにより自動的に起動されます。データ採取機能2から送信されたデータをSQC拡張ログファイルへ蓄積します。
レスポンスログを採取するための設定方法を説明します。
■設定する前に
あらかじめ、データ蓄積機能のCGIプログラム(reslog.cgi)が実行できるようにWebサーバへ登録しておく必要があります。登録の詳細は「4.1 Webサーバの環境設定」を参照してください。
参照
データ採取機能では、Java(TM)アプレット(ResLog1.class、ResLog2.class)を使用しています。Java(TM)アプレットについては、「3.2 環境設定の流れ」を参照してください。
■Webページの編集
ログ採取する以下の各WebページのHTML文書にログ採取のためのJava(TM)アプレットを取り込みます。以下の関連する2つのWebページは必ず両方とも編集する必要があります。
サービスを呼び出すWebページ
サービスのCGIプログラムを呼び出すWebページ。
例えば、キーワードを与えて検索するWebページなど。
結果応答するWebページ
CGIプログラムからの結果に応答(結果表示)するWebページ。
例えば、検索結果を表示するWebページなど。
■サービスを呼び出すWebページの編集
データ採取機能1のJava(TM)アプレット(ResLog1.class)を、サービスを呼び出すWebページのHTML文書に取り込みます。
以下は、HTML文書のサンプルです。サンプル中のCODEBASEのURLは、「4.1 Webサーバの環境設定」の設定例のとおり、インストールディレクトリ下のディレクトリwwwの物理パスがエイリアス「SQC」で登録されているものとして記述しています。
以下の例は、検索のボタンが押下されたのを契機にデータ採取機能1のJava(TM)アプレット(ResLog1.class)を、呼び出している例です。
<!-- --> <!-- レスポンスログ採取ページ サンプル(その1) --> <!-- --> <HTML> <HEAD> <TITLE> 検索サービスページ(サンプル)</TITLE> </HEAD> <BODY BGCOLOR=WHITE> <!-- ************ Systemwalker SQC (begin) ****************** --> <APPLET NAME="ResLog1" CODEBASE="/SQC/classes" CODE="ResLog1.class" ARCHIVE="reslog.jar" WIDTH=1 HEIGHT=1> </APPLET> <!-- ************ Systemwalker SQC (end) ******************** --> <CENTER><FONT COLOR=GREEN> 検索サービスページ(サンプル) </FONT></CENTER> <BR><BR> <FONT SIZE=5 COLOR=BLUE> 検索サービス </FONT> <HR> <FORM METHOD="post" ACTION="/cgi-bin/search.cgi"> 検索キー <INPUT TYPE="text" NAME="key1" SIZE="25"> <BR><BR> <INPUT TYPE="reset" VALUE="リセット"> <INPUT TYPE="submit" VALUE="検索" onClick="document.ResLog1.run()"> </FORM> <HR> <FONT COLOR=RED> ご注意 </FONT> <P> 本サイトでは検索サービスの応答状況の記録および集計を実施しておりますが、集計結果は検索サービス向上のための参考に使用するものであり、利用者のプライバシーを侵害することはありません。 </P> </BODY> </HTML> |
[サンプルの説明]
内容 | 説明 |
---|---|
青文字部分 | データ採取機能1を取り込むための記述 |
CODEBASEに指定するパス | 本製品のJava(TM)クラスファイルの格納ディレクトリのURL |
なお、上記のサンプルは、インストール後、以下に格納されています。
【Windows版】
<インストールディレクトリ>\sample\search_request_jp.html |
【UNIX版】
/opt/FJSVssqc/sample/search_request_jp.html |
■結果応答するWebページの編集
データ採取機能2のJava(TM)アプレット(ResLog2.class)を、結果応答するWebページのHTML文書に取り込みます。
以下は、HTML文書のサンプルです。サンプル中のCODEBASEのURLは、「4.1 Webサーバの環境設定」の設定例のとおり、インストールディレクトリ下のディレクトリwwwの物理パスがエイリアス「SQC」で登録されているものとして記述しています。
<!-- --> <!-- レスポンスログ採取ページ サンプル(その2) --> <!-- --> <HTML> <HEAD> <TITLE> 検索サービスページ(サンプル)</TITLE> </HEAD> <BODY BGCOLOR=WHITE> <!-- ************ Systemwalker SQC (begin) ****************** --> <APPLET CODEBASE="/SQC/classes" CODE="ResLog2.class" ARCHIVE="reslog.jar" WIDTH=1 HEIGHT=1> <PARAM NAME=url VALUE="/SQC/cgi-bin/reslog.cgi"> </APPLET> <!-- ************ Systemwalker SQC (end) ******************** --> <CENTER><FONT COLOR=GREEN> 検索サービスページ(サンプル)</FONT></CENTER> <BR><BR> <FONT SIZE=5 COLOR=BLUE> 検索サービス</FONT> <HR> <P> 検索結果... </P> </BODY> </HTML> |
[サンプルの説明]
【Windows版】
内容 | 説明 |
---|---|
青文字部分 | データ採取機能2を取り込むための記述 |
CODEBASEに指定するパス | 次のディレクトリに対応するURL インストールディレクトリ\www\classes |
VALUEに指定するパス | 次のファイルに対応するURL インストールディレクトリ\www\cgi-bin\reslog.cgi |
なお、上記のサンプルは、インストール後、以下に格納されています。
インストールディレクトリ\sample\search_result_jp.html |
【UNIX版】
内容 | 説明 |
---|---|
青文字部分 | データ採取機能2を取り込むための記述 |
CODEBASEに指定するパス | 次のディレクトリに対応するURL /opt/FJSVssqc/www/classes |
VALUEに指定するパス | 次のファイルに対応するURL /opt/FJSVssqc/www/cgi-bin/reslog.cgi |
なお、上記のサンプルは、インストール後、以下に格納されています。
/opt/FJSVssqc/sample/search_result_jp.html |
■Webページの編集に関する注意事項
サービスを呼び出すWebページでのAPPLETタグ中のCODEBASEと、結果応答するWebページでのAPPLETタグ中のCODEBASEには、完全に同じ文字列でURLを指定してください。完全に同じ文字列でない場合、例えば、一方を相対パスでもう一方を絶対パスで指定した場合、レスポンスログを採取できないので、注意してください。
■設定後の動作
このログ採取のための設定をしたWebページを利用すると、以下のようにログ採取が行われます。
対象 | 動作内容 |
---|---|
Web利用者: | WebページのURLをWebブラウザで参照します。 ↓ |
Web利用者: | CGIプログラム呼び出しを伴うサービス(例えば、検索を実行するなど)を実行します。 ↓ |
Web利用者: | CGIプログラムから結果を受け取ります。 ↓ |
内部: | レスポンスログが採取・蓄積されます。 ↓ |
内部: | 利用状況DB登録エンジンによって利用状況DBへ登録されます。 ↓ |
分析者: | 分析画面で分析実行・表示させることができます。 対応する分析は、URL別レスポンス分析とクライアント別レスポンス分析です。 |
注意
Webページの編集に誤りがあると、レスポンスログが採取されません。Webページのサービス提供にあたっては、事前にテストを実施し、実際にレスポンスログが採取されることを確認してください。
レスポンスログの採取を停止するには、ログ採取のためにWebページのHTML文書に追加した記述を削除します。削除は、「サービスを呼び出すWebページ」、「結果応答するWebページ」の対で行ってください。
削除部分は、「11.4.1.2 ログ採取のための設定をする」の各HTML文書サンプルの青文字部分です。削除すると、以降このWebページを参照し、サービスを呼び出してもレスポンスログの採取・蓄積は行われません。
レスポンスログは、データ採取機能2から送信された1つのデータに対応して1つ、テキスト1行でSQC拡張ログファイルに蓄積されます。
1行の形式は、以下のとおりです。フィールドの区切りは半角空白1文字です。
(1)Date (2)Type (3)Version (4)HostName (5)Path (6)Reserve (7)KeyData
No. | フィールド | 説明 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
(1) | Date | ログを蓄積した時刻。インストールマシン上のローカル時刻で、形式は以下のとおり。青文字の箇所は可変。 [dd/mon/yyyy:hh:mm:ss SHHMM] 各フィールドの意味は、以下のとおり。
| ||||||||||||||||||||
(2) | Type | データのタイプ(ログ種別を示すコード) レスポンスログは、"2" | ||||||||||||||||||||
(3) | Version | ログ形式のバージョンレベル レスポンスログでは、現在"1"だけ | ||||||||||||||||||||
(4) | HostName | ブラウザが動作している(Webページ利用者の)ホスト名またはIPアドレス | ||||||||||||||||||||
(5) | Path | WebページのHTML文書のパス | ||||||||||||||||||||
(6) | Reserve | リザーブ 現在常に"0" | ||||||||||||||||||||
(7) | KeyData | レスポンス時間。単位はミリ秒。 |
ファイル名・容量見積り・SQC拡張ログファイルの切り替えについては、次項の「15.2.5 SQC拡張ログファイル」を参照してください。