Depurar el complemento con el registro en tiempo de ejecución

Use el registro en tiempo de ejecución para depurar el manifiesto del complemento y varios errores de instalación. Esta característica le ayuda a identificar y corregir problemas con el manifiesto que la validación del esquema XSD no detecta, como una falta de coincidencia entre los identificadores de recursos. El registro en tiempo de ejecución es especialmente útil para depurar complementos que implementan comandos de complemento y funciones personalizadas de Excel.

Nota:

El registro en tiempo de ejecución captura diagnósticos de nivel de host, como resultados de análisis de manifiestos, errores de carga de complementos y condiciones de inicialización. No captura la salida de JavaScriptconsole.log(). Para la depuración general de JavaScript, use las herramientas de desarrollo para la plataforma. Consulte Depuración de complementos mediante herramientas de desarrollo en Microsoft Edge.

Importante

El registro en tiempo de ejecución afecta al rendimiento. Actíelo solo cuando necesite depurar problemas con el manifiesto del complemento.

Usar el registro en tiempo de ejecución desde la línea de comandos

La manera más rápida de usar esta herramienta de registro es habilitar el registro en tiempo de ejecución desde la línea de comandos.

Importante

La herramienta office-addin-dev-settings no se admite en Mac. Para obtener instrucciones específicas de Mac, consulte la sección Registro en tiempo de ejecución en Mac.

  • Habilitar el registro en tiempo de ejecución:

    npx office-addin-dev-settings runtime-log --enable
    
  • Para habilitar el registro en tiempo de ejecución y escribir la salida en una ruta de acceso de archivo personalizada:

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

    Reemplace por <path\to\output.txt> la ruta de acceso donde desea que se escriba el registro, como C:\temp\addin_debug.txt. Este argumento solo establece la ubicación del archivo de salida. No filtra qué complementos se registran. El registro en tiempo de ejecución siempre se aplica a todos los complementos cargados en el entorno de ejecución de Office en esa máquina.

    Nota:

    Cuando se ejecuta --enable sin un nombre de archivo, Office escribe el registro en una ubicación predeterminada. Especificar un nombre de archivo cambia donde se escribe el registro, no lo que se registra.

  • Desabilitar el registro en tiempo de ejecución:

    npx office-addin-dev-settings runtime-log --disable
    
  • Mostrar si está habilitado el registro en tiempo de ejecución:

    npx office-addin-dev-settings runtime-log
    
  • Mostrar la ayuda desde la línea de comandos para el registro en tiempo de ejecución:

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

Registro de tiempo de ejecución en Mac

  1. Abra Terminal y establezca su preferencia de registro de tiempo de ejecución con el comando defaults:

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

    <bundle id> identifica el host para el que se va a habilitar el registro en tiempo de ejecución. <file_name> es el nombre del archivo de texto en el que se escribe el registro.

    Establezca <bundle id> en uno de los siguientes valores para habilitar el registro en tiempo de ejecución para la aplicación correspondiente.

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

En el ejemplo siguiente se habilita el registro en tiempo de ejecución para Word y, a continuación, se abre el archivo de registro.

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

Nota:

Debe reiniciar Office después de ejecutar el comando para habilitar el defaults registro en tiempo de ejecución.

Para desactivar el registro del tiempo de ejecución, use el comando defaults delete:

defaults delete <bundle id> CEFRuntimeLoggingFile

En el ejemplo siguiente se desactiva el registro en tiempo de ejecución para Word.

defaults delete com.microsoft.Word CEFRuntimeLoggingFile

Usar el registro del tiempo de ejecución para solucionar problemas con el manifiesto

Para usar el registro de tiempo de ejecución para solucionar problemas al cargar un complemento:

  1. Transferir localmente el complemento para hacer pruebas.

    Nota:

    Para minimizar el número de mensajes en el archivo de registro, descargue de forma local solo el complemento que está probando.

  2. Si no ocurre nada y no ve el complemento (y no aparece en el cuadro de diálogo Complementos), abra el archivo de registro.

    Nota:

    Se espera un archivo de registro vacío o casi vacío cuando el complemento se carga sin errores de nivel de host. El registro en tiempo de ejecución solo registra el manifiesto y carga de diagnósticos. No contiene entradas si el complemento se carga correctamente. Si busca la salida de JavaScript console.log() , use las herramientas de desarrollo para la plataforma en su lugar.

  3. Busque en el archivo de registro el identificador del complemento, que habrá definido en el manifiesto. En el archivo de registro, este identificador lleva la etiqueta SolutionId.

Problemas conocidos con el registro de tiempo de ejecución

Puede ocurrir que los mensajes del archivo de registro resulten confusos o estén clasificados de forma incorrecta. Por ejemplo:

  • El mensaje Medium Current host not in add-in's host list seguido de Unexpected Parsed manifest targeting different host está clasificado incorrectamente como un error.

  • Si ve el mensaje Unexpected Add-in is missing required manifest fields DisplayName y no contiene un SolutionId, lo más probable es que el error no esté relacionado con el complemento que está depurando.

  • Todos los mensajes Monitorable son errores esperados desde un punto de vista del sistema. A veces, indican un problema con el manifiesto, como un elemento mal escrito que se omitió, pero que no hizo que el manifiesto produjera errores.

Vea también