Gateway のログの表示

Gateway は、問題のトラブルシューティングに役立つ包括的なログのセットを保持します。
gateway10cr2
Layer7 API Gateway
は、問題のトラブルシューティングに役立つ包括的なログのセットを保持します。
Gateway アプライアンスのメニューを使用したログの表示
ログを表示する最も簡単な方法は、Gateway アプライアンスのメイン メニューを使用することです。
メニューを使用して Gateway アプライアンスでログを表示する方法
以下の表では、各ログ オプションについて説明します。
ヒント:
ログを閉じるには、「
q
」を入力します。
オプション
説明
View system logs
このオプションを使用して、さまざまなシステム ログを表示します。
  • View main log:
    /var/logs/messages.*
    のログを表示します。
  • View security log:
    /var/log/secure.*
    のログを表示します。
  • View command log:
    /var/log/bash_commands.log.*
    のログを表示します。
  • View MySQL log:
    /var/log/mysqld.log
    のログを表示します。
View Gateway logs
このオプションを使用して、さまざまな Gateway ログを表示します。
  • View node log:
    以下のデフォルト ログを表示します。
    /opt/SecureSpan/Gateway/node/default/var/logs/ssg_X_0.log
  • View host log:
    以下のログを表示します。
    /opt/SecureSpan/Controller/var/logs/sspc_X_0.log
  • View patch history log:
    以下のログを表示します。
    /opt/SecureSpan/Controller/var/logs/patches.log
  • View patch client log:
    以下のログを表示します。
    /opt/SecureSpan/Controller/var/logs/patch_cli_X_0.log
  • View patch verifier log:
    以下のログを表示します。
    /opt/SecureSpan/Controller/var/logs/patch_verifier_X_0.log
View Enterprise Service Manager Log
(Enterprise Service Manager が存在する場合のみ)
このオプションを使用して、
Layer7 API Gateway
- Enterprise Service Manager のログを表示します(存在する場合)。
/opt/SecureSpan/EnterpriseManager/var/logs/ssem_X_0.log
Gateway アプライアンスのファイル構造を使用したログの表示
Gateway のログ ファイル ディレクトリにファイル構造からアクセスすることもできます。Gateway は、以下の場所にイベントまたはメッセージのログを記録します。
  • /var/log/messages.*:
    これらのログには、Gateway の起動および停止に関連するメッセージ、プライベート認証メッセージ、および Gateway サービスに関するエラー状況が含まれます。また、これらのログには、ターミナルで発行されたコマンドも記録されます。
  • /var/log/secure.*:
    これらのログには、認証に関連する、ターミナルで入力されたコマンドおよびすべてのメッセージが含まれます。
  • /var/log/ssg_gc.log.*:
    これらは、ガベージ コレクションの GC ログです。これらのログには、デバッグ目的に役立つ情報が含まれています。ログは、Gateway プロセスによって保持およびロールオーバーされます(sg_gc.log.0 から ssg_gc.log.9 まで)。デフォルトでは、容量が 20 MB のログ ファイルが 10 個あります。このログ ファイルが使用され、いっぱいになるとロールオーバーされます。
  • /var/log/bash_commands.log:
    このログには、ターミナルで入力された bash コマンドが記録されます。また、Gateway のメイン メニューからのすべてのアクティビティが記録されます。
  • /opt/SecureSpan/Controller/var/logs/:
    これらのログには、プロセス コントローラによって生成されたメッセージが含まれます。
  • /opt/SecureSpan/Gateway/node/default/var/logs/ssg*
    : システムが起動すると、以降の Gateway のログはこのディレクトリのログ ファイルに書き込まれます。ログは、Gateway プロセスによって保持およびロールオーバーされます(ssg_0_0.log から ssg_0_9.log まで)。デフォルトでは、容量が 20 MB のログ ファイルが 10 個あります。このログ ファイルが使用され、いっぱいになるとロールオーバーされます。「default_startup_0_0.log」ファイルには、起動ログ情報が格納されます。
    ログ ボリュームが少ない環境では、デフォルト設定(10 ログ ファイル/20 MB)が最適です。1 つのログ ファイルを数分で書き込むことができるような、トランザクション率が高い場合は、これらの値を大きくする必要がある場合があります。ログ ファイルのサイズと数を変更するには、ログ シンクのプロパティの[File Settings]タブを使用します。
  • /opt/SecureSpan/Platform/data/log/FoundationServices.log
    : このログには、制限付きシェルのコマンドで生成されたメッセージが含まれています。
  • /opt/SecureSpan/Gateway/config/backup/logs
    : このログには、 Gateway のバックアップに関連するメッセージが含まれています。
