Skip to main content

Web ゲートウェイのシステム全体のパラメータの構成

特定の InterSystems IRIS® インスタンスにアクセスするように InterSystems IRIS Web ゲートウェイを構成した場合、インスタンスのサーバ・アクセス・プロファイル内で指定していないオプション・パラメータやカスタムのシステム・フォームは、Web ゲートウェイに対してグローバルに (システム全体で) 指定された一連の既定パラメータから自動的に継承されます。例えば、インスタンスのサーバ・アクセス・プロファイル内で [サーバ応答タイムアウト] パラメータを設定していない場合、そのインスタンスはグローバルな [サーバ応答タイムアウト] の設定を継承します。

ここでは、Web ゲートウェイにグローバルな (システム全体の) 構成パラメータを構成する方法について説明します。サーバ・アクセス・プロファイル (InterSystems IRIS インスタンス向け) とアプリケーション・アクセス・プロファイル (それらのインスタンスで利用できる Web アプリケーション向け) を構成する方法については他の記事で説明しています。

Web ゲートウェイ・パラメータの構成方法

Web ゲートウェイ管理ページ内の [デフォルトパラメータ] ページでは、Web ゲートウェイのすべてのグローバルな構成パラメータを変更できます。(このオプションを使用するには、システム管理者であることが必要です。)一般に、このインタフェースを使用して、Web ゲートウェイのグローバルなパラメータを構成することをお勧めします。このページの残りの部分では、ユーザがこの方法を使用していると想定しています。

一方、Web ゲートウェイ・レジストリ%CSP.Mgr.GatewayMgrOpens in a new tab クラスは、メソッド SetDefaultParms,Opens in a new tab を提供します。このメソッドでは、接続されている任意の InterSystems IRIS インスタンスから、プログラムによって Web ゲートウェイのグローバルなパラメータを構成できます。

Web ゲートウェイは、これらのシステム全体の既定パラメータを CSP.ini ファイルに保持します。"CSP.ini パラメータ・リファレンス" では、以下で説明するパラメータに類似した名前が記載されています。類似パラメータ名を使用し、Web ゲートウェイ・レジストリと CSP.ini ファイルを使用して Web ゲートウェイを構成します。

Important:

CSP.ini ファイルを直接編集しなければならないことがあるコンテナ化された導入を除き、CSP.ini ファイルへのアクセスを制限して、すべての Web ゲートウェイ構成を Web ゲートウェイ管理ページまたは Web ゲートウェイ・レジストリ・メソッドを使用して実行することをお勧めします。

Web ゲートウェイ・レジストリを使用して、または CSP.ini ファイルを編集して Web ゲートウェイのグローバルなパラメータを変更する場合、変更を有効にするには、構成を再ロードするように Web ゲートウェイを強制する必要があります。

Web ゲートウェイ (一般設定)

Web ゲートウェイの [デフォルトパラメータ] 管理ページのこのセクションには、Web ゲートウェイの一般設定を構成するための以下のパラメータが含まれます。

[インスタンスホスト名]

これは、Web ゲートウェイのこのインスタンスに対するネットワーク・ホスト名です。この Web ゲートウェイは既定値を生成し、その値はテキスト・ボックスの下に表示されます。このパラメータ値は、システム変数 CSPIHN として、要求データと共に InterSystems IRIS へ送信されます。アプリケーションはこの値を使用して、ネットワーク経由で Web ゲートウェイにより提供される管理サービスにアクセスできます。

このパラメータの形式は server_name:port です。

[最大接続数]

このゲートウェイ・インスタンスで作成可能な InterSystems IRIS への最大接続数。既定値は 1024 に設定されます。アプリケーションが使用する接続数が多いほど、この値を増加させることでアプリケーションの応答性を高めることができますが、サーバ・リソースをより使用する結果になる可能性もあります。

[最大接続数] パラメータへの変更は、Web ゲートウェイ (またはホスト Web サーバ) の再起動後にのみ有効になります。

[最大キャッシュ・サイズ]

CSP の応答データをキャッシュするために確保される共有メモリの最大量。

キャッシュ・サイズは、バイトの接尾語がない数字に、キロバイトの場合は K、メガバイトの場合は M を付加して指定されます。

このパラメータの既定値は 256K です。 必要に応じてこの値を増やしたり減らしたりできます。

[最大キャッシュ・サイズ] パラメータへの変更は、ゲートウェイ (またはホスト Web サーバ) の再起動後に有効になります。

セキュリティ

Web ゲートウェイの [デフォルトパラメータ] 管理ページのこのセクションでユーザ名とパスワードが定義されている場合、すべてのシステム管理者は Web ゲートウェイ管理ページにアクセスする際に、このユーザ名とパスワードを入力する必要があります。

