Déboguez votre complément avec la journalisation runtime

  • Article

Vous pouvez utiliser la journalisation runtime pour déboguer le manifeste de votre complément ainsi que plusieurs erreurs d’installation. Cette fonctionnalité peut vous aider à identifier et à résoudre les problèmes avec votre manifeste qui ne sont pas détectés par la validation de schéma XSD, comme une incompatibilité entre les ID de ressources. La journalisation du runtime est particulièrement utile pour le débogage de compléments qui implémentent des commandes de complément et des fonctions personnalisées Excel.

Remarque

La fonctionnalité de journalisation du runtime est actuellement disponible pour Office 2016 ou version ultérieure sur le bureau.

Importante

La journalisation 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

L’activation de la journalisation de l’exécution à partir de la ligne de commande est le moyen le plus rapide d’utiliser cet outil de journalisation. Celles-ci utilisent npx, fourni par défaut dans le cadre de npm@5.2.0 +. Si vous disposez d’une version antérieure de npm, essayez les instructions Journalisation de l’exécution sur Windows ou Journalisation de l’exécution sur Mac, ou install npx.

Importante

L’outil office-addin-dev-settings n’est pas pris en charge sur Mac.

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

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

  • Pour activer la journalisation de l’exécution uniquement pour un fichier spécifique, utilisez la même commande avec un nom de fichier :

    npx office-addin-dev-settings runtime-log --enable [filename.txt]

  • 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 Windows

  1. Vérifiez que vous exécutez la version Bureau d’Office 2016 16.0.7019 ou une version ultérieure.

  2. Ajoutez la clé de registre RuntimeLogging sous HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\.

    Remarque

    Si la Developer clé (dossier) n’existe pas déjà sous HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\, effectuez les étapes suivantes pour la créer.

    1. Cliquez avec le bouton droit de votre souris sur la clé (dossier) WEF, puis sélectionnez Nouveau>Clé.
    2. Nommez la nouvelle clé Développeur.

  3. Définissez la valeur par défaut de la clé RuntimeLogging pour le chemin d’accès complet du fichier dans lequel écrire le journal. L’exemple suivant s’exécute dans un .reg fichier définit la journalisation sur le C:\ClientLogs\log.txt dossier .

    [HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\RuntimeLogging]
@="C:\\ClientLogs\\log.txt"`

    Remarque

    Le répertoire dans lequel le fichier journal sera écrit doit déjà exister et vous devez disposer des autorisations d’écriture correspondantes.

L’image suivante indique à quoi doit ressembler le registre. Pour désactiver la fonctionnalité, supprimez la clé de registre RuntimeLogging.

Éditeur du Registre avec une clé de Registre RuntimeLogging.

Journalisation de l’exécution sur Mac

  1. Vérifiez que vous exécutez office 2016 version de bureau 16.27.19071500 ou ultérieure.

  2. 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 de l’exécution. <file_name> est le nom du fichier texte dans lequel le journal sera é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 devrez redémarrer Office après l’exécution de la commande defaults pour activer la journalisation de l’exécution.

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

    Nous vous recommandons de charger uniquement une version test du complément que vous testez pour réduire le nombre de messages dans le fichier journal.

  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.

  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