使用 Application Insights 收集 Azure Active Directory B2C 日志

此功能仅适用于自定义策略。 对于设置步骤，请在前面的选择器中选择“自定义策略”。

本文提供从 Active Directory B2C （Azure AD B2C） 收集日志的步骤，以便诊断自定义策略的问题。 Application Insights 提供了一种方法来诊断异常和直观显示应用程序性能问题。 Azure AD B2C 有一项可将数据发送到 Application Insights 的功能。

只有在开发自定义策略时， 才应启用 此处所述的详细活动日志。

设置 Application Insights

如果还没有，请在您的订阅中创建一个 Application Insights 实例。

若要在订阅中使用 Application Insights 的现有实例，请执行以下步骤：

1. 登录到 Azure 门户。
2. 请确保使用包含您的 Azure 订阅的 Microsoft Entra 目录，而不是 Azure AD B2C 目录。 在门户工具栏中选择“目录 + 订阅”图标。
3. 在 门户设置 |“目录 + 订阅 ”页，在 “目录名称 ”列表中找到Microsoft Entra 目录，然后选择“ 切换”。
4. 打开之前创建的 Application Insights 资源。
5. 在 “概述 ”页上，记录 连接字符串

若要在订阅中创建 Application Insights 实例，请执行以下步骤：

1. 登录到 Azure 门户。
2. 请确保使用包含您的 Azure 订阅的 Microsoft Entra 目录，而不是 Azure AD B2C 目录。 在门户工具栏中选择“目录 + 订阅”图标。
3. 在 门户设置 |“目录 + 订阅 ”页，在 “目录名称 ”列表中找到Microsoft Entra 目录，然后选择“ 切换”。
4. 在左侧导航菜单中选择“ 创建资源 ”。
5. 搜索并选择 Application Insights，然后选择“ 创建”。
6. 填写表单，选择 “查看 + 创建”，然后选择“ 创建”。
7. 部署完成后，选择“转到资源”。
8. 在 Application Insights 菜单中 的“配置 ”下，选择“ 属性”。
9. 记录 连接字符串，以便在 后面的步骤中使用。

配置自定义策略

1. 打开信赖方（RP）文件，例如 SignUpOrSignin.xml。

2. 将以下属性添加到 <TrustFrameworkPolicy> 元素：

   DeploymentMode="Development"
   UserJourneyRecorderEndpoint="urn:journeyrecorder:applicationinsights"
   