パスワードを忘れた場合は、以下の手順を使用して新しいパスワードを設定します。

  1. CSP.ini 構成ファイルを編集し、ファイルの SYSTEM セクションで UsernamePassword の新しい値を指定します。パスワードの値は平文で指定できます。

  2. Web サーバを再起動します。Web サーバは構成を再ロードしてファイルを更新し、平文のパスワードではなくパスワード・ハッシュを保持します。

これでユーザは、更新されたユーザ名とパスワードで Web サーバにログインできます。

[SYSTEM]
Username=cm
Password=1Bx4tt88mttAWaf7isJg3Urqc2zE

管理ページでは、以下の Web ゲートウェイのセキュリティ・パラメータを構成できます。

[このフォームにアクセス]

Web ゲートウェイ管理ページのオプションへのアクセスを有効または無効にすることができます。既定は [有効] です。アクセスが [無効] である場合、Web ゲートウェイ管理ページを使用して、アクセスを再度有効にすることはできません。アクセスを再度有効化するには、構成ファイルを手動で編集します。このファイルの SYSTEM セクションで、SM_Forms パラメータを Enabled に設定します。

[SYSTEM]
SM_Forms=Enabled

[ユーザ名]

Web ゲートウェイ管理ページへのアクセスに必要なユーザ名です。

[パスワード]

Web ゲートウェイ管理ページへのアクセスに必要なパスワードです。

[パスワード (再入力)]

パスワードを修正する場合、ここで新しいパスワードを確認入力します。

[セッション・タイムアウト]

アクティブなシステム管理セッションがログオン状態になっているアイドル時間 (秒)。この時間が経過すると、管理セッションの有効期限が切れ、管理者は Web ゲートウェイ管理ページから自動的にログアウトします。

[システム管理マシン]

これらのシステム管理オプションにアクセスできるクライアント・マシンの IP アドレスのリストを定義します。システム管理者のアクセス権を持つクライアントは、CSP システムへのアクセスの追加や削除、構成ファイル内の設定の変更、およびアクティブなセッションを閉じる操作が可能です。各アドレスは、コンマまたはプラス記号で区切ります。以下の例では、2 つのクライアントにシステム管理者のアクセス権があります。

127.0.0.1, 45.123.231.12

このフィールドを定義しない場合、Web ゲートウェイと同じマシンで動作しているクライアント (Web サーバのホスト) のみが CSP を構成できます。詳細は、"追加クライアント・アドレスからのアクセスの有効化" を参照してください。

このフィールドには、[ユーザ名とパスワードをオーバーライド] というチェック・ボックスも用意されています。チェック・ボックスにチェックを付けると、リストされているクライアント・マシンから管理フォームにアクセスするときにユーザ名やパスワードを入力しなくても済むようになります。

カスタム・ログイン・フォーム

Web ゲートウェイ管理ページへのアクセスを制御するカスタム・ログイン・フォームを定義します。このパラメータは、物理ファイルまたはフォームを処理するホスト Web サーバを有効にするリンクへのフル・パスにすることができます。

例 :

 C:\Inetpub\wwwroot\login.html
 /login.html    

物理ファイル名が指定されている場合、Web ゲートウェイはフォームを取得してクライアントに送信します。 そうでない場合、「HTTP リダイレクト」応答ヘッダを送信して、クライアントがホスト Web サーバから直接フォームを要求できるようにします。 カスタム・フォームでゲートウェイ管理者がログインするには、HTTP POST 要求を実装する必要があります。

必須フォーム・フィールドは以下のとおりです。

<FORM METHOD=POST ACTION="/csp/bin/Systems/Module.cxw">
<INPUT TYPE=HIDDEN NAME="CSPSYS" VALUE="17">
<INPUT TYPE=HIDDEN NAME="CSPSYSsmSection" VALUE="SYSTEM">
<INPUT TYPE=TEXT NAME="CSPUNM" SIZE='20' VALUE="">  
<INPUT TYPE=PASSWORD NAME="CSPPWD" SIZE='20' VALUE=""> 
<INPUT TYPE=SUBMIT NAME="CSPSYSbOK" VALUE="Login"> 

ここで、CSPUNM はユーザ名で、CSPPWD はパスワードです。 ログイン (送信) ボタン (上記で Login として表示) に割り当てられるテキストは変更可能です。

単純ですが完全な例を以下に示します。

<html>
<head>
<title>Web Gateway Management</title>
</head>
<h2>Web Gateway Management</h2>
<FORM METHOD=POST ACTION="/csp/bin/Systems/Module.cxw">
<INPUT TYPE=HIDDEN NAME="CSPSYS" VALUE="17">
<INPUT TYPE=HIDDEN NAME="CSPSYSsmSection" VALUE="SYSTEM">
<BR>
Username: 
<INPUT TYPE=TEXT NAME="CSPUNM" SIZE='20' VALUE="">
<BR>
Password:
<INPUT TYPE=PASSWORD NAME="CSPPWD" SIZE='20' VALUE="">
<BR>
<INPUT TYPE=SUBMIT NAME="CSPSYSbOK" VALUE="Login">
</form>
</html>