ログは起動時に作成され、ログの記録は起動時からシャットダウン時まで行われます。ログを手動で削除できるのは、Gateway が実行されていないときです。
ソフトウェア Gateway のログの表示
ソフトウェア Gateway のログを表示するには、以下の場所にあるログ ファイルを開きます。
  • /opt/SecureSpan/Gateway/node/default/var/logs/ssg*:
    Gateway のログは、このディレクトリにあるログ ファイル システムに書き込まれます。ログは、Gateway プロセスによって保持およびロールオーバーされます(ssg_0_0.log から ssg_0_9.log まで)。デフォルトでは、容量が 20 MB のログ ファイルが 10 個あります。このログ ファイルが使用され、いっぱいになるとロールオーバーされます。
ログは起動時に作成され、ログの記録は起動時からシャットダウン時まで行われます。ログを手動で削除できるのは、Gateway が実行されていないときです。
Policy Manager でのログの表示
Policy Manager には組み込みのログ ビューアがあり、ログ ファイルが既存のログ シンクと関連付けられている場合に、クラスタ ノードから
Layer7 API Gateway
ノードのログを表示するために使用できます。ログを使用すると、ノードの問題の診断および解決に役立ちます。
Policy Manager を使用して
ログを表示する方法
  1. Policy Manager で、メイン メニュー(ブラウザ クライアントでは、[
    Monitor
    ]メニュー)から[
    View
    ]-[
    View Logs
    ]を選択します。表示可能なログがリスト表示されます。ログのリストが長い場合、[Filter]ボックスにいくつかのテキストを入力することにより、表示をフィルタできます。フィルタ文字列は、[Last Modified]を除くすべての列と照合されます。
    フィルタが入力されている場合、「Caution! Filter may exclude some logs.」というメッセージによって、リストがフィルタされていることが示されます。
    [Select Log]ダイアログ ボックスには、ローカル ログのみが表示されます。ローカル ログとは、ログ シンクのプロパティのタイプが「File」のものです。
  2. 表示する 1 つ以上のログ ファイルを選択して、[
    View
    ]をクリックします。複数のファイルを選択するには、
    Ctrl
    キーを押したままファイルを選択します。ログの詳細が[Log Viewer]に表示されます。以下の表では、[Log Viewer]ダイアログ ボックスの各部について説明しています。
    設定
    説明
    <ログ エントリ>
    ダイアログ ボックスの上部のボックスには、選択したログのエントリがすべて表示されます。任意の行をクリックすると、下部のログ エントリの詳細ボックスに表示できます。
    tail オプションが選択されている場合、ログ エントリのリストは動的に更新され、最新の X 個のログ エントリが表示されます。
    [Filter]に入力されている場合、このボックスにはフィルタ文字列に一致するテキストを持つログ エントリのみが表示されます。
    <ログ エントリの詳細>
    表示するログ エントリを選択すると、この詳細ボックスに、より読みやすい詳細が行の折り返し付きで表示されます。
    Filter
    ログ エントリのリストをフィルタするには、フィルタ文字列を入力します。表示は、その文字列が含まれる行のみを表示するために、自動的に更新されます。たとえば、重大度が WARNING のログ エントリのみを表示するには、このボックスに「warning」と入力します。
    フィルタが有効な場合、エントリがすべて表示されていないことを示すメッセージが表示されます。
    フィルタをクリアするには、文字列を削除します。
    フィルタ文字列では大文字と小文字は区別されず、ログ エントリのすべての部分と照合されます。
    View last xxx line(s)
    最新の xxx 個のログ エントリのみを表示するには、このチェック ボックスをオンにします。新しい行は、使用可能になると表示されます(フィルタされていない場合)。表示する最新のエントリ数を入力します。最大は 100 です。
    ログの全内容を表示するには、このチェック ボックスをオフにします。
    このチェック ボックスをオフにした後、
    [Refresh]
    をクリックすると表示が更新されます。
    Auto-Refresh
    数秒ごとに
    Layer7 API Gateway
    から新しいログ データを取得するには、このチェック ボックスをオンにします。ログの表示は、ログの最新の行を表示するために自動的にスクロールされます。
    Refresh
    ]ボタンをクリックした場合にのみログを更新するには、このチェック ボックスをオフにします。
    Showing xx/xx line(s)
    表示可能なエントリの総数と、現在ログ ウィンドウに表示されているイベントの総数を表示します。これは、フィルタを使用した場合に、表示されている行数を確認するために役立ちます。
    Refresh
    表示されているログ データを更新するには、このボタンをクリックします。
    [Auto-Refresh]がオンの場合に[
    Refresh
    ]ボタンは必要ありませんが、自動リフレッシュ間で表示を更新するためにも使用できます。
    Cancel
    手動のリフレッシュをキャンセルするには、このボタンをクリックします。たとえば、リフレッシュの完了までに時間が長くかかるときに、キャンセルする場合があります。
    Last Updated
    自動および手動のいずれのリフレッシュでも、最新の更新日時が表示されます。
  3. 完了したら、[
    Close
    ]をクリックして[Log Viewer]および[Select Log]ダイアログ ボックスを閉じます。
