使用特权终结点 (PEP) 发送 Azure Stack Hub 诊断日志

若要在集成系统上运行 Get-AzureStackLog，需有权访问特权终结点 (PEP)。 下面是一个可运行的示例脚本，它使用 PEP 收集日志。 若要取消正在运行的日志收集以启动新的日志收集，请在启动新的日志收集前等待 5 分钟，然后输入 Remove-PSSession -Session $session。

$ipAddress = "<IP ADDRESS OF THE PEP VM>" # You can also use the machine name instead of IP here.

$password = ConvertTo-SecureString "<CLOUD ADMIN PASSWORD>" -AsPlainText -Force
$cred = New-Object -TypeName System.Management.Automation.PSCredential ("<DOMAIN NAME>\CloudAdmin", $password)

$shareCred = Get-Credential

$session = New-PSSession -ComputerName $ipAddress -ConfigurationName PrivilegedEndpoint -Credential $cred -SessionOption (New-PSSessionOption -Culture en-US -UICulture en-US)

$fromDate = (Get-Date).AddHours(-8)
$toDate = (Get-Date).AddHours(-2) # Provide the time that includes the period for your issue

Invoke-Command -Session $session { Get-AzureStackLog -OutputSharePath "<EXTERNAL SHARE ADDRESS>" -OutputShareCredential $using:shareCred -FilterByRole Storage -FromDate $using:fromDate -ToDate $using:toDate}

if ($session) {
    Remove-PSSession -Session $session
}

示例

• 收集所有角色的所有日志：

  Get-AzureStackLog -OutputSharePath "<path>" -OutputShareCredential $cred
  

• 从 VirtualMachines 和 BareMetal 角色收集日志：

  Get-AzureStackLog -OutputSharePath "<path>" -OutputShareCredential $cred -FilterByRole VirtualMachines,BareMetal
  

• 从 VirtualMachines 和 BareMetal 角色收集日志，通过日期筛选功能筛选出过去 8 小时的日志文件：

  Get-AzureStackLog -OutputSharePath "<path>" -OutputShareCredential $cred -FilterByRole VirtualMachines,BareMetal -FromDate (Get-Date).AddHours(-8)
  

• 从 VirtualMachines 和 BareMetal 角色收集日志，通过日期筛选功能筛选出 8 小时前到 2 小时前这个时间段的日志文件：

  Get-AzureStackLog -OutputSharePath "<path>" -OutputShareCredential $cred -FilterByRole VirtualMachines,BareMetal -FromDate (Get-Date).AddHours(-8) -ToDate (Get-Date).AddHours(-2)
  

• 在 Azure Stack 上，从运行了自行管理的 Kubernetes 群集（AKS 引擎）的租户部署中收集日志。 Kubernetes 日志应采用符合条件的格式存储在租户存储帐户中：使用该格式时应能够对日志应用“收集时间范围”。

  Get-AzureStackLog -OutputPath <Path> -InputSasUri "<Blob Service Sas URI>" -FromDate "<Beginning of the time range>" -ToDate "<End of the time range>"
  

  例如：

  Get-AzureStackLog -OutputPath C:\KubernetesLogs -InputSasUri "https://<storageAccountName>.blob.core.chinacloudapi.cn/<ContainerName><SAS token>" -FromDate (Get-Date).AddHours(-8) -ToDate (Get-Date).AddHours(-2) 
  

• 收集 value-add RPs 的日志。 常规语法为：

  Get-AzureStackLog -FilterByResourceProvider <<value-add RP name>>
  

  收集 SQL RP 的日志：

  Get-AzureStackLog -FilterByResourceProvider SQLAdapter
  

  收集 MySQL RP 的日志：

  Get-AzureStackLog -FilterByResourceProvider MySQLAdapter
  

  收集事件中心的日志：

  Get-AzureStackLog -FilterByResourceProvider eventhub
  

• 收集日志并将其存储在指定的 Azure 存储 blob 容器中。 此操作的常规语法如下所示：

  Get-AzureStackLog -OutputSasUri "<Blob service SAS Uri>"
  

  例如：

  Get-AzureStackLog -OutputSasUri "https://<storageAccountName>.blob.core.chinacloudapi.cn/<ContainerName><SAS token>"
  

  注意

  此过程用于上传日志。 即使没有可以访问的 SMB 共享，或者无法访问 Internet，也可在 Azure Stack Hub 上创建一个 Blob 存储帐户来传输日志，然后使用客户端检索这些日志。

  若要为存储帐户生成 SAS 令牌，需要以下权限：

  • 对 Blob 存储服务的访问权限。
  • 对容器资源类型的访问权限。

  若要生成要用于 -OutputSasUri 参数的 SAS URI 值，请执行以下步骤：

  1. 按照本文中的步骤创建存储帐户。
  2. 打开 Azure 存储资源管理器的实例。
  3. 连接到在步骤 1 中创建的存储帐户。
  4. 在存储服务中导航到 Blob 容器。
  5. 选择“新建容器”。
  6. 右键单击新容器，然后单击“获取共享访问签名”。
  7. 根据需求，选择有效的开始时间和结束时间。
  8. 根据所需的权限，选择“读取”、“写入”和“列表”。
  9. 选择“创建” 。
  10. 你将获得共享访问签名。 复制 URL 部分，并将其提供给 -OutputSasUri 参数。

参数注意事项

• 参数 OutputSharePath 和 OutputShareCredential 用于将日志存储在用户指定的位置。