InterSystems IRIS への接続

このセクションでは、InterSystems IRIS への接続の維持に関連するパラメータについて説明します。

[サーバ応答タイムアウト]

ターゲットの InterSystems IRIS サーバが Web サーバからの要求に応答できるまでの最大許容時間 (秒)。タイムアウトとは、アクティビティのない時間のことです。例えば、HTML データの行を毎秒 10 時間送信していれば、タイムアウトは発生しません。このフィールドに入力できる最小値は 5 秒です。

ここで設定した値がシステムの既定値です。継承値が指定されていない場合、値は [デフォルトパラメータ] ページから取られます。ただし、サーバ固有の構成またはアプリケーション自体で別の値を設定できます。

Apache サーバがある場合は、Apache httpd.conf ファイルの Timeout を使用してこの値を設定できますので注意してください。これら 2 つのうち値の低い方が最初にトリガされます。

[キューイングされたリクエストのタイムアウト]

要求が、該当する InterSystems IRIS システムへの使用可能な接続をキュー内で待機できる最大時間 (秒)。入力できる最小値は 5 秒です。 継承値が指定されていない場合、値は [デフォルトパラメータ] ページから取られます。

[無使用タイムアウト]

このパラメータが該当するのはステートレス接続のみです。このパラメータは、ステートレス接続が開いたままのアイドル状態から閉じるまでの最大時間 (秒) を示します。このタイムアウトを超えると、セッションは自動的に閉じます。この機能を使用すると、InterSystems IRIS サーバにステートレス・セッションが蓄積されません。特に、負荷の増加に対応するために多数の接続が開かれた高アクティビティ期間の後でも、ステートレス・セッションが蓄積されません。この値を指定しない場合は、手動で閉じるまでステートレス接続は開いたままです。 継承値が指定されていない場合、値は [デフォルトパラメータ] ページから取られます。

構成されたタイムアウトを過ぎても、最大数分間はプロセスが残る場合があります。設計上、Web ゲートウェイは接続タイムアウトを定期的にチェックしています。タイムアウトになってもすぐに通知されるわけではありません。このチェックのタイミングによって、プロセスは最大 420 秒残存します。

[すべての接続にタイムアウトを適用]

[無使用タイムアウト] オプションを (最小の接続プール構成を含む) すべての接続に適用します。 このオプションにチェックを付けていない場合、Web ゲートウェイは [無使用タイムアウト] を最小の接続プール ([サーバ接続最小数] パラメータにて定義) に適用しません。 このオプションにチェックを付けている場合、Web ゲートウェイはタイムアウトをプールの接続すべてに適用します。 このオプションは、CSP の使用率がきわめて低いインストール環境で使用するものであり、その結果として、すべての CSP プロセスでタイムアウトよりもこのオプションが優先します。 継承値が指定されていない場合、値は [デフォルトパラメータ] ページから取られます。

[イベントログレベル]

Web ゲートウェイ・イベント・ログに書き込まれる情報を制御します。詳細は、"イベント・ログ・パラメータ" を参照してください。

[イベントログファイル]

Web ゲートウェイ・イベント・ログの場所とファイル名を指定します。指定しない場合、ログは Web ゲートウェイのインストール環境をホストするディレクトリに書き込まれます。例えば、以下のようになります。

代替の場所を指定するには :

/opt/logfiles/cspgateway/

代替の場所およびファイル名を指定するには :

/opt/logfiles/cspgateway/event_log_01012006.log

[すべてのログファイルを残す]

[イベントログ切り替えサイズ] が空白の場合 (既定)、Web ゲートウェイ・イベント・ログは管理者が手動でクリアするまで増大します。ファイルの容量が [イベントログ切り替えサイズ] で指定されている場合、InterSystems IRIS はこのログ・ファイルを filename.old (filename は元の完全なファイル名) という名前のファイルにコピーします。その後のログのローテーションによって、filename.old は、ログの現在の内容に上書きされます。すべてのログ・ファイルを残すには、[すべてのログファイルを残す] にチェックを付けます。コピーの実行時に、各ログに日付と時刻を含む名前が付けられます。

[イベントログ切り替えサイズ]

このパラメータには、ログのローテーションが開始されるサイズを定義します。既定値は空白です。これは、Web ゲートウェイが 1 つのログ・ファイルを管理し、管理者がそのファイルを手動で消去するまでファイルのサイズが増えることを意味します。

ローテーションが必要な場合、サイズはバイトの接尾語がない数字に、キロバイトの場合は K、メガバイトの場合は M を付加して指定されます。

指定可能な最小サイズは 100K です。この値は、管理者が管理スイートでこれよりも低い値を設定しようとすると自動的に設定されます。

