Monitoring the Health of Altium On-Prem Enterprise Server

Enterprise Server には包括的なヘルスモニタリングシステムが搭載されており、管理者は Enterprise Server の状態、つまり「ヘルス」を迅速に把握・分析することができます。ヘルスモニターは、Workspace ブラウザーインターフェースの Admin セクション(Server Health ページ)から利用できるほか、Enterprise Server をホスト PC にインストールした際に含まれるスタンドアロン実行ツール(Server Health Monitor ツール)としても利用可能です。

このヘルス機能は、Enterprise Server の構成やサービスの状態、ホストマシンのシステムリソースに関する情報を視覚的にまとめて表示し、ステータスレポートやログファイルへのアクセスも提供します。これにより、Enterprise Server の状態を即座に把握でき、管理者は Workspace ユーザーに影響を及ぼす可能性のある問題を事前に検出し、解決することができます。

Enterprise Server のヘルスやステータスを監視する各アプローチには、それぞれ独自の利点があります:

  • Server Health page – Enterprise Server Workspace のブラウザーインターフェースの一部として、Server Health ページはローカルネットワーク経由で管理者が利用でき、リモートアクセスの利便性を提供します。
  • Server Health Monitor tool – スタンドアロンの Health Monitor 実行ファイル(avhealth.exe)は、Enterprise Server の状態に関わらずアクセス可能であり、万が一 Enterprise Server が正常に動作していない場合でも重要なデータや情報を提供します。

Server Health ページ

Workspace のブラウザーインターフェース内で、メインメニューから Admin – Health を選択し、Server Health レポーターページにアクセスします。ここでは、ページ上部 Status セクション(Updated at: <timestamp>)に表示されているタイムスタンプ時点での Enterprise Server インストール全体のステータスが示されます。

Server Health ページでは、Enterprise Server の状態およびそのサポートインフラの状況を即座に確認できます。
Server Health ページでは、Enterprise Server の状態およびそのサポートインフラの状況を即座に確認できます。

サーバーヘルスの視覚的な概要に加え、以下の機能も提供されます:

  • Altium のサポート(最終的には Altium の開発者)に送信するためのステータスレポートを生成する機能。これを行うには、ページの Status エリア内の Generate status report for support team テキストの Generate 部分をクリックします。必要なレポートが生成され、1つの Zip アーカイブ(vault_status_report_<Date>.zip)にまとめられて、ブラウザーのデフォルトのダウンロードフォルダーにダウンロードされます。

  • すべてのログファイル(サーバーのすべての利用可能なログファイルからのエラーおよび警告エントリを含む。通常は \ProgramData\Altium\Altium365Data\logs フォルダーに保存)をダウンロードする機能。これを行うには、ページの Logs セクション内の Download all logs リンクをクリックします。ファイルは1つの Zip アーカイブ(AllLogs.zip)にまとめられ、ブラウザーのデフォルトのダウンロードフォルダーにダウンロードされます。

  • ページの Logs セクション下部にある Clear logs リンクを使用して、すべての既存ログファイルをアーカイブし、その後削除します。アーカイブ(logs_<Date>.zip)は \ProgramData\Altium\Altium365Data\logs.archive フォルダーに保存されます。

  • Server Health ページの情報は定期的に更新されます(ステータスのタイムスタンプで示されます)が、必要に応じて手動で更新することも可能です。サーバーのステータスを手動で更新するには、ページの Status エリア内の refresh status リンクをクリックしてください。サーバーおよびシステムのヘルスがチェックされ、ページが最新の状態にリフレッシュされます。日付と時刻は、サーバーヘルスが最後にチェックされた時点を示します。

    リフレッシュリンクをクリックして、Enterprise Server のヘルス情報を更新してください。リフレッシュリンクをクリックして、Enterprise Server のヘルス情報を更新してください。

    Enterprise Server のインストール後、最初のサーバーヘルスチェックは Health ページにアクセスしてから約5分後に行われます。手動でリフレッシュすることで、より早くチェックを実行できます。その後は自動チェックが4時間ごとに行われます。

エラーと警告

Enterprise Server のステータスを強調して表示するため、Server Health ページでは、懸念されるステータスエントリに対して個別の警告/エラーアイコンと説明が表示されます。よくあるアラートには、データバックアップの遅延、ライセンスの有効期限切れ間近、アクティブな admin/admin ユーザーアカウント、ログファイルで検出されたエラーエントリなどがあります:

  • OK  – 検出された指標が許容範囲または正常な状態にあります。
  • Warning  – Enterprise Server およびそのサポートインフラは正常に動作していますが、将来的な問題を回避するために変更が推奨されます。
  • Error  – Enterprise Server またはそのサポートインフラの一部が正常に動作または構成されておらず、即時の対応が必要です。