• 可以使用 FromDate 和 ToDate 参数来收集特定时间段的日志。 如果未指定这些参数，则默认收集过去四小时的日志。

• 使用 FilterByNode 参数按计算机名筛选日志。 例如：

  Get-AzureStackLog -OutputSharePath "<path>" -OutputShareCredential $cred -FilterByNode azs-xrp01
  

• 使用 FilterByLogType 参数按类型筛选日志。 可以选择按文件、共享或 WindowsEvent 进行筛选。 例如：

  Get-AzureStackLog -OutputSharePath "<path>" -OutputShareCredential $cred -FilterByLogType File
  

• 可以使用 TimeOutInMinutes 参数设置日志收集的超时。 它默认设置为 150（2.5 小时）。

• 转储文件日志收集默认情况下处于禁用状态。 若要启用它，请使用 IncludeDumpFile 开关参数。

• 目前，可以使用 FilterByRole 参数按以下角色筛选日志收集：

有关诊断日志的其他注意事项

• 此命令需要一些时间来运行，具体取决于日志收集的角色。 影响因素还包括指定用于日志收集的时限，以及 Azure Stack Hub 环境中的节点数。

• 当日志收集运行时，请查看在 OutputSharePath 参数（在命令中指定）中创建的新文件夹。

• 每个角色的日志位于单个 zip 文件中。 根据所收集日志的大小，一个角色的日志可能会拆分成多个 zip 文件。 对于此类角色，如果需要将所有日志文件解压缩到单个文件夹中，请使用可以批量解压缩的工具。 选择角色的所有压缩文件，然后选择“解压缩到此处”。 该角色的所有日志文件会解压缩到单个合并的文件夹中。

• 在压缩的日志文件所在的文件夹中，还会创建名为 Get-AzureStackLog_Output.log 的文件。 此文件是一个命令输出日志，可以用来排查日志收集过程中的问题。 有时，日志文件包含 PS>TerminatingError 条目，除非运行日志收集后缺少预期的日志文件，否则可以放心忽略这些条目。

• 调查某个特定的故障时，可能需要多个组件中的日志。

  • 所有基础结构 VM 的系统和事件日志收集在 VirtualMachines 角色中。
  • 所有主机的系统和事件日志收集在 BareMetal 角色中。
  • 故障转移群集和 Hyper-V 事件日志收集在“存储”角色中。
  • ACS 日志收集在“存储”角色和 ACS 角色中。

Invoke-AzureStackOnDemandLog

可以使用 Invoke-AzureStackOnDemandLog cmdlet 为某些角色生成按需日志（请参阅本部分末尾的列表）。 默认情况下，执行 Get-AzureStackLog cmdlet 时收到的日志捆绑包中不存在此 cmdlet 生成的日志。 此外，建议你仅在 Azure 支持团队请求时才收集这些日志。

目前，可以使用 -FilterByRole 参数按以下角色筛选日志收集：

• OEM
• NC
• SLB
• 网关

收集按需诊断日志的示例

$ipAddress = "<IP ADDRESS OF THE PEP VM>" # You can also use the machine name instead of IP here.

$password = ConvertTo-SecureString "<CLOUD ADMIN PASSWORD>" -AsPlainText -Force
$cred = New-Object -TypeName System.Management.Automation.PSCredential ("<DOMAIN NAME>\CloudAdmin", $password)

$shareCred = Get-Credential

$session = New-PSSession -ComputerName $ipAddress -ConfigurationName PrivilegedEndpoint -Credential $cred -SessionOption (New-PSSessionOption -Culture en-US -UICulture en-US)

$fromDate = (Get-Date).AddHours(-8)
$toDate = (Get-Date).AddHours(-2) # Provide the time that includes the period for your issue

Invoke-Command -Session $session {
   Invoke-AzureStackOnDemandLog -Generate -FilterByRole "<on-demand role name>" # Provide the supported on-demand role name e.g. OEM, NC, SLB, Gateway
   Get-AzureStackLog -OutputSharePath "<external share address>" -OutputShareCredential $using:shareCred -FilterByRole Storage -FromDate $using:fromDate -ToDate $using:toDate
}

if ($session) {
   Remove-PSSession -Session $session
}

使用 PEP 收集诊断日志的工作原理

可以通过 Azure Stack Hub 诊断工具轻松高效地进行日志收集。 下图显示了诊断工具的工作原理：

跟踪收集器

跟踪收集器默认启用，可以在后台持续运行，以便从 Azure Stack Hub 组件服务收集所有 Windows 事件跟踪 (ETW) 日志。 ETW 日志存储在一个常用的本地共享中，其时间限制为五天。 一旦达到此限制，就会在创建新文件时删除最旧的文件。 每个文件默认允许的最大大小为 200 MB。 每 2 分钟进行一次大小检查，如果当前文件 >= 200 MB，则保存该文件并生成一个新文件。 按事件会话生成的文件的总大小也存在 8 GB 的限制。

Get-AzureStackLog

可以使用 PowerShell cmdlet Get-AzureStackLog 从 Azure Stack Hub 环境中的所有组件收集日志。 此工具将日志以 zip 文件形式保存在用户定义的位置。 如果 Azure Stack Hub 技术支持团队需要日志来排查问题，他们可能要求你运行 Get-AzureStackLog。

下面是一些收集的示例日志类型：

• Azure Stack Hub 部署日志
• Windows 事件日志
• Panther 日志
• 群集日志
• 存储诊断日志
• ETW 日志

这些文件由跟踪收集器收集并保存在共享中。 然后，可以根据需要使用 Get-AzureStackLog 来收集它们。