Logs en Rocketbot
Aprende a leer los logs de tu robot en Rocketbot
Hola, por acĆ” Danilo š
Bienvenido a esta nueva ediciĆ³n de Robotipy. En este artĆculo explicaremos como leer los logs de rocketbot, para que puedas entender los errores y puedas crear tus propios logs.
Si quieres recibir estas publicaciones desde tu correo electrĆ³nico, te invito a suscribirte.
Una de las habilidades mĆ”s importantes y a la vez complicada al desarrollar, es saber como debuggear y resolver errores. Se dice que un programador pasa mas tiempo leyendo cĆ³digo que programando y en el mundo de RPA no es tan diferente
ĀæQue son los logs?
Los logs son un registro de todas las actividades que realiza tu robot y se genera cada vez que se ejecuta. En estos registros se guarda informaciĆ³n de los comandos, errores y mensajes dejados por el desarrollador
En informĆ”tica, se usa el tĆ©rmino registro, log o historial de log para referirse a la grabaciĆ³n secuencial en un archivo o en una base de datos de todos los acontecimientos (eventos o acciones) que afectan a un proceso particular (aplicaciĆ³n, actividad de una red informĆ”tica, etc.). De esta forma constituye una evidencia del comportamiento del sistema.
En Rocketbot, leer los logs es bastante sencillo y tenemos varias formas para hacerlo, podemos leerlos desde:
š Terminal de Rocketbot
š Archivo .log
šAddon Logs Viewer
Los tres mĆ©todos muestran la misma informaciĆ³n. La diferencia es la forma en la que accedes a cada uno y como te muestra la informaciĆ³n.
Logs de Rocketbot
Los logs de rocketbot se guardan en la carpeta rocketbot/logs y se separan en diferentes carpetas segĆŗn la fecha de creaciĆ³n del archivo. Dentro de estas carpetas, encontrarĆ”s cada archivo nombrado segĆŗn la hora de creaciĆ³n log_yyyymmdd_hhmmss.log
Si abres cualquier log, verĆ”s lĆneas como en la imagen de abajo donde cada lĆnea es un registro de la ejecuciĆ³n de cada comando.
š”Este post estĆ” basado en las versiones de Rocketbot 2023 o superior. Puede haber diferencias con versiones anteriores.
Cada registro o lĆnea dentro del archivo .log lo podemos dividir en 8 partes
š§ Timestamp o fecha y hora de ejecuciĆ³n
š¤ Origen del log ā Este puede ser Rocketbot si es un log de un comando o robot_message si es un log generado por el robot
šļøTipo de log ā Conocido tambiĆ©n como nivel de error. Permite diferenciar si es un mensaje de debug, un warning, error, etc. Puedes revisar en la documentaciĆ³n de python Loggin-level
š¤ Nombre del robot ejecutado ā Es el nombre del robot que contiene al comando que se estĆ” ejecutando
š Linea del comando en el robot ā Es la lĆnea donde se encuentra el comando que se ejecuta, tomando en cuenta el nivel de anidaciĆ³n
š·ļøGrupo y Nombre interno del comando ā AcĆ” se indica el nombre y secciĆ³n a nivel interno de rocketbot. El identificador que tiene rocketbot para sus servicios y comandos. Por ejemplo
rpaweb : sendkeyweb ā secciĆ³n web : comando enviar texto web
šŖŖ Identificador del comando en el robot ā Este es el identificador Ćŗnico del comando dentro del robot. Es un uuid que te permite encontrar un comando especĆfico
šļø ParĆ”metros, datos e informaciĆ³n del comando ā Esta parte del log es variable y depende de la informaciĆ³n del comando a ejecutar. La mayorĆa de los mĆ³dulos muestran su informaciĆ³n en formato diccionario de python y algunos comandos nativos lo muestran secuencial. Por ejemplo
El comando abrir navegador muestra primero el navegador que se abrirƔ y luego un diccionario con los parƔmetros ingresados:
chrome - {"url":"https://blog.robotipy.com/p/como-mejorar-como-rpa-developer","id_driver":"","profile":""}El comando limpiar variables muestra un diccionario con todos los parĆ”metros incluido el nombre del mĆ³dulo y el identificador del comando:
{"module_name":"System++","module":"cleanVars","vars":"Iterable_Csv"}
Logs en la Terminal de Rocketbot
La terminal de rocketbot nos muestra mĆ”s informaciĆ³n que solo los logs, por lo que es importante conocer como funciona
La terminal de Rocketbot es esa ventana negra que se abre cuando ejecutas la aplicaciĆ³n o ejecutas un robot.
La informaciĆ³n en esta terminal la podemos dividir en dos partes.
InformaciĆ³n de Studio ā Al iniciar, muestra informaciĆ³n de la configuraciĆ³n de Rocketbot como el puerto, la ruta de los logs o informaciĆ³n de tu licencia. Y mientras vas interactuando con Studio, va mostrando informaciĆ³n, como el robot guardado, los robots exportados, etc
InformaciĆ³n de la ejecuciĆ³n ā Cuando ejecutas un robot, la terminal muestra ademas del log de cada comando, otro tipo de informaciĆ³n, como el tiempo que demora en ejecutar el robot, warning generados por alguna librerĆa de python, mensajes de debug de algĆŗn comando, entre otras cosas
Addon Log Viewer
Otra forma de visualizar los logs, es utilizando la extensiĆ³n o addon llamado Logs Viewer. Esta extensiĆ³n se encuentra en la secciĆ³n de Addons, en la parte derecha de Rocketbot
Si das click en la extensiĆ³n, se abrirĆ” una nueva pestaƱa en el navegador con todos los logs separados por carpeta, de igual forma como se encuentra en la carpeta logs, ordenados desde el Ćŗltimo al mĆ”s antiguo.
Esta extensiĆ³n, te permite ver cada tipo de log con diferentes colores para que puedas visualizar de forma rĆ”pida los errores o los logs generados por tu robot. AdemĆ”s, cuenta con dos botones para exportarlo como archivo xlsx y otro para abrir la carpeta logs.
Esta forma tiene la desventaja que no se actualiza en tiempo real, por lo que necesitas recargar la pĆ”gina cuando finalice la ejecuciĆ³n de tu robot
šāāļøSi te interesa que haga un vĆdeo de como crear tus propios addons para Rocketbot Studio, dejame un comentario diciendo āMe interesa crear un addonā
Como crear un log personalizado
Desde la versiĆ³n 2023.03.20, ya no necesitas crear tus propios mĆ³dulos de logs o subrobots para crear mensajes de logs personalizados en tus robot.
Con el comando Mensaje Log, puedes agregar informaciĆ³n a los logs de Rocketbot y asĆ tener en un solo lugar tus registros o checkpoints con la informaciĆ³n de los comandos ejecutados.
El comando Mensaje Log se encuentra en la secciĆ³n Sistema y recibe solo dos parĆ”metros para funcionar
Mensaje ā El mensaje de que quieres escribir en los logs. Puede ser un texto o una variable
Nivel ā El tipo de log que quieres que se muestre. Los niveles disponibles pueden ser :
trace: Utilizado para informaciĆ³n detallada de depuraciĆ³n
info: Utilizado para proporcionar informaciĆ³n general sobre la ejecuciĆ³n del programa
warn: Se utiliza para resaltar posibles problemas o advertencias
error: Utilizado para registrar errores que se producen durante la ejecuciĆ³n del programa
fatal: Se utiliza para registrar errores crĆticos que conducen a la finalizaciĆ³n del programa
Al ejecutarse este comando, verƔs en los logs lo siguiente:
2023-08-22 00:22:08.100640 - rocketbot - INFO - request: test2 : line 2 - rpasystem : log_message Ā id: 05886cd5-7a45-47f7-76eb-e95eb4590f72 - warn - Los archivos no se encuentran en la carpeta principal
2023-08-22 00:22:08.101642 - robot_message - WARN - Los archivos no se encuentran en la carpeta principal
Como guardar el error en una varible
En algunos casos podrĆas necesitas el mensaje del error que ocurre, ya sea para enviarlo por algĆŗn medio o tomar una decisiĆ³n dentro de un catch.
En Rocketbot no tienes un comando para extraer el error literal, sino que puedes obtener el Ćŗltimo status reportado por un comando y este contendrĆ” el mensaje del error
{'status': 'False', 'message': 'SystemError: Ha ocurrido un error en el robot', 'img': '', 'vars': [], 'ifs': [], 'extra': [], 'time': '0.00956273078918457'}
Para poder obtener el status, puedes usar alguna de estas dos formas
Uso de variable interna
Con el comando asignar variable puedes utilizar la variable interna rocketbot_last_status.
Para poder utilizarla tienes que escribirla entre simbolos de porcentajes y en el campo de Asignar resultado a variable tienes que indicar el nombre de la variable donde guardar el mensaje con el error (o el Ćŗltimo status)
Comando obtener Ćŗltimo status
En este comando solo tienes que ingresar la variable donde quieres guardar el Ćŗltimo status reportado por el comando y ya puedes acceder al mensaje del error.
Y eso es todo por hoy! Si te gustarĆa que escriba sobre algo en particular, creĆ© un chat donde podemos conversar y puedes comentarme cuales son los temas que te interesan. EstarĆ© escribiendo sobre los temas comentados en las siguientes ediciones