一般的な問題の修正

パフォーマンスやシステムの問題は、Enterprise Server ホスト PC のリソースやインフラを強化することで対処できる場合が多いですが、Server Health ページの Environment and configuration セクションで発生する問題は、Workspace 管理者向けの機能やツールを使って解決できることが一般的です:

  • Admin password – まだ作成していない場合は、Users ページで1つ以上の管理者アカウントを作成し、デフォルトの admin アカウントのパスワード(できればユーザー名も)を変更してください。

  • Log level – 必要に応じて、Enterprise Server のインストールフォルダー内にある LocalVault.ini ファイルの General セクションにある LogLevel= エントリを編集して、Enterprise Server のログレベルを変更します。許可されているレベルは Info(デフォルト)と Warn です。後者を選択した場合、一般的なステータス情報(API コール、サービスの開始・停止など)はログファイルに記録されませんが、エラーは常に記録されます。

  • Licenses – Enterprise Server ライセンスの有効期限切れエラーは、ブラウザーインターフェースの Licenses ページAdmin – Licenses)から対処できます。すでに期限切れの場合は、Enterprise Server ホストマシンのブラウザーインターフェースにアクセスして解決してください。

  • BackupsWorkspace バックアップは、ホスト PC の Enterprise Server インストール内の Tools\BackupTool フォルダーにある avbackup.exe ツールを使って実行できます。

レポートとログ

Enterprise Server およびホスト PC のパフォーマンスは(Performance および System セクションで)テスト・要約され、レポートログの生成・ダウンロードも可能です:

  • Logs – Enterprise Server のログは zip アーカイブとしてブラウザーのデフォルトダウンロード先(Download all logs)にダウンロードされます。これには、Enterprise Server がホストするすべてのサービスのプレーンテキストログが含まれ、各サービスのログファイルには、Enterprise Server のインストール以降、またはログがクリアされた(Clear logs)以降の時系列イベント(およびエラー)が記録されています。
  • Reports – Enterprise Server ステータスレポートは、ページ上部 Status セクションの Generate リンクから zip アーカイブとしてブラウザーのデフォルトダウンロード先にダウンロードされます。これは、すべての主要な Enterprise Server 要素の状態やセットアップを報告します。Altium サポートチーム向けの重要な情報として、ホスト PC のサポートインフラのステータスやパフォーマンス情報も含まれます。

Health Monitor ツール

Enterprise Server のインストールには、管理者がローカルレベルで Enterprise Server の状態、つまり「ヘルス」を迅速に把握・分析できる包括的な On-Prem Enterprise Server Health Monitor ツールが含まれています。Enterprise Server のインストールとともに提供されるスタンドアロンの独立したアプリケーションとして、Health Monitor はホストマシンの状態や Enterprise Server の構成・サービスの視覚的な概要を表示します。インターフェースには、状況に応じたヒントや、重要な場所やログファイルへの情報・パスも含まれています。

Health Monitor は、シンプルな GUI を通じて Enterprise Server のステータス情報を表示し、一般的には以下の重要な領域をカバーします:

  • Enterprise Server Environment – ホスト PC のハードウェア状態(ハードディスク、メモリ、CPU など)や、そのパフォーマンスの十分性。
  • Enterprise Server Backend– Enterprise Server のサポートデータベース、ファイルストレージ、およびリポジトリの状態。
  • Enterprise Server Services – Enterprise Server の各種サービス(Identity、Authorization、License Manager、Network Installation など)、IIS アプリケーションプールとしてホストされているサービスの状態。

ツールへのアクセス

Enterprise Server のデフォルトインストールでは、Health Monitor ツールは \Program Files (x86)\Altium\Altium365\Tools\HealthMonitor フォルダー内の avhealth.exe 実行ファイルとして見つけることができます。なお、このフォルダーにはコマンドライン用の簡易ツール avConsoleHealth.exe も含まれています。

GUI の Health Monitor ツール(avhealth.exe)を実行すると、プログラムは直ちに Enterprise Server およびそのホスティングシステムを調査し、メインの Health Monitor Dashboard 画面(デフォルトで上部タブから選択)に情報を表示します。Refresh ボタン()をクリックすると、再度プロセスが実行され、画面が更新されます。

