ログ収集に PowerShell を使用するには、Azure Stack HCI クラスター内の任意のノードから Send-DiagnosticData
コマンドレットを実行します。 このコマンドレットは、ログを一時的にローカルにコピーします。 コピーされたログは解析され、Microsoft に送信され、システムから削除されます。
PowerShell を使用してログを収集する際に考慮すべき重要な点を次に示します。
Send-DiagnosticData
コマンドレットの完了時間は、ログを収集するロール、指定された期間、Azure Stack HCI 環境内のノードの数などの要因によって異なります。
- パラメーターを指定しない場合、
Send-DiagnosticData
コマンドレットは、前の 1 時間のすべてのノードからデータを収集します。
Send-DiagnosticData
の構文を次に示します。
Send-DiagnosticData [[-FilterByRole] <string[]>] [[-FromDate] <datetime>] [[-ToDate] <datetime>] [[-CollectSddc] <bool>] [<CommonParameters>]
Send-DiagnosticData
のリファレンス情報については、この記事で後述するSend-DiagnosticData
コマンド リファレンスセクションを参照してください。
例とサンプル出力
さまざまなパラメーターで Send-DiagnosticData
コマンドレットを使用する方法を示すサンプル出力を含むコマンドの例を次に示します。
日付フィルター処理を使用して診断データを送信する
この例では、過去 2 時間のログ ファイルの日付フィルター処理を使用して診断データを送信します。
Send-DiagnosticData -FromDate (Get-Date).AddHours(-2) -ToDate (Get-Date)
このコマンドの出力例を次に示します。
PS C:\CloudDeployment\logs> Send-DiagnosticData -FromDate (Get-Date).AddHours(-2) -ToDate (Get-Date)
Converting FromDate and ToDate to UTC
FromDate in UTC is now 12/04/2023 19:14:18. ToDate in UTC is now 12/04/2023 21:14:18
The correlation Id is <Correlation-ID>. This is used to query for this log collection in the diagnostic pipeline.
Provide the below information to the customer support engineer working on your case.
AEORegion: eastus
AEODeviceARMResourceUri: /Subscriptions/<Subscription-ID>/resourceGroups/EDGECI-REGISTRATION/providers/Microsoft.AzureStackHCI/clusters/<cluster-name>
AEOClusterNodeArcResourceUri: /subscriptions/<Subscription-ID>/resourceGroups/EDGECI-REGISTRATION/providers/Microsoft.HybridCompute/machines/<v-host-name>
CorrelationId: <Correlation-ID>
Observability Agent is running.
Successfully submitted on-demand. Log collection Job Id: <Job-ID>. This is used to track the log collection with Get-LogCollectionHistory.
Current log collection status: Running
Waiting for log collection to complete...
==== CUT ==================== CUT =======
Log collection ended with status: Succeeded
PS C:\CloudDeployment\logs>
指定されたロールの診断データを送信する
この例では、BareMetal と ECE のロール フィルター処理を使用して診断データを送信します。
Send-DiagnosticData -FilterByRole BareMetal, ECE –CollectSddc $false
このコマンドの出力例を次に示します。
PS C:\Users\docsuser> Send-DiagnosticData -FilterByRole BareMetal, ECE –CollectSddc $false
FromDate parameter not specified. Setting to default value 12/04/2023 20:41:21
ToDate parameter not specified. Setting to default value 12/04/2023 21:41:21
Converting FromDate and ToDate to UTC
FromDate in UTC is now 12/04/2023 20:41:21. ToDate in UTC is now 12/04/2023 21:41:21
The correlation Id is <Correlation-ID>. This is used to query for this log collection in the diagnostic pipeline.
Provide the below information to the customer support engineer working on your case.
AEORegion: eastus
AEODeviceARMResourceUri: /Subscriptions/<Subscription-ID>/resourceGroups/EDGECI-REGISTRATION/providers/Microsoft.AzureStackHCI/clusters/cluster-e5c7b2aa9a36490f9567b432a0eb51f1
AEOClusterNodeArcResourceUri: /subscriptions/<Subscription-ID>/resourceGroups/EDGECI-REGISTRATION/providers/Microsoft.HybridCompute/machines/v-Host1
CorrelationId: <Correlation-ID>
Observability Agent is running.
Successfully submitted on-demand. Log collection Job Id: <Job-ID>. This is used to track the log collection with Get-LogCollectionHistory.
Current log collection status: Running
Waiting for log collection to complete...
==== CUT ==================== CUT =======
Log collection ended with status: Succeeded
PS C:\Users\docsuser>
ログ収集の履歴を取得する
実行したすべてのログ コレクションの履歴を取得できます。 この履歴は、ログ コレクションの種類、ログ コレクションのサイズ、ログが収集された時刻、およびログ収集の方法について学習するのに役立ちます。
過去 90 日間のログ コレクションの履歴を取得するには、次のように入力します。
Get-LogCollectionHistory
Get-LogCollectionHistory
コマンドレットの出力例を次に示します。 datetime
パラメーターは UTC タイムゾーン内にあります。
PS C:\CloudDeployment\logs> Get-LogCollectionHistory
Name Value
---- -----
TimeCollected 9/29/2022 5:08:14 PM +00:00
Status Succeeded
CollectionFromDate 9/29/2022 4:07:57 PM +00:00
CollectionToDate 9/29/2022 5:07:57 PM +00:00
LogCollectionId fdcd94c8-1bd2-4ec6-8612-c92d5abd9a84
Type OnDemand
LogUploadSizeMb 1598
UploadNumberOfFiles 1924
Directory
Location
Error
---------- ---------------------------------------------------------
TimeCollected 9/27/2022 11:57:25 PM +00:00
Status Succeeded
CollectionFromDate 9/27/2022 9:57:16 PM +00:00
CollectionToDate 9/27/2022 11:57:16 PM +00:00
LogCollectionId f3d8dcc6-901e-4c72-a3cc-210055e6f198
Type OnDemand
LogUploadSizeMb 1069
UploadNumberOfFiles 1941
Directory
Location
Error
PS C:\CloudDeployment\logs>
ローカル ファイル共有にログを保存する
ネットワークに問題がある場合や、Azure に送信する代わりにデータをローカルに保存する場合は、ローカルのサーバー メッセージ ブロック (SMB) 共有に診断ログを格納できます。
ログをローカル共有に保存するには、次の手順に従います。
次のコマンドを実行して共有を作成します。
New-SMBShare -Name <share-name> -Path <path-to-share> -FullAccess Users -ChangeAccess 'Server Operators'
次のコマンドを実行して、共有に PSCredentials を作成します。
$user = "<username>"
$pass = "<password>"
$sec=ConvertTo-SecureString -String $pass -AsPlainText -Force
$shareCredential = New-Object System.Management.Automation.PSCredential ($user, $sec)
クラスターの各ノードで次のコマンドを実行してログを収集し、ローカルに保存します。
Send-DiagnosticData -SaveToPath <path to share> -ShareCredential $shareCredential
ログを保存した SMB 共有からの送信接続がある場合は、次のコマンドを実行してログを Microsoft に送信できます。
Send-DiagnosticData NoLogCollection -SupplementaryLogs <path-to-share> -ShareCredentail $shareCredential
Send-DiagnosticData
コマンド リファレンス
このセクションでは、パラメーター、構文、使用例など、 Send-DiagnosticData
に関するリファレンス情報を提供します。
FromDate と ToDate
これらのパラメーターを使用すると、特定の期間のログを収集できます。
構文
Send-DiagnosticData [[-FilterByRole] <string[]>] [[-FromDate] <datetime>] [[-ToDate] <datetime>] [[-CollectSddc] <bool>] [<CommonParameters>]
例
$fromDate = Get-Date -Date "11/30/2023 18:35:00"
$toDate = Get-Date -Date "11/30/2023 19:35:00"
Send-DiagnosticData –FromDate $fromDate –ToDate $toDate
拡張機能のバージョン
すべて
FilterByRole
このパラメーターを使用すると、収集するロールのログを選択できます。 複数のロールを指定できます。 ログをフィルター処理できる使用可能なロールの一覧については、「ログのフィルター処理に使用できるロールを参照してください。
構文
Send-DiagnosticData [[-FilterByRole] <string[]>]
例
Send-DiagnosticData –FilterByRole “ALM” -CollectSddc $false
拡張機能のバージョン
すべて
CollectSddc
このパラメーターは、ソフトウェア定義データ センター (SDDC) ログを含めるか除外するかを決定するのに役立ちます。 既定では、SDDC ログが含まれます。 除外する場合は、$falseに設定します。 SDDC 診断ツールの使用の詳細については、「クラスターの診断データの収集を参照してください。
構文
Send-DiagnosticData [-CollectSddc <bool>]
例
Send-DiagnosticData –CollectSddc $false
拡張機能のバージョン
すべて
BypassObsAgent
監視エージェントをバイパスすると、ログ収集が開始されたノードでのみログが収集されます。 コレクションのレコードは履歴に保持されません。
構文
Send-DiagnosticData [-BypassObsAgent]
例
Send-DiagnosticData –BypassObsAgent
拡張機能のバージョン
すべて
SaveToPath
このパラメーターを使用すると、診断ログを Microsoft に送信するのではなく、ホスト コンピューター上の指定されたパスに保存できます。
構文
Send-DiagnosticData -SaveToPath <string> [-FilterByRole <string[]>] [-FromDate <datetime>] [-ToDate <datetime>] [-CollectSddc <bool>] [-SupplementaryLogs <string>] [-ShareCredential <pscredential>] [-BypassObsAgent] [<CommonParameters>]
使用例
ホスト上の共有パスまたは出力パスを SaveToPath
パラメーターに指定できます。
Send-DiagnosticData –SaveToPath <output path>
Send-DiagnosticData –SaveToPath <share path>
マップされていない共有パスを使用している場合は、 -ShareCredential
パラメーターも使用する必要があります。
Send-DiagnosticData –SaveToPath <share path> -ShareCredential <credentials for share path>
SaveToPath
は、FilterByRole
、FromDate
、ToDate
、CollectSddc
、SupplementaryLogs
、ShareCredential
、BypassObsAgent
など、他のパラメーターと共に使用できます。
Send-DiagnosticData –SaveToPath <output path> -FIlterByRole <role>
拡張機能のバージョン
バージョン 1.0.2.0 以降
NoLogCollection
NoLogCollection
スイッチ パラメーターを使用すると、ログのアドホック セットを Microsoft に送信できます。 このパラメーターを使用する場合は、次の詳細を考慮してください。
SupplementaryLogs
、ShareCredential
、およびBypassObsAgent
パラメーターを NoLogCollection
パラメーターと組み合わせることができます。
NoLogCollection
を使用する場合、SupplementaryLogs
パラメーターは必須です。 Microsoft に送信する必要があるログへのパスを指定します。
- ホスト上の共有パスまたは出力パスを
SupplementaryLogs
パラメーターに柔軟に渡すことができます。 マップされていない共有パスを使用している場合は、 -ShareCredential
パラメーターも使用する必要があります。
構文
Send-DiagnosticData -SupplementaryLogs <string> -NoLogCollection [-ShareCredential <pscredential>] [-BypassObsAgent] [<CommonParameters>]
使用例
必須の SupplementaryLogs
パラメーターで–NoLogCollection
を使用します。
Send-DiagnosticData –NoLogCollection –SupplementaryPath <output path>
マップされていない共有パスで –NoLogCollection
を使用します。
Send-DiagnosticData –NoLogCollection –SupplementaryPath <share path>
-ShareCredential <credential to share path>
拡張機能のバージョン
バージョン 1.0.2.0 以降
補足ログ
補助ログ パラメーターを使用すると、アドホック ログを Microsoft に送信できます。
構文
次の方法で使用できます。
このシナリオでは、 SaveToPath
では、診断ログとアドホック ログの両方が収集され、指定されたパスに保存されます。
Send-DiagnosticData [-SupplementaryLogs <string>] -SaveToPath <path>
ここでは、 NoLogCollection
では、アドホック ログのみが収集され、Microsoft に送信されます。 診断ログは収集されません。
Send-DiagnosticData -SupplementaryLogs <string> -NoLogCollection
SaveToPath
またはNoLogCollection
なし。 つまり、診断ログとアドホック ログの両方が収集され、Microsoft に送信されます。
Send-DiagnosticData [-SupplementaryLogs <string>]
診断ログとアドホック ログの両方を収集する場合は、FilterByRole
、FromDate
、ToDate
、CollectSddc
などの他のパラメーターと共に SupplementaryLogs
パラメーターを使用できます。
使用例
SaveToPath
またはNoLogCollection
なし:
Send-DiagnosticData –SupplementaryLogs <path to adhoc logs to collect>
SaveToPath
を使用する場合:
Send-DiagnosticData –SaveToPath <path> -SupplementaryLogs <path to adhoc logs to collect>
NoLogCollection
を使用する場合:
Send-DiagnosticData –NoLogCollection –SupplementaryLogs <path to adhoc logs to collect>
拡張機能のバージョン
バージョン 1.0.2.0 以降
ShareCredential
このパラメーターは、ログを収集して共有パスに保存するか、共有パスから Microsoft に直接ログを送信する柔軟性を提供します。
構文
パスにログを保存します。
Send-DiagnosticData [-ShareCredential <pscredential>] -SaveToPath <path>
共有パスのログを Microsoft に送信します。
Send-DiagnosticData [-ShareCredential <pscredential>] -SupplementaryLogs <path> -NoLogCollection;
使用例
パスにログを保存します。
Send-DiagnosticData –SaveToPath <share path> -ShareCredential <credential to share path>
共有パスのログを Microsoft に送信します。
Send-DiagnosticData –NoLogCollection –SupplementaryLogs <share path> –ShareCredential <credential to the share path>
拡張機能のバージョン
すべて
(非推奨の予定)ToSMBShare
このパラメーターを使用すると、出力パスまたは共有パスにログを保存できます。 マップされていない共有パスを使用していた場合は、 ShareCredential
パラメーターも使用する必要がありました。 このパラメーターは拡張機能の将来のバージョンで削除されるため、代わりに -SaveToPath
パラメーターを使用します。
構文
Send-DiagnosticData –ToSMBShare –SharePath <path> [-ShareCredential <pscredential>]
使用例
出力パスまたは共有パスにログを保存します。
Send-DiagnosticData –ToSMBShare –SharePath <output path or share path>
マップされていない共有パスにログを保存します。
Send-DiagnosticData –ToSMBShare –SharePath <share path> -ShareCredential <credential for the share path>
拡張機能のバージョン
最初はすべてのバージョンでアクセスできますが、このパラメーターは最終的にバージョン 0.1.42 以前に制限されます。
(非推奨の予定)FromSMBShare
このパラメーターを使用すると、出力パスまたは共有パスから Microsoft に直接ログを送信できます。 マップされていない共有パスを使用していた場合は、 ShareCredential
パラメーターも使用する必要がありました。 このパラメーターは拡張機能の将来のバージョンで削除されるため、代わりに -NoLogCollection
パラメーターを使用します。
構文
Send-DiagnosticData –FromSMBShare –SharePath <path> [-ShareCredential <pscredential>]
使用例
Send-DiagnosticData –FromSMBShare –SharePath <output path or share path>
Send-DiagnosticData –FromSMBShare –SharePath <share path>
拡張機能のバージョン
最初はすべてのバージョンでアクセスできますが、このパラメーターは最終的にバージョン 0.1.42 以前に制限されます。
(非推奨の予定)SharePath
SharePath パラメーターは、次のいずれかの目的で使用できます。
- 診断ログを共有パスまたは出力パスに保存します。
- 共有パスまたは出力パスから Microsoft にログを送信します。 共有パスを使用していて、共有パスがマップされていない場合は、
ShareCredential
パラメーターも使用する必要があります。
このパラメーターは拡張機能の将来のバージョンで削除されるため、 –SaveToPath
を使用してログをパスに保存するか、代わりにアドホック ログを Microsoft に送信するときに –SupplementaryLogs
します。
構文
Send-DiagnosticData –ToSMBShare –SharePath <path> [-ShareCredential <pscredential>];
Send-DiagnosticData –FromSMBShare –SharePath <path> [-ShareCredential <pscredential>];
使用例
Send-DiagnosticData –ToSMBShare –SharePath <output path or share path>
Send-DiagnosticData –ToSMBShare –SharePath <share path> -ShareCredential <credential for the share path>
Send-DiagnosticData –FromSMBShare –SharePath <output path or share path>
Send-DiagnosticData –FromSMBShare –SharePath <share path>
拡張機能のバージョン
最初はすべてのバージョンでアクセスできますが、このパラメーターは最終的にバージョン 0.1.42 以前に制限されます。
ログのフィルター処理に使用できるロール
FilterByRole パラメーターによるフィルター処理には、次のロールを使用できます。 使用可能なロールは、将来のリリースで異なる場合があります。
ロール名 |
説明 |
ALM |
アプリケーション ライフサイクル管理 (ALM) には、ソフトウェア アプリケーションの開発、テスト、展開、およびメンテナンスの管理が含まれます。 |
ArcAgent |
Azure Arc 経由での Windows Server の管理を許可するエージェント。 Azure Connected Machine エージェントの概要を参照してください。 |
BareMetal |
仮想化レイヤーを使用せずにベア メタル サーバーでサービスを実行できるインフラストラクチャロール。 オペレーティング システムとハードウェアに対するフル アクセスと制御を行うことができます。 |
CommonInfra |
ネットワーク、ストレージ、セキュリティなどの一般的なインフラストラクチャ コンポーネントのログを収集します。 |
DeploymentLogs |
実行された手順、発生したエラー、操作の状態など、デプロイ プロセスの詳細を記録します。 |
ECE |
デプロイ、更新、追加ノード、ノード置換などのライフサイクル ワークフローを管理します。 |
拡張子 |
Azure マネージド拡張機能に関連するデータ。 |
FleetDiagnosticsAgent |
正常性トリガーをリッスンしてログ収集を開始します。 これらのログは、FleetDiagnosticsAgent とログ収集に関する問題を診断するために使用されます。 |
HCICloudService |
Azure Stack HCI のコア機能を提供する Azure クラウド サービス。 Azure の電源と、オンプレミス サーバーの柔軟性が組み合わさっています。 |
DownloadService |
更新プログラムのコンテンツをダウンロードするためのインフラストラクチャ サービスの一部。 |
正常性 |
イベント ログやパフォーマンス カウンターなど、さまざまなソースから正常性、パフォーマンス、使用状況データを収集します。 |
HostNetwork |
ネットワーク ATC のトラブルシューティングに使用されるログ。ホスト ネットワークの構成に使用される基になるオペレーティング システム コンポーネントです。 |
MOC_ARB |
Azure Stack HCI と Windows Server での仮想マシンのクラウドベースの管理を可能にする管理スタック。 |
NC |
ネットワーク インフラストラクチャに関連する情報。 |
ObservabilityLogmanTraces |
監視トレースのログを収集します。 これらのログは、診断データの送信に関する問題のトラブルシューティングに役立ちます。 |
ObservabilityVolume |
可観測性ボリュームのログを収集します。 |
OEMDiagnostics |
OEM 診断のログを収集します。これは、BIOS、ドライバー、センサーなど、サーバー ハードウェアの問題を特定して解決するのに役立ちます。 |
OSUpdateLogs |
Azure Stack HCI ノード上のオペレーティング システムの更新に関連するログを収集するロール。更新に関連する問題のトラブルシューティングに役立ちます。 |
RemoteSupportAgent |
カスタマー サポート ケースに対処するために使用されるリモート サポート セッションに関する問題のトラブルシューティングに役立つログ。 |
TestObservability |
Test-Observability コマンドレットからログを収集します。これは、TelemetryAndDiagnostics 拡張機能が正常に動作していることをテストするために使用されます。 |
URP |
UpdateService および OsUpdate ECE ロール イベントに関連するログで構成されます。 Update Service は、Azure Stack HCI システムの更新プログラムを管理します。 OsUpdate ECE ロールは、デプロイ中にクラスターの一部ではないマシン (物理ホストと InfraVM) にオペレーティング システムの更新プログラムを取得してインストールし、ノードの追加、ノードの修復、および Infra VM の更新シナリオに使用します。 これら 2 つのコンポーネントからのトレースは、 URP ロールの一部です。 |