ArcGIS Notebook Server は、サイト内で発生するイベントと、それらのイベントに関連するエラーをログに記録します。 これらのログは、サイト管理者によって使用されます。
ログは、ArcGIS Notebook Server サイトの問題を監視してトラブルシューティングするための重要なツールです。 ログが提供する情報は、エラーを特定し、問題の対処方法とエラーの解決方法を理解するのに役立ちます。 ログは、サイト内で発生するイベントの記録システムとしての役割も果たします。
たとえば、次のタイプのイベントがログに記録されます。
- ソフトウェア認証やサイト作成などの、インストールおよびアップグレード イベント
- ArcGIS Notebooks の開始と終了
- サイトによって実行されたクリーンアップ タスク
- ノートブック ランタイムの追加や削除、サーバー ディレクトリの作成、セキュリティ設定の構成など、管理者が実施するサイト管理イベント
- サイトにサイン インするユーザー、SSL 証明書のインポートとエクスポートなどのセキュリティ イベント
一部のイベントは、ArcGIS Notebook Server ログに記録されません。 これには、ポータルへのサイトのフェデレーションも含まれます。 ArcGIS Notebooks 内で行われるイベント (コンテンツの追加、セルの実行など) は記録されません。 また、コンピューターの Docker コンテナー内で行われるイベントも記録されません。コンテナー固有のログを表示するには、以下の「Docker コンテナー ログの表示」をご参照ください。
使用可能なログ レベル
各ログの詳細は、その度合いが低い方から高い方に、次のレベルに分かれています。
- [重大]: 迅速な対処を必要とする重大な問題。
- [警告]: 対処を必要とするが、それほど深刻ではない問題。
- [情報]: サービスの作成および開始に関するメッセージなど、Notebook Server サイトの一般的な管理メッセージ。
- [詳細] - 受信した操作リクエストの名前など、サーバーの使用による一般的なメッセージ。
- [冗長]: サーバーで操作がどのように実行されるかについての詳細を提供するメッセージ。
- [デバッグ]: トラブルシューティング時にサーバーの状態を適切に確認したい開発者やサポート技術者向けに設計された、非常に詳細なメッセージ。 膨大な量のログが作成されるため、本番システムでの使用は推奨されていません。
ArcGIS Notebook Server Administrator Directory では、作成される最も詳細なログ レベルを指定することができます。 たとえば、レベルを [詳細] に設定した場合、サーバー サイトでは [重大]、[警告]、[情報]、[詳細] レベルのメッセージを記録します。
ログ コード
ログ コードの範囲は、特定のタイプのメッセージと関連付けられています。 ログ コードの範囲とそのコンテンツ タイプについて次の表で説明します。
| ログ コードの範囲 | メッセージの内容 |
|---|---|
1000 ～ 4999 | コア ArcGIS Notebook Server フレームワーク |
5000 ～ 6999 | Docker SDK およびコンテナー関連 |
7000 ～ 7200 | ノートブック |
7200 ～ 7299 | ノートブック Web ツール |
7300 ～ 7399 | ノートブックのスナップショット |
7400 ～ 7499 | ノートブックのコード スニペット |
Manager のクエリ ログ
10.8 以降、ArcGIS Notebook Server Manager には [ログ] ページが含まれています。 このページで、ArcGIS Notebook Server サイトのすべてのログを検索できます。
- 管理者として ArcGIS Enterprise ポータルにサイン インし、ArcGIS Notebook Server Manager を開きます。
- [ログ] ページを開きます。
- 検索フィルターのパラメーターはページの上部にあります。 任意のパラメーターを使用して、検索を制限または拡張します。
- [ログ レベル] - 検索する最低限のログ レベル (上記のセクションを参照)。 このレベル以上のログ レベルのレコードのみが返されます。 デフォルト レベルは WARNING です。
- [ログ時間] - 検索対象のログ期間。 検索対象を過去 15 分間、過去 1 時間、過去 6 時間または 24 時間、過去 1 週間、または過去 30 日間に制限するか、サイト作成以降のすべてのログを表示することができます。
ヒント:
3 日前 ～ 2 日前のログなど、現時点以外の終了時刻を指定する場合は、Administrator Directory を使用してログを検索します。
- [コンピューター] - 検索対象を 1 台の ArcGIS Notebook Server コンピューターのログに制限するか、すべてのコンピューターのログを表示します。
- [リクエスト ID] - ログをクエリ検索する 1 つ以上のサーバー リクエストのカンマで区切られたリクエスト ID。 一部のログ メッセージは、特定のリクエストと関連しています。
- [ユーザー] - 検索対象の関連ログを含む 1 人以上のユーザー名 (カンマ区切り)。 一部のログ メッセージは、特定のユーザーのアクションと関連しています。
- [ログ コード] - ログ メッセージに割り当てられた 1 つ以上のログ コード。 空白のままにした場合、すべてのログ コードが表示されます。
- [検索] をクリックしてクエリを実行します。 検索パラメーターに一致するすべてのログが出力テーブルに表示されます。
ArcGIS Notebook Server Manager のログ設定の変更
ArcGIS Notebook Server Manager を使用して、サイトのログ設定を変更することもできます。
- 管理者として ArcGIS Enterprise ポータルにサイン インし、ArcGIS Notebook Server Manager を開きます。
- [設定] ページを開き、[ログ] をクリックします。
- 以下の設定を変更できます。
- [ログ ディレクトリ] - ログ ディレクトリのディスクの場所。 サイトに複数のコンピューターが存在する場合は、このパスが UNC 共有であることを確認してください。
- [ログ レベル] - サイトが書き込む最も詳細なログ レベル。 たとえば、FINE に設定した場合、サイトは VERBOSE レベルまたは DEBUG レベルのログを保持しません。
- [ログを保持する日数] - ログ メッセージが削除されるまでの日数。 ログ ディレクトリのドライブで使用可能なメモリ、選択した [ログ レベル] 設定、およびサイトでのアクティビティ レベルを考慮してください。 たとえば、ログ レベルを変更して詳細レベルで書き込みを開始する場合、ログを保持する日数を減らしてもかまいません。
- [保存] をクリックして、変更を確定します。
ArcGIS Notebook Server Administrator Directory を使用したサーバー ログの検索
サーバー ログをクエリ、表示、構成、削除するには、ArcGIS Notebook Server Administrator Directory を使用します。
ログにアクセスするには、以下の手順に従います。
- Administrator Directory にサイン インします。 URL の形式は、https://notebookserver.domain.com:11443/arcgis/admin または https://notebookserver.domain.com/<webadaptorname>/admin です。
- [Logs] > [Query] の順にクリックし、現在のログをクエリし、確認します。 ページのフィルター コントロールを使用すると、期間やログ レベルなどのカテゴリ別にイベントを絞り込むことができます。
- [Logs] > [Settings] をクリックすると、デフォルトのロギング レベル (前述)、ディスク上にログが保持される期間、ログが書き込まれる場所など、ログの設定を管理できます。
- [Clean Logs] をクリックすると、ArcGIS Notebook Server サイトからすべてのログ ファイルが削除されます。
ArcGIS Notebook Server Manager による Docker コンテナー ログの表示
ArcGIS Notebook Server Manager を使用してサイトの Docker コンテナーに固有のログを表示することができます。
- ポータルの ArcGIS Notebook Server Manager に管理者としてサイン インします。 URL の形式は、https://webadaptorhost.domain.com/webadaptorname/home/notebook/manager.html です。
- [コンテナー] タブを参照します。
- [ログの表示] ボタンをクリックして、選択したコンピューターのコンテナー ログを表示します。
Docker コマンド ラインによる Docker コンテナー ログの表示
Docker コマンド ライン インターフェイスを次のように使用すると、サイトの Docker コンテナーに固有のログを表示することができます。
- Administrator Directory にサイン インします。 URL の形式は、https://notebookserver.domain.com:11443/arcgis/admin または https://notebookserver.domain.com/<webadaptorname>/admin です。
- [System] > [Containers] の順に選択します。 ログを表示するコンテナーを探し、その ID をクリックします。
- コンテナーの URL に ?f=pjson を追加して URL の形式を https://notebookserver.arcgis.com/<webadaptorname>/admin/system/containers/<container>?f=pjson に変更し、コンテナーの情報ページの JSON ビューを開きます。
- コンテナーの containerId を探し、値を記録します。
- Docker 権限を持つユーザーとしてコマンド プロンプトを開きます。
- 記録した値を使用し、docker logs <containerId> コマンドを実行します。 これにより、そのコンテナーに固有の Docker ログが返されます。