Incidents App Center (UWP/WinUI)

Les incidents App Center génèrent automatiquement un journal des incidents chaque fois que votre application plante. Le journal est d’abord écrit dans le stockage de l’appareil et lorsque l’utilisateur redémarre l’application, le rapport d’incident est envoyé à App Center. La collecte des incidents fonctionne à la fois pour les applications bêta et celles soumises au Windows Store. Les journaux d’incident contiennent des informations précieuses pour vous aider à résoudre les incidents.

Le Kit de développement logiciel (SDK) App Center collecte uniquement les incidents provoqués par des exceptions .NET non gérées. Il ne collecte pas les incidents natifs, par exemple lors de l’utilisation de C ou C++. Toutefois, si vous avez une application avec des incidents C++, vous pouvez les charger dans App Center via l’API de chargement des incidents.

Suivez la section Prise en main si vous n’avez pas encore configuré le Kit de développement logiciel (SDK) dans votre application.

Ajout du module incidents

Console du Gestionnaire de package

• Ouvrez la console dans Visual Studio. Pour ce faire, choisissez Outils Console> dugestionnaire de packageNuGet Package Manager>.
• Tapez les commandes suivantes :

Install-Package Microsoft.AppCenter.Crashes

Ajouter les instructions using

Ajoutez les espaces de noms appropriés avant d’utiliser nos API.

using Microsoft.AppCenter.Crashes;

Modifier la Start() méthode

Ajoutez ou modifiez l’appel suivant au constructeur de votre application pour inclure le module crash :

AppCenter.Start("{Your App Secret}", typeof(Crashes));

Générer un incident de test

App Center Crashs vous fournit une API pour générer un plantage de test afin de tester facilement le Kit de développement logiciel (SDK). Cette API recherche les configurations de débogage et de mise en production. Vous ne pouvez donc l’utiliser que lors du débogage, car il ne fonctionne pas pour les applications de mise en production.

Crashes.GenerateTestCrash();

Obtenir plus d’informations sur un incident précédent

App Center Crashes a deux API qui vous donnent plus d’informations en cas de blocage de votre application.

L’application s’est-elle planté lors de la session précédente ?

À tout moment après le démarrage du SDK, vous pouvez case activée si l’application s’est bloquée au lancement précédent :

bool didAppCrash = await Crashes.HasCrashedInLastSessionAsync();

Cela s’avère pratique si vous souhaitez ajuster le comportement ou l’interface utilisateur de votre application après un incident. Certains développeurs choisissent d’afficher une interface utilisateur supplémentaire pour s’excuser auprès de leurs utilisateurs, ou veulent un moyen d’entrer en contact après un incident.

Détails sur le dernier incident

Si votre application s’est bloquée précédemment, vous pouvez obtenir des détails sur le dernier incident.

ErrorReport crashReport = await Crashes.GetLastSessionCrashReportAsync();

Il existe de nombreux cas d’utilisation pour cette API, le plus courant étant les personnes qui appellent cette API et implémentent leur délégué ou écouteur de plantage personnalisé.

Personnaliser votre utilisation des incidents App Center

Les incidents App Center fournissent des rappels permettant aux développeurs d’effectuer des actions supplémentaires avant et lors de l’envoi des journaux d’incident à App Center.

L’incident doit-il être traité ?

Définissez ce rappel si vous souhaitez décider si un incident particulier doit être traité ou non. Par exemple, il peut y avoir un incident au niveau du système que vous souhaitez ignorer et que vous ne souhaitez pas envoyer à App Center.

Crashes.ShouldProcessErrorReport = (ErrorReport report) =>
{
    // Check the report in here and return true or false depending on the ErrorReport.
    return true;
};

Demander le consentement de l’utilisateur pour envoyer un journal d’incident

Si la confidentialité des utilisateurs est importante pour vous, vous souhaiterez peut-être obtenir une confirmation de l’utilisateur avant d’envoyer un rapport d’incident à App Center. Le Kit de développement logiciel (SDK) expose un rappel qui indique aux incidents App Center d’attendre la confirmation de l’utilisateur avant d’envoyer des rapports d’incident.

Si vous avez choisi de le faire, il vous incombe d’obtenir la confirmation de l’utilisateur, par exemple via une invite de dialogue avec l’une des options suivantes : Toujours envoyer, Envoyer et Ne pas envoyer. En fonction de l’entrée, vous indiquerez aux incidents App Center ce qu’il faut faire et le plantage sera ensuite géré en conséquence.

Le rappel suivant montre comment indiquer au SDK d’attendre la confirmation de l’utilisateur avant d’envoyer des incidents :

Crashes.ShouldAwaitUserConfirmation = () =>
{
    // Build your own UI to ask for user consent here. The SDK doesn't provide one by default.

    // Return true if you built a UI for user consent and are waiting for user input on that custom UI, otherwise false.
    return true;
};

Si vous revenez true dans le rappel ci-dessus, votre application doit obtenir (à l’aide de votre propre code) l’autorisation utilisateur et envoyer un message au SDK avec le résultat à l’aide de l’API suivante.

// Depending on the user's choice, call Crashes.NotifyUserConfirmation() with the right value.
Crashes.NotifyUserConfirmation(UserConfirmation.DontSend);
Crashes.NotifyUserConfirmation(UserConfirmation.Send);
Crashes.NotifyUserConfirmation(UserConfirmation.AlwaysSend);

