Logs
In the Logs menu, we can see Agent Logs and Audit Logs
Agent Logs
Agent Logs is a menu option to download agent log files.
One or more agents can download Agent logs along with dates or by Workflow request id.
Introduction
Agent log contains Agent or workflow execution logs and Process Studio step Debug Log's Debug Log messages. There is a workflow step in Process Studio called Debug Logs. When workflow request executes, it logs the Debug Log variables and fields and Debug Log messages. These debug messages are also present in agent logs.
Using the Agent Logs menu option, users can download Agent log files, including debug logs from the AE portal.
Working
AutomationEdge users can download agent logs by submitting one or more agent names with from and to dates. Users can also download logs for the particular workflow instance. Users can see all Agent log requests submitted on the AE portal with their date criteria's and link to download the Agent log file.
Download Agent logs only for requests executed within the last 15 days; you cannot fetch logs for any request executed before that. AE server keeps these requests for 24 hours after the link to download is active. Users need to download debug logs during that time.
Agent Logs: View
-
Go to the Logs menu and Agent Logs sub-menu.
-
You can view Agent Log files and download them.
Figure 13.1: Agent Logs
Table 13.1: Agent Logs Table
| Component | Description |
|---|---|
| Id | A serial number is seen here. |
| Agent Name | The name of the Agent with which the Agent log file is associated. |
| Workflow Instance Id | The id of the workflow request submitted |
| Status/Actions | The status of operation can be: New, In Progress, Complete, Failed. |
| If the Request completes, then a download link is available to download the logs. | |
| Duration: | The period for the agent log file retrieval |
| From Date | The start timestamp of the period |
| To Date | The end timestamp of the period |
| Issue Date | The timestamp of the request |
| Last Updated | The timestamp when the request was last updated |
Agent Logs: Search
Provide a search string in the search box to filter Agent Logs by the search string.
- At the top right side of the page, there is a Search box.
Figure 13.2: Agent Logs Search
- Type a string in the Search box. Notice that the records are filtered.
Figure 13.3: Filter Agent Logs
Agent Logs: Download
Agent Logs can be downloaded by, Agent or Request Id
Following are the steps to download Agent Logs,
Agent Logs: Download by Agent
- Navigate to the Logs 🡪 Agent Logs menu.
Figure 13.4: Download Agent Logs
- Click New Request on the top right corner. A pop-up box appears. You may submit a new request for Agent or Workflow Requests.
Figure 13.5: Select Agent Log Entity
- The Agent radio button is selected; now select Agent Type.
Figure 13.6: Select Agent Type
- Depending upon the Agent type, a list of Agents appears. Enable checkbox next to Agent or Agents for which you want to download the Agent logs.
Figure 13.7: Select Agent
- Select the period for which you want the logs.
Figure 13.8: Select From-To Dates
- Click Submit.
Figure 13.9: Select From-To Dates
-
To download Agent level logs, Agent must be up and running; else, it throws an error message.
-
The maximum duration to download log files is five days. If the difference in days is more than five days, an error message showing the difference between dates cannot exceed five days is displayed.
-
Provide appropriate duration with the difference in duration, not more than five days. Click Submit. A 'Request submitted successfully message' displays
Figure 13.10: Agent Logs request
- A new entry in the Agent Logs with Status NEW appears.
Figure 13.11: Agent Log with status NEW
-
After some time, the status changes to Download.
-
You may click Download to download a zip of the Agent log files.
Figure 13.12: Agent Logs Download with Download Link
- Similarly, you can see more sets of Agent Logs for different time durations were requested and ready for download, as seen below.
Figure 13.13: Another Agent Log request with Id 7
- The following snapshot shows the Agent log downloaded for Id 4.
Figure 13.14: Agent log download started
- Unzip the downloaded file to get the following Agent log zip files, as seen below. Unzip the files.
Figure 13.15: Downloaded Agent zip files
- Below you can see unzipped agent log files.
Figure 13.16: Unzipped Agent log files
Agent Logs: Download by Request Id
- The second option is to download Agent log by Request Id.
Figure 13.17: Choose Entity Workflow
- Type a Request id for which you need Agent Logs. Click Submit.
Figure 13.18: Enter Request Id
- A 'Request submitted successfully' message appears, and an entry in the Agent log list appears with status NEW.
Figure 13.19: Agent Log Entry with Status NEW
- The status changes to Download. Click the Download link.
Figure 13.20: Agent Log with Download Link
- It downloads a zip file, as seen below.
Figure 13.21: Agent Log Zip by Request Id
- Unzip the downloaded workflowinstance_9_log.zip to get the aeagent_2020-07-29.log.zip file and unzip it to see agent.log containing the log for the requested workflow Id.
Figure 13.22: agent.log available in the downloaded zip file
Audit Logs
The following Audit log information is maintained.
-
AutomationEde maintains Audit Logs for operations on entities, and the source can be Server, Agent or Process. In Process Studio, there is an 'Audit Log' plugin step through which users can send any Process Audit logs to AutomationEdge with the source as "PROCESS". AutomationEdge adds Agent log generated by Server or Agent with source Server and Agent, respectively.
-
In an Update operation, the second level of information, i.e. description, is also captured. Fields updated are added in the description of the Audit log. Field values before the update, and new field values, are also added in the Audit log description.
-
Audit logs also maintain more information such as Source IP.
Only Admins have access to this menu. Admins can search/download audit logs in the .csv format.
Audit Logs: View
View Audit Logs in the Logs menu.
- Click Logs menu and Audit Logs sub-menu. You can see a listing of Audit logs. The table below describes the columns.
Figure 13.23: Audit Logs
Table 13.2: Audit Logs Table
| Username | Login Username |
|---|---|
| Entity | The Entity name on which operation was performed |
| Following is the list of entities accessed by users. | |
| AGENT, | |
| AGENT_CONSUMPTION, | |
| APPLICATION, | |
| ARTIFACT, | |
| ASSISTED_AGENT_LICENSE | |
| CATEGORY, | |
| CREDENTIAL, | |
| CREDENTIAL_POOL, | |
| DEBUG_LOG_REQUEST, | |
| FILE, | |
| LDAP_CONFIGURATION, | |
| LICENSE, | |
| NOTIFICATION_CONFIGURATION, | |
| PS_PLUGIN, | |
| PS_PLUGIN_PROPERTY, | |
| REMEDY_FORCE_CONFIGURATION, | |
| REPORT_DASHBOARD, | |
| REPORT_DATASOURCE, | |
| REPORT_INSTANCE, | |
| REPORT_TEMPLATE, | |
| ROLE, | |
| SCHEDULE, | |
| SERVER_URL, | |
| SMTP_CONFIGURATION, | |
| SYSTEM_SETTING, | |
| TENANT, | |
| USER, | |
| USER_GROUP, | |
| USER_GROUP_MAPPING, | |
| WORKFLOW, | |
| WORKFLOW_CONSUMPTION. | |
| WORKFLOW_INSTANCE, | |
| WORKFLOW_PARAMETER, | |
| Operation | It is the operation performed. |
| Following is the current list of operations done on entities. | |
| ASSIGN, | |
| ASSIGN_PERMISSIONS | |
| AUTHENTICATE, | |
| CHANGE_PASSWORD, | |
| CREATE, | |
| DELETE, | |
| DOWNGRADE, | |
| DOWNLOAD, | |
| EXECUTE, | |
| EXPORT, | |
| IMPORT, | |
| LOGOUT, | |
| OWNERSHIP_TRANSFER, | |
| REGISTER, | |
| REQUEST, | |
| RESPONSE, | |
| RESTART, | |
| START, | |
| STOP, | |
| SYNC, | |
| UNASSIGN, | |
| UPDATE, | |
| UPGRADE, | |
| UPLOAD | |
| object id | The Id of the entity object on which the operation was performed |
| Source | The source for the Audit Log can be: SERVER, AGENT, WORKFLOW |
| Notes: AE also adds Username value for audit logs with source "SERVER" and the agent name value for source "AGENT/WORKFLOW", | |
| Status | It is the operation status. The status of operation can be: Success, Failure |
| Created Date | It is the audit log creation date. It is the Date of operation. |
| log level | Log level can be set to INFO or TRACE for source WORKFLOW in the Process Studio - Audit log step. For source, Server and Agent, Audit logs are system generated, and we do not specify log level. |
| username | If the source is SERVER, logged in username is populated. |
| agent name | If the source is AGENT/WORKFLOW, the Agent name is populated. |
| Object name (OPTIONAL) | The name of the entity object on which operation was performed |
| description (OPTIONAL) | A description of the Audit Log. |
- Click Fetch. Total count of records available and the Refresh option appears.
To refresh the total count view, click Refresh.
Audit Logs: Search
-
Type a string in the search box on the top right corner to filter records.
-
Type SYSTEM in the Search Box. Records with operation SYSTEM are filtered, as seen below.
Figure 13.24: Filtered Search Results
Audit Logs: Advanced Search
Perform Advanced Search by selecting one or more search criteria: Entity, Source, Log Level, Operation, Created and Status.
-
The Entity, Source, Log Level, Operation and Status can equal a value in the list.
-
Agent Name and Username can be with values equal to, not equal to, like, begins with, ends with.
-
Set Created Date using the options, exact date, before, after, in between or not in between.
Audit Logs: Download
Following is the process to download Audit Logs.
- On the Agent Logs menu, click Download Logs Button at the top right corner.
Figure 13.25: Download Audit logs
- Alternatively, you may put a filter text as shown below. You can now see the filtered records. Click Download logs.
Figure 13.26: Filter and Download Logs Audit
- Specify the Page Number to download.
Figure 13.27: Select Page Number
-
A Success message appears showing Audit Logs download started and a .csv file opens.
-
The Audit log file is downloaded into the file system.