Sammeln von Azure Active Directory B2C-Protokollen mit Application Insights

Dieses Feature ist nur für benutzerdefinierte Richtlinien verfügbar. Wählen Sie für die Einrichtungsschritte in der vorherigen Auswahl die Option Benutzerdefinierte Richtlinie aus.

In diesem Artikel werden die Schritte zum Sammeln von Protokollen von Active Directory B2C (Azure AD B2C) beschrieben, mit denen Sie Probleme bei Ihren benutzerdefinierten Richtlinien diagnostizieren können. Application Insights bietet eine Möglichkeit zum Diagnostizieren von Ausnahmen und Visualisieren von Leistungsproblemen der Anwendung. Azure AD B2C enthält eine Funktion zum Senden von Daten an Application Insights.

Die hier detailliert beschriebenen Aktivitätsprotokolle sollten NUR bei der Entwicklung Ihrer benutzerdefinierten Richtlinien aktiviert werden.

Einrichten von Application Insights

Erstellen Sie eine Instanz von Application Insights in Ihrem Abonnement, falls Sie noch keine haben.

Um eine bestehende Instanz von Application Insights in Ihrem Abonnement zu verwenden, führen Sie die folgenden Schritte aus:

1. Melden Sie sich beim Azure-Portal an.
2. Sie müssen das Microsoft Entra-Verzeichnis verwenden, in welchem sich Ihr Azure-Abonnement befindet, und nicht Ihr Azure AD B2C-Verzeichnis. Wählen Sie auf der Symbolleiste des Portals das Symbol Verzeichnisse und Abonnements aus.
3. Suchen Sie auf der Seite Portaleinstellungen | Verzeichnisse + Abonnements Ihr Microsoft Entra-Verzeichnis in der Liste Verzeichnisname, und wählen Sie dann Wechseln aus.
4. Öffnen Sie die zuvor erstellte Application Insights-Ressource.
5. auf der Seite Übersicht und zeichnen Sie den Instrumentierungsschlüssel auf

Führen Sie die folgenden Schritte aus, um eine Instanz von Application Insights in Ihrem Abonnement zu verwenden:

1. Melden Sie sich beim Azure-Portal an.
2. Sie müssen das Microsoft Entra-Verzeichnis verwenden, in welchem sich Ihr Azure-Abonnement befindet, und nicht Ihr Azure AD B2C-Verzeichnis. Wählen Sie auf der Symbolleiste des Portals das Symbol Verzeichnisse und Abonnements aus.
3. Suchen Sie auf der Seite Portaleinstellungen | Verzeichnisse + Abonnements Ihr Microsoft Entra-Verzeichnis in der Liste Verzeichnisname, und wählen Sie dann Wechseln aus.
4. Wählen Sie Ressource erstellen im linken Navigationsbereich aus.
5. Suchen Sie nach Application Insights, wählen Sie die Option aus, und wählen Sie dann Erstellen aus.
6. Füllen Sie das Formular aus, wählen Sie Überprüfen und erstellen und dann Erstellen aus.
7. Wählen Sie nach Abschluss der Bereitstellung die Option Zu Ressource wechseln aus.
8. Wählen Sie im Application Insights-Menü unter Konfigurieren die Option Eigenschaften aus.
9. Notieren Sie den Instrumentierungsschlüssel zur Verwendung in einem späteren Schritt.

Konfigurieren der benutzerdefinierten Richtlinie

1. Öffnen Sie die RP-Datei (Relying Party, vertrauende Seite), z.B. SignUpOrSignin.xml.

2. Fügen Sie dem <TrustFrameworkPolicy>-Element die folgenden Attribute hinzu:

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

