Отладка надстройки с помощью журнала среды выполнения

Используйте ведение журнала среды выполнения для отладки манифеста надстройки и нескольких ошибок установки. Эта функция помогает выявлять и устранять проблемы с манифестом, которые не перехватывает проверка схемы XSD, например несоответствие между идентификаторами ресурсов. Ведение журнала в среде выполнения особенно полезно для отладки надстроек, которые реализуют команды надстроек и пользовательские функции Excel.

Примечание.

Ведение журнала среды выполнения фиксирует диагностика на уровне узла, такие как результаты анализа манифеста, ошибки загрузки надстроек и условия инициализации. Он не записывает выходные данные JavaScript console.log() . Для общей отладки JavaScript используйте средства разработчика для своей платформы. См . раздел Отладка надстроек с помощью средств разработчика в Microsoft Edge.

Важно!

Ведение журнала среды выполнения влияет на производительность. Включите его, только если вам нужно отладить проблемы с манифестом надстройки.

Использование журнала в среде выполнения с помощью командной строки

Самый быстрый способ использовать это средство ведения журнала — включить ведение журнала во время выполнения из командной строки.

Важно!

Средство office-addin-dev-settings не поддерживается на Mac. Инструкции для Mac см. в разделе Ведение журнала среды выполнения на Mac.

  • Включение ведения журнала в среде выполнения:

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

  • Чтобы включить ведение журнала среды выполнения и запись выходных данных в пользовательский путь к файлу, выполните следующие действия:

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

    Замените <path\to\output.txt> на путь, по которому требуется записать журнал, например C:\temp\addin_debug.txt. Этот аргумент задает только расположение выходного файла. Он не фильтрует, какие надстройки регистрируются. Ведение журнала среды выполнения всегда применяется ко всем надстройкам, загруженным в среду выполнения Office на этом компьютере.

    Примечание.

    При запуске --enable без имени файла Office записывает журнал в расположение по умолчанию. При указании имени файла изменяется место записи журнала, а не то, что регистрируется в журнале.

  • Отключение ведения журнала в среде выполнения:

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

  • Определение, включено ли ведение журнала в среде выполнения:

    npx office-addin-dev-settings runtime-log

  • Отображение справки в командной строке для ведения журнала в среде выполнения:

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

Ведение журнала в среде выполнения на компьютере Mac

  1. Откройте приложение Терминал и настройте параметры ведения журнала в среде выполнения с помощью команды defaults:

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

    <bundle id> определяет узел, для которого необходимо включить ведение журнала в среде выполнения. <file_name> — это имя текстового файла, в который записывается журнал.

    Задайте <bundle id> одно из следующих значений, чтобы включить ведение журнала в среде выполнения для соответствующего приложения.

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

В следующем примере включается ведение журнала среды выполнения для Word, а затем открывается файл журнала.

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

Примечание.

После выполнения defaults команды необходимо перезапустить Office, чтобы включить ведение журнала в среде выполнения.

Чтобы отключить ведение журнала в среде выполнения, используйте команду defaults delete:

defaults delete <bundle id> CEFRuntimeLoggingFile

В следующем примере отключается ведение журнала среды выполнения для Word.

defaults delete com.microsoft.Word CEFRuntimeLoggingFile

Используйте журнал среды выполнения для устранения неполадок манифеста

Чтобы устранить проблемы с загрузкой надстройки, используя журнал среды выполнения:

  1. Загрузите неопубликованную надстройку для тестирования.

    Примечание.

    Чтобы свести к минимуму количество сообщений в файле журнала, загрузите неопубликованную надстройку, которую вы тестируете.

  2. Если ничего не происходит и надстройка не отображается в диалоговом окне надстроек, откройте файл журнала.

    Примечание.

    При загрузке надстройки без ошибок на уровне узла ожидается пустой или почти пустой файл журнала. Ведение журнала среды выполнения записывает только манифест и загрузку диагностика. Он не содержит записей, если надстройка загружается правильно. Если вам нужны выходные данные JavaScript console.log() , используйте средства разработчика для своей платформы.

  3. Выполните в этом файле поиск по идентификатору надстройки, определенному в манифесте. В файле журнала этот идентификатор отмечен как SolutionId.

Известные проблемы с ведением журнала в среде выполнения

В файле журнала могут встречаться непонятные или неправильно классифицированные сообщения. Например:

  • сообщение Medium Current host not in add-in's host list с дополнением Unexpected Parsed manifest targeting different host неправильно классифицируется как ошибка.

  • Если вы видите сообщение Unexpected Add-in is missing required manifest fields DisplayName и оно не содержит SolutionId, скорее всего, ошибка не связана с отлаживаемой надстройкой.

  • Все сообщения Monitorable являются ожидаемыми ошибками с точки зрения системы. Иногда они указывают на проблему с манифестом, например опечатку в элементе, которая была пропущена, но не привела к сбою.

См. также

  • Last updated on