Obtenir des informations sur les status d’envoi d’un journal d’incident

Parfois, vous souhaitez connaître la status de l’incident de votre application. Un cas d’usage courant est que vous souhaiterez peut-être afficher l’interface utilisateur qui indique aux utilisateurs que votre application envoie un rapport d’incident, ou, si votre application se bloque rapidement après le lancement, vous souhaitez ajuster le comportement de l’application pour vous assurer que les journaux d’incident peuvent être envoyés. Les incidents App Center fournissent trois rappels différents que vous pouvez utiliser dans votre application pour être averti de ce qui se passe :

Le rappel suivant sera appelé avant que le SDK envoie un journal d’incident

Crashes.SendingErrorReport += (sender, e) =>
{
    // Your code, e.g. to present a custom UI.
};

Si nous avons des problèmes réseau ou une panne sur le point de terminaison et que vous redémarrez l’application, SendingErrorReport est à nouveau déclenchée après le redémarrage du processus.

Le rappel suivant sera appelé une fois que le SDK a correctement envoyé un journal d’incident

Crashes.SentErrorReport += (sender, e) =>
{
    // Your code, e.g. to hide the custom UI.
};

Le rappel suivant sera appelé si le SDK n’a pas pu envoyer un journal d’incident

Crashes.FailedToSendErrorReport += (sender, e) =>
{
    // Your code goes here.
};

FailedToSendErrorReport La réception signifie qu’une erreur non récupérable telle qu’un code 4xx s’est produite. Par exemple, 401 signifie que le appSecret est incorrect.

Ce rappel n’est pas déclenché s’il s’agit d’un problème réseau. Dans ce cas, le Kit de développement logiciel (SDK) continue de réessayer (et interrompt également les nouvelles tentatives lorsque la connexion réseau est interrompue).

Ajouter des pièces jointes à un rapport d’incident

Vous pouvez ajouter des pièces jointes binaires et de texte à un rapport d’incident. Le Kit de développement logiciel (SDK) les envoie avec le plantage afin que vous puissiez les voir dans le portail App Center. Le rappel suivant sera appelé juste avant d’envoyer le blocage stocké à partir des lancements précédents de l’application. Il ne sera pas appelé lorsque l’incident se produit. Assurez-vous que le fichier de pièce jointe n’est pas nommé minidump.dmp , car ce nom est réservé aux fichiers minidump. Voici un exemple montrant comment joindre du texte et une image à un incident :

Crashes.GetErrorAttachments = (ErrorReport report) =>
{
    // Your code goes here.
    return new ErrorAttachmentLog[]
    {
        ErrorAttachmentLog.AttachmentWithText("Hello world!", "hello.txt"),
        ErrorAttachmentLog.AttachmentWithBinary(Encoding.UTF8.GetBytes("Fake image"), "fake_image.jpeg", "image/jpeg")
    };
};

Activer ou désactiver les incidents App Center au moment de l’exécution

Vous pouvez activer et désactiver les incidents App Center au moment de l’exécution. Si vous le désactivez, le SDK n’effectuera aucun rapport d’incident pour l’application.

Crashes.SetEnabledAsync(false);

Pour réactiver les incidents true App Center, utilisez la même API, mais passez en tant que paramètre.

Crashes.SetEnabledAsync(true);

Vous n’avez pas besoin d’attendre cet appel pour rendre les autres appels d’API (par IsEnabledAsyncexemple) cohérents.

L’état est conservé dans le stockage de l’appareil au cours des lancements d’application.

Vérifiez si les blocages d’App Center sont activés

Vous pouvez également case activée si les blocages d’App Center sont activés ou non :

bool isEnabled = await Crashes.IsEnabledAsync();

Erreurs gérées

App Center vous permet également de suivre les erreurs à l’aide d’exceptions gérées. Pour ce faire, utilisez la TrackError méthode :

try {
    // your code goes here.
} catch (Exception exception) {
    Crashes.TrackError(exception);
}

Une application peut éventuellement attacher des propriétés à un rapport d’erreurs géré pour fournir un contexte supplémentaire. Transmettez les propriétés en tant que dictionnaire de paires clé/valeur (chaînes uniquement) comme indiqué dans l’exemple ci-dessous.

try {
    // your code goes here.
} catch (Exception exception) {
    var properties = new Dictionary<string, string>
    {
        { "Category", "Music" },
        { "Wifi", "On"}
    };
    Crashes.TrackError(exception, properties); 
}

Vous pouvez également ajouter éventuellement des pièces jointes binaires et de texte à un rapport d’erreurs géré. Passez les pièces jointes en tant que tableau d’objets ErrorAttachmentLog , comme illustré dans l’exemple ci-dessous.

try {
    // your code goes here.
} catch (Exception exception) {
    var attachments = new ErrorAttachmentLog[]
    {
        ErrorAttachmentLog.AttachmentWithText("Hello world!", "hello.txt"),
        ErrorAttachmentLog.AttachmentWithBinary(Encoding.UTF8.GetBytes("Fake image"), "fake_image.jpeg", "image/jpeg")
    };
    Crashes.TrackError(exception, attachments: attachments);
}