3. Fügen Sie dem Knoten <RelyingParty> einen untergeordneten Knoten <UserJourneyBehaviors> hinzu, falls dieser noch nicht vorhanden ist. Er muss sich hinter <DefaultUserJourney ReferenceId="UserJourney Id" from your extensions policy, or equivalent (for example:SignUpOrSigninWithAAD" /> befinden. Lesen Sie die RelyingParty-Schemareferenz für eine vollständige Reihenfolge der untergeordneten RelyingParty-Elemente.

4. Fügen Sie den folgenden Knoten als untergeordnetes Element des <UserJourneyBehaviors>-Elements hinzu. Achten Sie darauf, {Your Application Insights Key} durch den Application Insights-Instrumentierungsschlüssel zu ersetzen, den Sie zuvor notiert haben.

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

   • DeveloperMode="true" weist Application Insights an, die Telemetriedaten über die Verarbeitungspipeline zu beschleunigen. Dies ist gut für die Entwicklung, bei hohem Datenvolumen jedoch mit Einschränkungen versehen. Legen Sie DeveloperMode in der Produktion auf false fest.
   • ClientEnabled="true" sendet das clientseitige Application Insights-Skript zum Nachverfolgen der Seitenansicht und von clientseitigen Fehlern. Dies können Sie in der browserTimings-Tabelle im Application Insights-Portal anzeigen. Durch die Einstellung von ClientEnabled= "true" fügen Sie Application Insights Ihrem Seitenskript hinzu und erhalten Zeitangaben zu Seitenladevorgängen und AJAX-Aufrufen, Anzahl und Details von Browserausnahmen und AJAX-Fehlern sowie die Anzahl von Benutzern und Sitzungen. Dieses Feld ist optional und ist standardmäßig auf false eingestellt.
   • ServerEnabled="true" sendet die vorhandene Datei „UserJourneyRecorder.json“ als benutzerdefiniertes Ereignis an Application Insights.

   Beispiel:

   <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" InstrumentationKey="{Your Application Insights Key}" DeveloperMode="true" ClientEnabled="false" ServerEnabled="true" TelemetryVersion="1.0.0" />
     </UserJourneyBehaviors>
     ...
   </TrustFrameworkPolicy>
   

5. Laden Sie die Richtlinie hoch.

Anzeigen von Protokollen in Application Insights

Es gibt eine kurze Verzögerung, in der Regel weniger als fünf Minuten, bevor Sie neue Protokolle in Application Insights anzeigen können.

1. Öffnen Sie die zuvor erstellte Application Insights-Ressource im Azure-Portal.
2. Wählen Sie auf der Seite Übersicht die Option Protokolle aus.
3. Öffnen Sie eine neue Registerkarte in Application Insights.

Es folgt eine Liste der Abfragen, die Sie zum Anzeigen der Protokolle verwenden können:

Diese Einträge können ggf. lang sein. Führen Sie einen Export in eine CSV-Datei durch, um sich dies genauer anzusehen.

Weitere Informationen zu Abfragen finden Sie unter Übersicht über Protokollabfragen in Azure Monitor.

Anzeigen der Protokolle in der VS Code-Erweiterung

Es wird empfohlen, die Azure AD B2C-Erweiterung für VS Code zu installieren. Mit der Azure AD B2C-Erweiterung werden die Protokolle nach Richtlinienname, Korrelations-ID (Application Insights zeigt die erste Ziffer der Korrelations-ID) und Protokollzeitstempel organisiert. Dieses Feature hilft Ihnen, anhand des lokalen Zeitstempels das entsprechende Protokoll zu finden und die von Azure AD B2C ausgeführte User Journey anzuzeigen.

Festlegen des Application Insights-API-Zugriffs

Nachdem Sie Application Insights einrichten und die benutzerdefinierte Richtlinie konfiguriert haben, müssen Sie Ihre Application Insights-API-ID abrufen und einen API-Schlüssel erstellen. Sowohl die API-ID als auch der API-Schlüssel werden von der Azure AD B2C-Erweiterung verwendet, um die Application Insights-Ereignisse (Telemetriedaten) zu lesen. Ihre API-Schlüssel sollten wie Kennwörter verwaltet werden. Halten Sie es geheim.

So rufen Sie die Application Insights-ID sowie den -Schlüssel ab:

1. Öffnen Sie im Azure-Portal die Application Insights-Ressource für Ihre Anwendung.

2. Wählen Sie Konfigurieren aus, und wählen Sie dann API-Zugriff aus.

3. Kopieren Sie die Anwendungs-ID.

4. Wählen Sie API-Schlüssel erstellen aus.

5. Aktivieren Sie das Kontrollkästchen Telemetrie lesen.

6. Kopieren Sie den Schlüssel, bevor Sie das Blatt „API-Schlüssel erstellen“ schließen, und verwahren Sie ihn sicher. Wenn Sie den Schlüssel verlieren, müssen Sie einen weiteren erstellen.

   

Einrichten der VS Code-Erweiterung von Azure AD B2C

Da Sie jetzt über die ID und den Schlüssel der Azure Application Insights-API verfügen, können Sie die VS Code-Erweiterung zum Lesen der Protokolle konfigurieren. Die VS Code-Erweiterung für Azure AD B2C enthält zwei Einstellungsbereiche:

• User Global Settings (Globale Benutzereinstellungen): Einstellungen, die global für jede VS Code-Instanz gelten, die Sie öffnen.
• Workspace Settings (Arbeitsbereichseinstellungen): Einstellungen, die in Ihrem Arbeitsbereich gespeichert sind und nur gelten, wenn der Arbeitsbereich geöffnet wird (über VS Code > Ordner öffnen).

1. Klicken Sie im Explorer der Azure AD B2C-Ablaufverfolgung auf das Einstellungssymbol.

   

2. Stellen Sie die Azure Application Insights-ID und den -Schlüssel bereit.

3. Klicken Sie unten auf der Seite auf Speichern.

Nachdem Sie die Einstellungen gespeichert haben, werden die Application Insights-Protokolle im Fenster Azure AD B2C-Ablaufverfolgung (App Insights) angezeigt.

Konfigurieren von Application Insights in der Produktionsumgebung

Um die Leistung der Produktionsumgebung und die Benutzerfreundlichkeit zu verbessern, müssen Sie Ihre Richtlinie so konfigurieren, dass unwichtige Nachrichten ignoriert werden. Verwenden Sie die folgende Konfiguration in Produktionsumgebungen, und es werden keine Protokolle an Application Insights gesendet.

1. Legen Sie das DeploymentMode-Attribut von TrustFrameworkPolicy auf Production fest.

   <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. Legen Sie DeveloperMode von JourneyInsights auf false fest.

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

3. Laden Sie die Richtlinie hoch, und testen Sie sie.

Nächste Schritte

• Beheben von Problemen mit benutzerdefinierten Richtlinien in Azure AD B2C