ローテーションされたログ・ファイルのコピーは、保持される場合、ローテーションの日付と時刻に応じて以下のように名前が付けられます。

CSP_YYYYMMDD_hhmm.log

YYYY は年、MM は月、DD は日付、hh は時間、mm はその時間を経過した分です。以下に例を示します。

CSP_20090109_1830.log (Log rotated at 18:30 on 9th January 2009)

1 分間に複数のログ・ファイル・ローテーションが行われる場合は、重複を防ぐために、ファイル名にシリアル番号が付加されます。以下に例を示します。

03/12/2015  17:02           106,660 CSP_20151203_1702.log
03/12/2015  17:02           124,752 CSP_20151203_1702.log.0001
03/12/2015  17:02           124,752 CSP_20151203_1702.log.0002

保持されないローテーションされたログ・ファイルには、filename.old (filename は元の完全なファイル名) という名前が付けられます。

この機能を使用するには、Web ゲートウェイ・バイナリ (つまり、メインのログ・ファイルが格納されている場所) をホストするディレクトリに対する Web ゲートウェイの作成/書き込みアクセス権が必要です。 Web ゲートウェイが正常にローテーションを実行できない場合は現行のログ・ファイルに対して書き込みが続けられます。

このフィールドには、[すべてのログファイルを残す] というチェック・ボックスも用意されています。このチェック・ボックスにチェックを付けると、前述した名前付け方式に従ってすべてのログ・ファイルを保存するよう Web ゲートウェイに指示されます。

[ログするリクエスト最大サイズ]

V9 (または V9b などのバリアント) のイベント・ログ・レベルを指定することで、HTTP 要求のログを有効にしている場合、このパラメータは、ログ内に含める HTTP 要求の量を指定します。この最大サイズを超える要求は切り捨てられます。

このパラメータの既定値は 256K で、最小値は 40K です。このフィールドを空のままにすると、既定値 (256K) に設定されます。最低値は強制されます。この最低値より小さい値を割り当てようとすると、40K に設定されます。

[SSL/TLS ライブラリ・パス]

OpenSSL ライブラリへのパスを指定します。UNIX® の場合、これらのファイルは libssl.so および libcrypto.so、Windows, の場合、これらのファイルは libcrypto-1_1-x64.dll および libssl-1_1-x64.dll です。既定では、Web ゲートウェイは、そのホーム・ディレクトリでローカルにこれらのライブラリを参照します。詳細は、"Kerberos ライブラリ" の "SSL/TLS を使用する場合のライブラリ・パスのオーバーライド" を参照してください。

[保持モード除外ファイルの種類]

静的ファイルがステート認識アプリケーションで非同期に処理されるようにします。ステートレス・アプリケーションでは、静的ファイル (cspclscsr、および zen 以外のファイル) はメイン・セッションに対して非同期に処理されます。 つまり、これらのファイルの要求はセッション・ロックをバイパスして、アプリケーションのメイン処理ストリームの外部で同時に処理できます。

このパラメータにより、この方式がステート認識アプリケーションにも拡張されます。ステート認識アプリケーションは、従来のセッション・ロックだけでなく、Web ゲートウェイ内の接続ロックの対象にもなります。接続ロックは、ユーザ/セッションに対するすべての要求が、同じ InterSystems IRIS プロセスに確実にルーティングされるようにします。 InterSystems IRIS から提供される静的コンポーネントに依存するアプリケーションの場合、これによって過剰な要求がキューイングされ、結果としてブラウザの動作が不安定になる (停止など) 場合があります。

このパラメータを使用して、ファイルの種類 (拡張子ごと) のスペースで区切られたリストを定義し、非同期の処理を可能にして、Web ゲートウェイおよび InterSystems IRIS において接続/セッション・ロックから除外されるようにします。リストに *- (アスタリスクとハイフン) の接頭語が付けられている場合、以下のリストで定義されたものを除くすべてのファイルが非同期で処理されます。

Preserve Mode Exclude File Types=gif jpg jpeg  

ステート認識セッションに対して GIF、JPG、および JPEG の種類のファイルを非同期で処理します。

Preserve Mode Exclude File Types=*- csp cls csr zen  

ステート認識セッションに対して、CSP、CLS、CSR、および ZEN の種類を除くすべてのファイルを非同期で処理します。 なお、これはステートレス・アプリケーションに対して CSP エンジンで適用されるルールです。

このメカニズムは、ログ・レベル v4 を使用して監視できます。 要求に対して起動されると、以下に示すようなレコードがログに追加されます。

 >>> Time: Fri Oct 04 14:56:40 2017 ...GET /csp/samples/zenutils.js       
     State-Aware Session (preserve == 1)     
     Process this request concurrently in the pool of stateless connections (File Type=js)

ASP リダイレクト

[ウェブドキュメントルート]

