When it comes to Process Logs in OpenBots Server, logging a process begins with OpenBots Agent. When Agent is opened, the Logging section at the bottom of window can be seen and can only be interacted with when not connected. This is where users can set the standards for logging process information.
Process and Change Logs
The Process Logs and Change Logs are exactly what their names state, logs stored during the execution of a process and logs that keep track of any changes that occur within OpenBots Server.
The Process Logs are intertwined with OpenBots Agent and OpenBots Studio because, whenever a process is run in Studio, a log is generated/updated in the Logs folder. This file keeps track of the steps that the automation took and the information it used while it was running. When a published process is run, the information in the log is sent to Server via the Agent and can be viewed in the Process Logs tab. This tab will display the name of the process that was run, the machine that it was run from, the message from the logs, the level of the log, the logger itself (typically the Agent), the Jobs button which can be clicked to navigate to the specific job this log is attached to in the Jobs tab, and the View button that can be clicked for more information on the log itself. The Process Logs can also be exported using the Export button, which will download a zip file that contains a .CSV file with all of the necessary information and logs contained within it.
The Change Logs help to keep track of the different changes that occur in the OpenBots Server. Whenever anything is updated, an agent makes a call to the server, a user logs into Server, a team member is added, or any other change is made, a change is added to the Change History with information on the service that was changed, the method by which it was changed, who the change was made by, and when the change was made. The view button can also be used to view more information about the change itself.
The Change Logs are self-explanatory. They are updated whenever a change is made in Server. The Process Logs, however, are a little more complicated.
Whenever a process in OpenBots Studio is run, a log file is created in the Logs folder within the OpenBots Studio folder structure (which can be changed in the OpenBots Studio settings). This folder contains a text document with all of the log information listed according to its time of execution. This information is very similar to the information that is sent to the OpenBots Server whenever OpenBots Studio runs a published process. And then, when a job from the Server is run, a process change log is added to the All Process Logs tab.
Information – This log level creates logs that record normal application behavior. Information like when the Bot Engine started, when certain lines of code were run, when variables were created, and other pieces of basic information are logged. This default log level essentially provides a skeleton of the process that was run.
Verbose – The Verbose log level is great for troubleshooting as it is very similar to the Information log level. However, the Verbose log level creates logs that contain much more information like the values of different variables created in the automation, the arguments created in the automation, etc.
Debug – The Debug log level creates logs that contain debugging information that is more useful to developers, sysadmins, etc.
Warning – The Warning log level is used to create logs for processes that contain unusual and inconsistent behavior. This log level records any warning messages or any messages with higher priority such as errors or fatal crashes.
Error – The Error log level is used to create logs that contain information on any errors or messages of higher priority that the process encountered while running. These errors may not be fatal.
Fatal – The Fatal log level is used to create logs that contain information on any fatal errors or messages of higher priority that the process encountered while running.
The next field is the Sink Type. The Sink Type determines where the log files will be sent after they have been created. By default, the HTTP Sink Type will be selected. This option sends the log file to the URL specified in the URL field. This is usually the URL that is associated with the user’s instance of Server.
Another Sink Type that can be selected is the File Sink Type. This option is also self-explanatory, just set the destination file path for the log file.
The last Sink Type option is SignalR. Users with a designated SignalR endpoint only need to provide the URL, the Hub, the group names, and User IDs.
Finally, the fields that appear after the Sink Type pertain to the Sink Type itself and will change/update accordingly. Once the correct information has been entered into the OpenBots Agent, the Agent has been connected, and a job has been run using Server, then the process log files will be created accordingly, which marks the end of this tutorial.