Déboguez votre complément avec la journalisation runtime

Utilisez la journalisation du runtime pour déboguer le manifeste de votre complément et plusieurs erreurs d’installation. Cette fonctionnalité vous permet d’identifier et de résoudre les problèmes liés à votre manifeste que la validation de schéma XSD n’intercepte pas, comme une incompatibilité entre les ID de ressource. La journalisation du runtime est particulièrement utile pour le débogage des compléments qui implémentent des commandes de complément et des fonctions personnalisées Excel.

Remarque

La journalisation du runtime capture les diagnostics au niveau de l’hôte, telles que les résultats de l’analyse du manifeste, les erreurs de chargement du complément et les conditions d’initialisation. Il ne capture pas votre sortie JavaScript console.log() . Pour le débogage JavaScript général, utilisez les outils de développement de votre plateforme. Consultez Déboguer des compléments à l’aide d’outils de développement dans Microsoft Edge.

Importante

La journalisation du runtime affecte les performances. Activez-la uniquement lorsque vous avez besoin de déboguer des problèmes avec votre manifeste de complément.

Utiliser la journalisation de l’exécution à partir de la ligne de commande

Le moyen le plus rapide d’utiliser cet outil de journalisation consiste à activer la journalisation du runtime à partir de la ligne de commande.

Importante

L’outil office-addin-dev-settings n’est pas pris en charge sur Mac. Pour obtenir des instructions spécifiques à Mac, consultez la section Journalisation du runtime sur Mac.

  • Pour activer la journalisation de l’exécution :

    npx office-addin-dev-settings runtime-log --enable

  • Pour activer la journalisation du runtime et écrire la sortie dans un chemin d’accès de fichier personnalisé :

    npx office-addin-dev-settings runtime-log --enable <path\to\output.txt>

    Remplacez par <path\to\output.txt> le chemin d’accès où vous souhaitez écrire le journal, par C:\temp\addin_debug.txtexemple . Cet argument définit uniquement l’emplacement du fichier de sortie. Il ne filtre pas les compléments qui sont enregistrés. La journalisation du runtime s’applique toujours à tous les compléments chargés dans le runtime Office sur cet ordinateur.

    Remarque

    Lorsque vous exécutez --enable sans nom de fichier, Office écrit le journal dans un emplacement par défaut. La spécification d’un nom de fichier change l’emplacement où le journal est écrit, et non ce qui est journalisé.

  • Pour désactiver la journalisation de l’exécution :

    npx office-addin-dev-settings runtime-log --disable

  • Pour indiquer si la journalisation de l’exécution est activée :

    npx office-addin-dev-settings runtime-log

  • Pour afficher l’aide au sein de la ligne de commande pour la journalisation de l’exécution :

    npx office-addin-dev-settings runtime-log --help

Journalisation de l’exécution sur Mac

  1. Ouvrez Terminal et configurez une préférence de journalisation de l’exécution à l’aide de la commande defaults :

    defaults write <bundle id> CEFRuntimeLoggingFile -string <file_name>

    <bundle id> identifie l’hôte pour lequel activer la journalisation du runtime. <file_name> est le nom du fichier texte dans lequel le journal est écrit.

    Définissez <bundle id> sur l’une des valeurs suivantes pour activer la journalisation du runtime pour l’application correspondante.

    • com.microsoft.Word
    • com.microsoft.Excel
    • com.microsoft.Powerpoint
    • com.microsoft.Outlook

L’exemple suivant active la journalisation du runtime pour Word, puis ouvre le fichier journal.

defaults write com.microsoft.Word CEFRuntimeLoggingFile -string "runtime_logs.txt"
open ~/library/Containers/com.microsoft.Word/Data/runtime_logs.txt

Remarque

Vous devez redémarrer Office après avoir exécuté la commande pour activer la defaults journalisation du runtime.

Pour désactiver la journalisation de l’exécution, utilisez la commande defaults delete :

defaults delete <bundle id> CEFRuntimeLoggingFile

L’exemple suivant désactive la journalisation du runtime pour Word.

defaults delete com.microsoft.Word CEFRuntimeLoggingFile

Utilisez la journalisation runtime pour résoudre les problèmes avec votre manifeste

Pour utiliser la journalisation runtime pour résoudre les problèmes de chargement d’un complément, procédez comme suit :

  1. Chargez une version test de votre complément.

    Remarque

    Pour réduire le nombre de messages dans le fichier journal, chargez uniquement le complément que vous testez.

  2. Si rien ne se produit et que votre complément n’apparaît pas (et ne s’affiche pas dans la boîte de dialogue des compléments), ouvrez le fichier journal.

    Remarque

    Un fichier journal vide ou presque vide est attendu lorsque votre complément se charge sans erreurs au niveau de l’hôte. La journalisation du runtime enregistre uniquement le manifeste et le chargement diagnostics. Il ne contient pas d’entrées si votre complément se charge correctement. Si vous recherchez une sortie JavaScript console.log() , utilisez plutôt les outils de développement de votre plateforme.

  3. Recherchez le fichier journal pour l’ID de votre complément, que vous définissez dans votre manifeste. Dans le fichier journal, cet ID est intitulé SolutionId.

Problèmes connus avec la journalisation runtime

Vous pouvez afficher des messages dans le fichier journal qui sont source de confusion ou classés de façon incorrecte. Par exemple :

  • Le message Medium Current host not in add-in's host list suivi de Unexpected Parsed manifest targeting different host est classé incorrectement en tant qu’erreur.

  • Si vous voyez le message Unexpected Add-in is missing required manifest fields DisplayName et qu’il ne contient pas de SolutionId, l’erreur n’est probablement pas liée au complément que vous déboguez.

  • Tous les messages Monitorable sont des erreurs attendues du point de vue du système. Parfois, ils indiquent un problème avec votre manifeste, comme un élément mal orthographié qui a été ignoré, mais n’a pas provoqué l’échec du manifeste.

Voir aussi

  • Last updated on