ログ ファイルの保存
ログを保存する前に、保存するエントリが表示されていることを必ず確認してください。フィルタされているデータは保存されません。たとえば、「Severe」イベントを表示している場合は、「Severe」イベントのみが保存されます。ログ全体を保存する場合は、必ず最初にフィルタをクリアします。
ログを保存する方法
  1. [Log Viewer]ダイアログ ボックスで、[
    File
    ]-[Save as]を選択します。
  2. ファイル名および場所を指定するか、表示されたデフォルトを使用します。
    表示されるファイル名を使用すると、保存したログの並べ替えおよび整理がより簡単になります。「.txt」ファイル拡張子は変更しないでください。
  3. Save
    ]をクリックします。
保存済みのログを表示する方法
  • 任意のテキスト エディタを使用して、保存済みのログ ファイルを開きます。
ログ メッセージ形式の設定
デフォルトでは、Gateway のログは標準的な量の詳細情報を提供します。必要に応じて、詳細情報または未処理のメッセージを表示するように形式を変更できます。
ログ メッセージ形式の変更は、システム管理者または上級技術者ユーザのみが試みる必要があります。
Layer7 API Gateway
ログ メッセージ形式を設定するには、以下のプロパティを
ssglog.properties
ファイル内で編集します。
sink.format.
<format>
sink.format.
<log sink name>
.
<format>
例:
  • sink.format.VERBOSE
    は、すべてのログ シンク用の VERBOSE レベルのメッセージをフォーマットします。
  • sink.format.MyErrorSink.RAW
    は、「MyErrorSink」という名前のログ シンクのメッセージをフォーマットします。
Layer7 API Gateway
では、Java 標準/デフォルト ログ フォーマッタ
java.util.logging.SimpleFormatter
をログ メッセージ用に使用します。詳細については、OpenJDK ドキュメントの次のページを参照してください: https://devdocs.io/openjdk~8/java/util/logging/simpleformatter
以下の表では、デフォルトのフォーマット文字列について説明します。
ログ形式
フォーマット文字列
RAW
%4$s
STANDARD
%2$s %3$s: %4$s
VERBOSE
[%8$s] %2$s %3$s %6$s: %4$s
このフォーマット文字列は、Java の
String.format
フォーマット文字列です。以下の表では、フォーマット文字列内の数値によって参照される、ログに記録できる項目を示します。
インデックス値
Data
1
JVM 時間(ミリ秒)
2
Java ログ レベル(INFO、WARNING など)
3
ロガー名(ログ メッセージの生成元のクラス)
4
ログに記録されたメッセージ
5
スレッド ID (これはより低いレベルで Syslog にすでに書き込まれていることに注意してください)
6
ログ メッセージの生成元のソース メソッド
7
例外メッセージ(これは必要に応じて自動的に追加されます。使用しないでください)
8
ログ シンク名
ログ形式が使用される場所の詳細については、「ログ シンクのプロパティ」を参照してください。
すべてのログが表示されない
アクセス可能なすべてのログをロードするときに問題が発生した場合は、以下の手順に従ってログのシャットダウン時間を増やします。
Windows
  1. Policy Manager フォルダに移動し、
    Layer7 API Gateway
    Policy Manager.ini
    ファイルを編集モードで開きます。
  2. 以下の例に示すように、commandline jvm の引数に
    -Dcom.l7tech.console.logMaxShutdownTime=<timeinterval>
    を追加します。時間間隔はミリ秒単位で指定します。
    デフォルト: 8000
    [startup] jre=jre\bin\javaw.exe commandline=javaw -Dfile.encoding=UTF-8 -Duser.language=en -Duser.country=US -Xms128M -Xmx1024M -Xss256k
    -Dsun.net.inetaddr.ttl=10 -Dnetworkaddress.cache.ttl=10 -Dcom.l7tech.console.logMaxShutdownTime=15000 -jar Manager.jar
  3. ファイルを保存し、Policy Manager を再起動します。
MacOS/Linux
  1. Policy Manager フォルダに移動し、
    Manager.sh
    ファイルを編集モードで開きます。
  2. 以下の例に示すように、
    -Dcom.l7tech.console.logMaxShutdownTime=<timeinterval>
    を追加します。時間間隔はミリ秒単位で指定します。
    デフォルト: 8000
    # include startup options
    extra="
    -server
    -Dcom.l7tech.proxy.listener.maxthreads=300
    -Dsun.net.inetaddr.ttl=10
    -Dnetworkaddress.cache.ttl=10
    -Dfile.encoding=UTF-8
    -Duser.language=en
    -Duser.country=US
    -Dcom.l7tech.console.logMaxShutdownTime=15000
    "
  3. ファイルを保存し、Policy Manager を再起動します。