Health Monitor の Dashboard GUI では、Enterprise Server およびそのサポートインフラの状態を即座に確認でき、さらに詳細情報へのリンクも提供されます。
Health Monitor の Dashboard GUI では、Enterprise Server およびそのサポートインフラの状態を即座に確認でき、さらに詳細情報へのリンクも提供されます。

エラーと警告

ダッシュボード内の各項目の状態は、メッセージと対応するアイコンで示されます:

  • OK  – 検出されたメトリクスが許容範囲または正常な状態にあります。
  • Warning  – Enterprise Server およびそのサポートインフラは正常に動作していますが、将来的な問題を回避するために変更が推奨されます。
  • Error  – Enterprise Server またはそのサポートインフラの一部が正常に動作しておらず、直ちに対応が必要です。

各項目の状態にマウスカーソルを合わせると、詳細情報が表示されます。ダッシュボードに表示されているエラーや警告については、ほとんどの場合、その項目の状態エントリをクリックすることでさらに詳細な情報が確認できます。

状態エントリにカーソルを合わせると、より詳細な情報にアクセスできます。
状態エントリにカーソルを合わせると、より詳細な情報にアクセスできます。

レスポンシブリンク

Health Monitor で検出された多くのエラー/警告状態には、状況解決のためのリンクが用意されています。これらは、状態エントリをクリックした際に表示される詳細情報内に含まれています。

よくあるイベント問題が発生した場合、関連情報にはさらに詳細や解決のためのリンクが提供されます。    
よくあるイベント問題が発生した場合、関連情報にはさらに詳細や解決のためのリンクが提供されます。

上記左側の例では、Health Monitor が Enterprise Server のバックアップが行われていないことを検出しています。関連情報には、状況解決に役立つドキュメントへのリンクが含まれています。

上記右側の例では、Enterprise Server のデフォルトの admin/admin サインイン認証情報がまだ存在しており、重大なセキュリティリスクとなっています。関連情報内の Fix It リンクから、ブラウザ経由で Enterprise Server のサインインページに直接アクセスでき、管理者ユーザープロファイルの修正が可能です。

また、ダッシュボードには、ルート Enterprise Server やストレージパス(ABOUT の下)、ログフォルダーの場所(FILE STORAGE の下)など、主要な場所への静的リンクも含まれています。

ログブラウザー

Health Monitor のログブラウザー画面は、Log Browser タブからアクセスでき、Enterprise Server のすべてのログファイル(通常は C:\ProgramData\Altium\Altium365Data\logs フォルダー内)からのエラーおよび警告エントリを表示します。イベントエントリを含むログファイルを表示するには、関連する Open file リンクを選択するか、エントリ自体をダブルクリックしてください。

リスト内の累積イベントエントリは日付ごとに区切られており、すべてのログファイルから利用可能なエラー/警告イベントが含まれます。特定のイベントを探す場合は、Show logs ドロップダウンメニューから期間を選択するか、動的フィルターフィールド()で Subsystem および Message 列内のキーワード検索を利用してください。

Log Browser インターフェースを使うことで、期間選択やキーワードフィルタリングにより、関心のあるイベントを絞り込むことができます。
Log Browser インターフェースを使うことで、期間選択やキーワードフィルタリングにより、関心のあるイベントを絞り込むことができます。

ボタンを選択すると、ログブラウザーリストから蓄積されたログエントリを削除できます。これにより、すべての既存ログファイルがアーカイブされて削除されます。

ステータスレポート

Health Monitor のステータスレポート画面は、Status Report タブからアクセスでき、Enterprise Server のステータスレポートファイルの作成と表示に使用されます。生成されたレポートは、すべてのイベントデバッグ情報を 1 つの Zip アーカイブ(*.zip)にまとめ、必要に応じて Altium 開発者に送信できます。

レポートを作成するには、Include Logs ドロップダウンメニューから適切なイベント期間を選択し、連絡先情報を入力して共有同意を選択し、 ボタンで処理を開始します。

Status Report 画面を使用して、デバッグ用にまとめられたログレポートファイルを生成できます。
Status Report 画面を使用して、デバッグ用にまとめられたログレポートファイルを生成できます。

ボタンを使うと、既存の保存済みレポートファイルを開いて表示できます。読み込まれたレポートは Log Browser 画面リストに反映され、Dashboard の表示は無効になります(読み込まれたログイベントは過去のスナップショットであり、現在のイベントではないため)。読み込みログの確認が終わったら、 ボタンを選択して Health Monitor をリフレッシュし、Enterprise Server の最新状態を表示してください。

AI-LocalizedAI-localized
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content