Web サーバのドキュメント・ルート・ディレクトリの完全な物理パスです。例えば、Microsoft IIS Web サーバの場合、このパスは通常 c:\InetPub\wwwroot となります。このパラメータは、CSP 内でこの機能を使用して、Microsoft ASP エンジンを介して CSP 出力を送信し、最後のページを表示する場合にのみ必要です。

[ASP一時ディレクトリ]

Web ゲートウェイが Microsoft ASP のコンテンツを一時的に格納できるディレクトリの完全な物理パスです。このパラメータは、CSP 内でこの機能を使用して、Microsoft ASP エンジンを介して CSP 出力を送信し、最後のページを表示する場合にのみ必要です。

[内部HTTPサーバ]

このセクションは NSD にのみ関連します。このセクションには、以下のパラメータが含まれます。

[サービス状態]

HTTP サーバは、[有効] または [無効] のいずれかに設定できます。以下のどちらかを選択します。

  • 有効

  • 無効

既定は [有効] です。

NSD が未処理の HTTP 要求に応答できるようにする場合を除き、セキュリティの面ではこの機能を無効にすることをお勧めします。

[NSDドキュメントルート]

NSD 自体をスタンドアロンの Web サーバとして使用する場合、このパラメータは Web ドキュメント・ルートの完全な物理パスを定義します。以下はその例です。

/opt/webgateway/home/

このサーバを使用して Web アプリケーションを提供する場合は、ブローカ・コンポーネントを以下にインストールする必要があります。

/opt/webgateway/home/broker/

CSP サンプルのサポートに使用する静的ファイルは以下のとおりです。

/opt/webgateway/home/samples/

管理ポータルのサポートに使用する静的ファイルは以下のとおりです。

/opt/webgateway/home/sys/

カスタム・エラー・ページ

グローバルな構成画面の [エラーページ] セクションでは、Web ゲートウェイのエラー・メッセージとシステム応答をカスタマイズできます。グローバルに設定できるほか、InterSystems IRIS サーバごとに設定することもできます。既定の CSP 応答をカスタマイズするには、以下の手順を実行します。

  1. Web ゲートウェイ管理ページのメイン・メニューから、[デフォルトパラメータ] を選択します。

  2. [エラーページ] セクションで、対応するゲートウェイのページを置き換える CSP ページの名前を入力します。CSP ページの完全な物理パスを入力するか、Web ゲートウェイのパスを基準とする相対パスを入力します。

  3. [設定を保存] を選択します。

次の Web ゲートウェイ・システム応答をカスタマイズできます。

[サーバエラー]

Web ゲートウェイに内部エラーが発生した場合に表示されるページ。例えば、InterSystems IRIS サーバとの通信に問題があるとエラーが発生します。特定のエラーは Web ゲートウェイ・イベント・ログに必ず記録されます。

[サーバビジー]

使用可能な CSP 接続がすべて使用中の場合に表示されるページ。

[サーバが利用可能でありません]

InterSystems IRIS サーバ (またはアプリケーション) が、構成内で故意に無効にされている場合に表示されるページ。

[サーバタイムアウト]

要求がタイムアウトしたときに表示されるページ。

[接続が閉じられました]

ステート認識セッションからログアウトした場合に表示されるページ。

イベント・ログ・パラメータ

[イベントログレベル] フィールドは、Web ゲートウェイが Web ゲートウェイ・イベント・ログに書き込む情報を指定します。ログ・オプションは文字列として定義され、各文字がログ・コマンドを表します。ここでログ・レベルについて設定した値がシステム (つまり、すべての InterSystems IRIS サーバ) の規定値となります。特に明記されていない限り、個々の InterSystems IRIS サーバに異なる値を設定できます。

CSP Web ゲートウェイ管理ページのメニューから、ログを参照または消去できます。以下に示すログ・パラメータは、主にトラブルシューティングに使用します。

ログ・オプション 機能
E すべてのエラーを記録します。接続の失敗を監視できます。
V Verbose : Web ゲートウェイと InterSystems IRIS システム間の基本的な接続ダイアログを記録します。このオプションを使用して、Web ゲートウェイと InterSystems IRIS サーバ間の通信に存在する重要なポイントを記録します。このコマンドには 7 つのレベル (1 ~ 7) があります。これらのレベルごとに、詳細情報が記録されます。レベルは累積されます。例えば、レベル V3 には、V1 および V2 に指定したすべてのログ情報が含まれます。
EV 基本的なイベント・ログを有効にするには EV と入力します。ログのレベルが高くなるほど、ログ・ファイルには大量のデータが生成されます。したがって、レベルの高いログは問題を診断する場合にのみ使用してください。プロダクション・システムの場合、ログのレベルを EV より低く設定することをお勧めします。
V1 V と同じです。
V2 上記のレベルに指定した情報のほかに、以下の情報を記録します。
  • Web ゲートウェイと InterSystems IRIS 間の基本的な接続管理に関する情報 (接続ごとの開始ポイントおよび終了ポイント)。

  • ブラウザから受信した送信の中断。

  • (InterSystems IRIS からの応答がない、またはその他のエラーが原因で接続が回復できないために) InterSystems IRIS への接続が強制的に切断された場合。

  • ステート認識 (保持モード 1) セッションでのアクセス違反 (無効なセッション ID など)。