3. 如果它尚不存在，请将 <UserJourneyBehaviors> 子节点添加到 <RelyingParty> 该节点。 它必须位于 <DefaultUserJourney ReferenceId="UserJourney Id" from your extensions policy, or equivalent (for example:SignUpOrSigninWithAAD" /> 之后。 有关 RelyingParty 子元素的完整顺序，请参阅 RelyingParty 架构参考。

4. 请将以下节点添加为 <UserJourneyBehaviors> 元素的子节点。 请确保将 {Your Application Insights Key} 替换为之前记录的 Application Insights 连接字符串。

   <JourneyInsights TelemetryEngine="ApplicationInsights" ConnectionString="{Your Application Insights ConnectionString}" DeveloperMode="true" ClientEnabled="false" ServerEnabled="true" TelemetryVersion="1.0.0" />
   

   • DeveloperMode="true" 指示 Application Insights 使遥测数据更快地通过处理管道。 适用于开发，但在大量使用时会受到限制。 在生产中，将 DeveloperMode 设置为 false.
   • ClientEnabled="true" 发送 ApplicationInsights 客户端脚本，用于跟踪页面视图和客户端错误。 可以在 Application Insights 门户的 browserTimings 表中查看此信息。 通过设置 ClientEnabled= "true"，将 Application Insights 添加到页面脚本，并获取页面加载和 AJAX 调用的计时、计数、浏览器异常和 AJAX 失败的详细信息，以及用户和会话计数。 此字段是 可选的，默认情况下设置为 false 。
   • ServerEnabled="true" 将现有的 UserJourneyRecorder JSON 作为自定义事件发送到 Application Insights。

   例如：

   <TrustFrameworkPolicy
     ...
     TenantId="fabrikamb2c.onmicrosoft.com"
     PolicyId="SignUpOrSignInWithAAD"
     DeploymentMode="Development"
     UserJourneyRecorderEndpoint="urn:journeyrecorder:applicationinsights"
   >
   ...
   <RelyingParty>
     <DefaultUserJourney ReferenceId="UserJourney ID from your extensions policy, or equivalent (for example: SignUpOrSigninWithAzureAD)" />
     <Endpoints>
        <!--points to refresh token journey when app makes refresh token request-->
        <Endpoint Id="Token" UserJourneyReferenceId="RedeemRefreshToken" />
     </Endpoints>
     <UserJourneyBehaviors>
       <JourneyInsights TelemetryEngine="ApplicationInsights" ConnectionString="{Your Application Insights ConnectionString}" DeveloperMode="true" ClientEnabled="false" ServerEnabled="true" TelemetryVersion="1.0.0" />
     </UserJourneyBehaviors>
     ...
   </TrustFrameworkPolicy>
   

5. 上传政策。

查看 Application Insights 中的日志

在 Application Insights 中看到新日志之前会有一小段延迟（通常不到 5 分钟）。

1. 打开在 Azure 门户中创建的 Application Insights 资源。
2. 在“概述”页面上，选择“日志” 。
3. 在 Application Insights 中打开一个新选项卡。

下面是可用于查看日志的查询列表：

条目可能很长。 请导出到 CSV，以便更深入地了解。

有关查询的详细信息，请参阅 Azure Monitor 中的日志查询概述。

请参阅 VS Code 扩展中的日志

建议安装适用于 VS Code 的 Azure AD B2C 扩展。 借助 Azure AD B2C 扩展，日志按策略名称、相关 ID（application insights 提供相关 ID 的第一位数字）和日志时间戳进行组织。 此功能可帮助你根据本地时间戳查找相关日志，并查看 Azure AD B2C 执行的用户旅程。

设置 Application Insights API 访问权限

设置 Application Insights 并配置自定义策略后，需要获取 Application Insights API ID 并创建 API 密钥。 Azure AD B2C 扩展同时使用 API ID 和 API 密钥来读取 Application Insights 事件（遥测）。 API 密钥应像密码一样进行管理。 将其保密。

若要获取 Application Insights ID 和密钥，请执行以下作：

1. 在 Azure 门户中，打开应用程序的 Application Insights 资源。

2. 选择“ 配置”，然后选择 “API 访问”。

3. 复制 应用程序 ID

4. 选择“创建 API 密钥”

5. 选中“读取遥测”框。

6. 在关闭“创建 API 密钥”边栏选项卡之前复制 密钥 ，并将其保存在安全的位置。 如果丢失密钥，则需要创建另一个密钥。

   

设置 Azure AD B2C VS Code 扩展

有了 Azure Application Insights API ID 和密钥后，可以将 VS Code 扩展配置为读取日志。 Azure AD B2C VS Code 扩展提供两个设置范围：

• 用户全局设置 - 全局应用于打开的任何 VS Code 实例的设置。
• 工作区设置 - 存储在工作区内的设置，仅在打开工作区时应用（使用 VS Code 打开文件夹）。

1. 在 Azure AD B2C 跟踪资源管理器 中，单击 设置 图标。

   

2. 提供 Azure Application Insights ID 和 密钥。

3. 单击 保存

保存设置后，Application Insights 日志会显示在 Azure AD B2C 跟踪（App Insights） 窗口中。

在生产环境中配置 Application Insights

若要提高生产环境性能和更好的用户体验，请务必将策略配置为忽略不重要的消息。 还需要确保不会记录个人身份信息（PII）。 在生产环境中使用以下配置，不会将日志发送到 Application Insights。

1. 将 DeploymentModeTrustFrameworkPolicy 的属性设置为 Production.

   <TrustFrameworkPolicy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/online/cpim/schemas/2013/06" PolicySchemaVersion="0.3.0.0"
   TenantId="yourtenant.onmicrosoft.com"
   PolicyId="B2C_1A_signup_signin"
   PublicPolicyUri="http://yourtenant.onmicrosoft.com/B2C_1A_signup_signin"
   DeploymentMode="Production"
   UserJourneyRecorderEndpoint="urn:journeyrecorder:applicationinsights">
   

2. 将 DeveloperMode 的 设置为 false。

   <UserJourneyBehaviors>
     <JourneyInsights TelemetryEngine="ApplicationInsights" ConnectionString="{Your Application Insights ConnectionString}" DeveloperMode="false" ClientEnabled="false" ServerEnabled="true" TelemetryVersion="1.0.0" />
   </UserJourneyBehaviors>
   

3. 上传并测试策略。

后续步骤

• 了解如何 对 Azure AD B2C 自定义策略进行故障排除