Depurar seu suplemento com o log de tempo de execução

Utilize o registo de runtime para depurar o manifesto do suplemento e vários erros de instalação. Esta funcionalidade ajuda-o a identificar e corrigir problemas com o manifesto que a validação do esquema XSD não deteta, como um erro de correspondência entre IDs de recursos. O registo de runtime é especialmente útil para depurar suplementos que implementam comandos de suplementos e funções personalizadas do Excel.

Observação

O registo de runtime captura diagnóstico ao nível do anfitrião, como resultados de análise de manifestos, erros de carregamento de suplementos e condições de inicialização. Não captura a saída de JavaScriptconsole.log(). Para depuração geral de JavaScript, utilize as ferramentas de programador para a sua plataforma. Veja Depurar suplementos com ferramentas de programador no Microsoft Edge.

Importante

O registo de runtime afeta o desempenho. Ative-o apenas quando precisar de depurar problemas com o manifesto do suplemento.

Use o log de tempo de execução na linha de comandos

A forma mais rápida de utilizar esta ferramenta de registo é ativar o registo de runtime a partir da linha de comandos.

Importante

A ferramenta office-addin-dev-settings não é suportada no Mac. Para obter instruções específicas para Mac, consulte a secção Registo de runtime no Mac.

  • Para habilitar o log de tempo de execução:

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

  • Para ativar o registo de runtime e escrever a saída num caminho de ficheiro personalizado:

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

    Substitua <path\to\output.txt> pelo caminho onde pretende que o registo seja escrito, como C:\temp\addin_debug.txt. Este argumento define apenas a localização do ficheiro de saída. Não filtra os suplementos que são registados. O registo de runtime aplica-se sempre a todos os suplementos carregados no runtime do Office nesse computador.

    Observação

    Quando é executado --enable sem um nome de ficheiro, o Office escreve o registo numa localização predefinida. Especificar um nome de ficheiro altera onde o registo é escrito e não o que é registado.

  • Para desabilitar o log de tempo de execução:

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

  • Para exibir se o log de tempo de execução está ativado:

    npx office-addin-dev-settings runtime-log

  • Para exibir ajuda na linha de comandos para o log de tempo de execução:

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

Log de tempo de execução no Mac

  1. Abra o Terminal e defina uma preferência de log de tempo de execução usando o comando defaults:

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

    <bundle id> identifica o anfitrião para o qual ativar o registo de runtime. <file_name> é o nome do ficheiro de texto no qual o registo é escrito.

    Defina <bundle id> para um dos seguintes valores para ativar o registo de runtime para a aplicação correspondente.

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

O exemplo seguinte ativa o registo de runtime para Word e, em seguida, abre o ficheiro de registo.

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

Observação

Tem de reiniciar o Office depois de executar o comando para ativar o defaults registo de runtime.

Para desativar o log de tempo de execução, use o comando defaults delete:

defaults delete <bundle id> CEFRuntimeLoggingFile

O exemplo seguinte desativa o registo de runtime para Word.

defaults delete com.microsoft.Word CEFRuntimeLoggingFile

Use o log do tempo de execução para solucionar problemas em seu manifesto

Para usar o log do tempo de execução para solucionar problemas ao carregar um suplemento:

  1. Realize o sideload do seu suplemento para teste.

    Observação

    Para minimizar o número de mensagens no ficheiro de registo, carregue em sideload apenas o suplemento que está a testar.

  2. Se nada acontecer e você não vir seu suplemento (e ele não estiver aparecendo na caixa de diálogo de suplementos), abra o arquivo de log.

    Observação

    É esperado um ficheiro de registo vazio ou quase vazio quando o suplemento é carregado sem erros ao nível do anfitrião. O registo de runtime apenas regista o manifesto e o carregamento diagnóstico. Não contém entradas se o suplemento for carregado corretamente. Se estiver à procura da saída de JavaScript console.log() , utilize antes as ferramentas de programador para a sua plataforma.

  3. Procure pela ID de seu suplemento no arquivo de log, definida no seu manifesto. No arquivo de log, essa ID está marcada como SolutionId.

Problemas conhecidos com o log de tempo de execução

Talvez você veja mensagens no arquivo de log que são confusas ou que estão classificadas incorretamente. Por exemplo:

  • A mensagem Medium Current host not in add-in's host list seguida por Unexpected Parsed manifest targeting different host é incorretamente classificada como um erro.

  • Se vir a mensagem Unexpected Add-in is missing required manifest fields DisplayName e não contiver um SolutionId, é provável que o erro não esteja relacionado com o suplemento que está a depurar.

  • Qualquer mensagem Monitorable indica erros esperados do ponto de vista do sistema. Às vezes, indica um problema com o seu manifesto, como um elemento que foi soletrado incorretamente e que foi ignorado, mas que não fez com que o manifesto falhasse.

Confira também

  • Last updated on