V3 上記のレベルに指定した情報のほかに、InterSystems IRIS ヘッダおよび HTTP ヘッダの情報を記録します。

注:このログ・レベルが個々のサーバに対して指定されている場合、要求ヘッダはログに記録されませんが、応答ヘッダやその他のデータは記録されます。

V4 上記のレベルに指定した情報のほかに、ステート認識セッションのシリアル化に関する情報を記録します。

注:このログ・レベルが個々のサーバに対して指定されている場合、要求ヘッダはログに記録されませんが、応答ヘッダやその他のデータは記録されます。

V5

上記のレベルに指定した情報のほかに、WebSocket プロトコルを介して InterSystems IRIS との間で送受信されたデータ・バッファの内容を記録します。データ・フレーミング (該当する場合) もすべて記録されます。最後に、作成された WebSocket の性質に関する詳細情報も初期接続時に記録されます。 以下に例を示します。

  • WebSocket 接続

  • InterSystems IRIS で受け入れられた WebSocket 接続 : WSClassProtocolVersion=2; SharedConnection=0; NoDataFraming=2; BinaryData=1;

注:このログ・レベルが個々のサーバに対して指定されている場合、要求ヘッダはログに記録されませんが、応答ヘッダやその他のデータは記録されます。

V6 上記のレベルに指定した情報のほかに、以下の情報を記録します。
  • InterSystems IRIS に送信するデータ・ブロックのヘッダ。

  • Web サーバからの要求データ (マルチパートの添付を除く)。

  • InterSystems IRIS から受信したデータ・ブロックのヘッダ。

注:このログ・レベルが個々のサーバに対して指定されている場合、要求ヘッダはログに記録されませんが、応答ヘッダやその他のデータは記録されます。

V7 上記のレベルに指定した情報のほかに、InterSystems IRIS から返された内容全体を記録します。

注:このログ・レベルが個々のサーバに対して指定されている場合、要求ヘッダはログに記録されませんが、応答ヘッダやその他のデータは記録されます。

V9 着信 HTTP 要求データを記録します。すべての HTTP 要求の本文すべてが記録されます。このログ指示文は、さらに拡張し、改善することができます。
  • v9r : HTTP 要求すべてのログに加えて、HTTP 応答すべてを記録します。

  • v9a : Web ゲートウェイのホーム・ディレクトリで http.log に HTTP 要求をすべて記録します。

  • v9b : セッションごとに HTTP 要求をすべて記録します。ログ・ファイルは、http[session_id].log の形式で、Web ゲートウェイのホーム・ディレクトリに作成されます。ここで、session_id は 10 バイトのセッション ID です。

  • v9m : Web ゲートウェイのホーム・ディレクトリにマルチパート・ポストをすべてログします。未処理の着信 HTTP 要求は、個々のコンポーネントと共に、暗号化された形式と解読された形式の両方で記録されます。

注:V9、V9r、V9a、および V9b の形式は、個々のサーバに対して指定された場合、影響はありません。これらのログ形式は、既定のレベルでのみ有効にできます。

s

セッション : セッション・トークンの管理に関する以下の情報を記録します。

  • 新しいセッション ID が割り当てられるポイント。

  • 既存のセッションについて : セッション・トークンが cookie と形式/URL 変数 CSPCHD のどちらから抽出されたものかを示します。

  • すべての要求について : InterSystems IRIS に送信される最終セッション ID。

注:このログ・オプションは、個々のサーバに対して指定された場合、影響はありません。このオプションは、既定のレベルでのみ有効にできます。

c

接続 : Kerberos ライブラリを使用して作成された接続に関する情報を記録します (IRISCONNECT)。

小文字の c のログ・レベルを含めて、呼び出されたすべての IRISCONNECT 関数の完全な監査を、指定された入力パラメータおよび返された結果と共に記録するよう、Web ゲートウェイに指示します。簡潔にするため、InterSystems IRIS との間の入力および出力バッファの内容はこのレベルでは記録されません。 IRISCONNECT 関数の呼び出しに加えて、入力および出力バッファの内容を記録するには、大文字の C のログ・レベルを設定します。

Web ゲートウェイで提供されるログ機能のほかに、内部プロセスを記録する詳細なトレースを生成するよう、IRISCONNECT ライブラリに指示することもできます。 さらに IRISCONNECT トレースの生成も要求するには、必要なトレースのタイプを示す数字を c ディレクティブに追加します。

例えば、標準のゲートウェイ・ログ・エントリにログ・レベル c3 を追加すると、レベル 3 の IRISCONNECT トレースが生成されます。 有効な IRISCONNECT トレース・レベルは 1 ~ 6 で、以下のように定義されます。

  • 6 — エラー

  • 5 — 警告

  • 4 — 情報メッセージ

  • 3 — 出力データ

  • 2 — 入力データ

  • 1 — 通常イベント

Web ゲートウェイのログ・レベルとは異なり、IRISCONNECT トレースでは、ログ・レベルが高いほど詳細ではなくなります。 このため、ログ・レベル 1 が最も詳細なトレース・ファイルを提供します。Web ゲートウェイは、Web ゲートウェイのホーム・ディレクトリにある irisconnect.log というファイルにトレースを保持するよう、IRISCONNECT ライブラリに指示します。 このファイルのセキュリティ上の考慮事項および権限は、Web ゲートウェイ・イベント・ログと同じです。

注:IRISCONNECT トレースはプロセスごとにしか有効にできないため、サーバに対して完全に分離することはできません。いったん構成したら、新しい SSL 接続が試行されるまで、トレース・ログ生成はトリガされません。

t

転送 : Web ゲートウェイが送受信した未処理のデータ・バッファを記録します。このオプションの形式は t[x][y] です。

x は、Web ゲートウェイと InterSystems IRIS の間で転送されたデータ・バッファを記録するよう Web ゲートウェイに指示し、値 y は、ホスト Web サーバ経由で Web ゲートウェイとクライアントとの間で転送されたデータ・バッファを記録するよう Web ゲートウェイに指示します。

x および y に利用可能な値は、以下のとおりです。

  • 0 : 転送データを記録しません。

  • 1 : 要求データのみを記録します。

  • 2 : 応答データのみを記録します。

  • 3 : 要求データと応答データを記録します。

小文字 t を使用した場合、Web ゲートウェイは各バッファの転送データの最初の 256 バイトのみを記録します。 大文字 T を使用した場合、Web ゲートウェイはデータ・バッファ全体を記録します。出力できない文字はすべて、エスケープされた形式で記録されます。注:このログ・レベルが個々のサーバに対して指定されている場合、y オプションにより、クライアントに送信された応答バッファは記録されますが、クライアントから受信する要求バッファは記録されません。

p[n]

パフォーマンス : CSP インストールのパフォーマンスを評価するための情報を取得するようにゲートウェイに指示します。

n に指定した秒数 (サービス時間の合計) を下回ると、要求に対するデータは記録されません。例えば、指示文 p ではすべての要求のデータが記録されますが、p2 ではサービス時間が 2 秒を超える要求のデータが記録されます。

記録される情報は以下のとおりです。

  • 要求にサービスを提供した総時間 : 要求にサービスを提供するために費やされた時間の合計 (要求が Web ゲートウェイに到着してから、応答データの最後のバイトが Web ゲートウェイ環境を離れるまでの時間)。

  • InterSystems IRIS への [新規] 接続を取得 : 要求が Web ゲートウェイに到着してから、要求にサービスを提供するために予約されていた InterSystems IRIS に接続するまでにかかった時間。記録されたメッセージは、(再使用されている既存の接続に対して) この時間中に新しい接続が作成されたかどうかを示します。

  • InterSystems IRIS に要求を送信 : 要求データの先頭バイトを Web サーバから読み取り、最終バイトを InterSystems IRIS に送信するまでにかかった時間。

  • InterSystems IRIS で要求を処理 : 要求データの最終バイトを InterSystems IRIS に送信してから、応答データの先頭バイトが Web ゲートウェイで受信されるまでにかかった時間。

  • InterSystems IRIS から応答を受信 : 応答データの先頭バイトを InterSystems IRIS から受信してから、最終バイトを Web サーバに送信するまでにかかった時間。

p[n]([v])

パフォーマンス・モニタの結果に基づいて、詳細ログを条件付きで有効にする機能を提供します。処理に一定時間以上かかる要求について、詳細情報を記録する必要がある場合に便利です。

n は、パフォーマンス・データが記録されるオプションの処理時間下限値 (秒単位) で、v は必要な詳細ログ・レベルです。

このメカニズムは、詳細イベント・ログと HTTP ログ設定に適用されます。エラー情報を記録する要求の場合は、パフォーマンス・モニタによって記録されるかどうかに関係なく、常にすべての要求に e が適用されます。

以下に例を示します。 ep5(v9)このオプションでは、すべての要求について、要求を処理する際に発生したすべてのエラーを記録します (e)。さらに、HTTP 要求メッセージを記録しますが (v9)、処理時間が 5 秒を超える要求のみを記録します (p5)。

ゲートウェイ・イベント・ログは、パフォーマンスに与える影響を最小限に抑え、使用するシステム・リソースに関して専有するフットプリントが小さくなるように設計されています。このため、以下の制限が適用されます。

  • 個々の設定ごとに、1 つの詳細ログ・レベルのみを指定できます。 すなわち、パフォーマンス・モニタによって記録される要求にレベル v9 を指定し、他のすべての要求にレベル v2 を指定することはできません。 例えば、v2p5(v9) を指定した場合、条件付きで適用された v9 レベルのみが使用されます。

  • Web ゲートウェイ構成では、イベント・ログ・レベルをグローバルにも、サーバごとにも指定できます。詳細ログが有効な場合、一部のレコードはターゲットの InterSystems IRIS サーバがそのように指定される前に書き込み済みであるため、最善の結果を得るには、[デフォルトパラメータ] で条件付きログをグローバル・レベルで指定することをお勧めします。

pp[n]

詳細の時間計測情報を以下に示します。

  • 要求の前処理 : 対象 InterSystems IRIS サーバの特定にかかった時間。Web サーバからの初期受け渡しおよびサーバを特定するための基本的な要求処理を含みます。

  • InterSystems IRIS への [新規] 接続を取得 : 接続を適切な InterSystems IRIS サーバに割り当てるまでにかかった時間。 (既存の接続の再使用ではなく) 新しい接続が作成されたかどうかを示します。

  • 要求をフォーマット : InterSystems IRIS に送信する要求メッセージの解析およびフォーマットにかかった時間。

  • InterSystems IRIS に要求を送信 : 要求データの先頭バイトを Web サーバから読み取り、最終バイトを InterSystems IRIS に送信するまでにかかった時間。

  • InterSystems IRIS で要求を処理 : 要求データの最終バイトを InterSystems IRIS に送信してから、応答データの先頭バイトが Web ゲートウェイで受信されるまでにかかった時間。

  • 応答の後処理 (b) : Content-Length ヘッダが必要な場合、Web サーバを介して応答データをクライアントに送信して戻すまでにかかった時間が報告されます。

  • 応答の後処理 (c) : 応答を送信してから、InterSystems IRIS からの応答フッタのデータを Web ゲートウェイが読み取る準備が完了するまでにかかった時間。 フッタのデータは、Web ゲートウェイと InterSystems IRIS の間の内部通信プロトコルの一部であり、制御情報 (セッションの保持設定を変更する命令など) を含みます。

  • InterSystems IRIS からフッタを受信 : InterSystems IRIS から応答フッタのデータを受信するまでにかかった時間。

  • フッタの後処理 : フッタのデータを処理し、受信した命令に応答するまでにかかった時間。

  • InterSystems IRIS への接続を解放 : アクティブな接続を InterSystems IRIS に解放するまでにかかった時間。

  • クリーンアップ : 要求にサービスを提供する際に使用したリソースを解放し、ホスト Web サーバに制御を返すまでにかかった時間。

W (または w)

Windows では、クラッシュが発生するとメモリ・ダンプが生成されます。このオプションは大文字と小文字を区別しません。

AIX では、gencore ユーティリティを使用してコア・ファイルが生成されます。このオプションは大文字と小文字を区別しません。

Linux または MacOS では、このオプションは大文字と小文字を区別します。w を指定すると、gcore を使用して標準のコア・ダンプが生成されます。W を指定すると、gcore -a を実行してすべてのメモリ・マッピング (共有メモリを含む) がコア・ファイルにダンプされます。

Unix システムでは、次の前提条件が満たされる必要があります。

  • gcore (Linux または MaxOS) または gencore (AIX) がマシン上に存在し、PATH 環境変数により使用可能であること。Linux および MacOS システムでは、gcore のバージョンが -a コマンド行オプションをサポートしている必要があります。

  • Web サーバのワーカ・プロセスに、Web ゲートウェイ・モジュールが配置されているディレクトリへの書き込み権限があること。既定のインストールの場合、このディレクトリは /opt/webgateway/bin です。

  • Root 以外のプロセスに、同じユーザ ID で実行される別のプロセスのコア・ダンプを生成する権限があること。MacOS では、システム整合性保護が無効である必要があります。

    Linux では、(RHEL および Ubuntu システムのように) Yama セキュリティ・モジュールが存在する場合、コマンド echo 0 | sudo tee /proc/sys/kernel/yama/ptrace_scope を実行して、次の再起動まで必要な権限を付与します。この権限を永続的に付与するには、ファイル /etc/sysctl.d/10–ptrace.conf を作成または編集します。"Kernel.yama.ptrace_scope" で始まる行がある場合、これを "kernel.yama.ptrace_scope = 0" に変更します。そのような行が存在しない場合は、"kernel.yama.ptrace_scope = 0" を追加してから、sysctl —p を実行します。

    Note:

    セキュリティ上の理由により、このような権限は一時的にのみ付与することをお勧めします。

FeedbackOpens in a new tab