# Workato Logging Service
Video Guide: Ways to use Workato Log Service
Logging is an essential tool for testing, troubleshooting, and debugging. Workato logging service provides a centralized storage for collecting log entries and an easy way to search through log entries.
Example log entry data
Cannot find Workato logging service?
Workato logging service is an added capability. This includes access to the logs page and Logger by Workato. Check with your Workato CSM to ensure that you have this capability enabled for your Workspace.
If your account is managed by Workato teams, your role must also have the Workato Logs Service Privilege.
# Why Use Workato Logging Service
Video guide: Troubleshoot steps in a loop faster
Workato logs is a centralized storage of log entries from your recipes.
Steps that are repeated in a loop are not fully visible from the job reports, as only the last execution of that step is displayed. Logging provides visibility into each iteration of repeated steps. This makes it easier to troubleshoot and debug steps which are nested within a loop.
Some business objects like customer accounts are integrated into multiple workflows. Logging allows you to track every time a recipe interacts with a certain customer (for example, customer account ACME Corp). Parsing through log data to find a single customer is easy with Workato logging service. You can filter logs with a search term or by recipe ID. Find out more about searching through logs entries
Adding log entries is easy with Logger by Workato. You can use log levels to filter logs from the logs table. For example, you can use the ERROR log level to find logs with errors.
# Where to find the Logs Page
Required permissions
To view the Logs page, you must have:
- The Admin system role, or
- The Logs privilege, located in Platform Tools
Navigate to Tools > Logs.
Workato Logging Service
Open it in-product
As each data center is independent, use the following links to open Workato Logging service for your region.
# Query and Find Log Entries
Video guide: How to search in Logs
Each log entry will contain metadata about when it was created, and by which recipe and job. You can use the filters to find the logs that are you most interested in. You may also search the log entries by the content of the log data.
Searching Logs
| Log field | Description |
|---|---|
| Time | The time this log entry was created. This will be displayed in the Workspace timezone. |
| Source | Where the log entry originated from. Note: As log entries can only by created by Logger by Workato currently, this field cannot used as a filter. |
| Log Level | Possible log levels are INFO, WARN, and ERROR. |
| Data | The log message from Logger by Workato. |
| Recipe ID | The recipe ID. |
| Job ID | The job ID. |
| Step number | The step number of the action in the recipe that created this log. |
| Connector | The connector which created the log entry. Note: As log entries can only by created by Logger by Workato currently this field cannot used as a filter. |
| Action | The actions which created the log entry. Note: As log entries can only by create by Logger by Workato currently, this field cannot used as a filter. |
# Log Entry Details
Click on the log entry to expand the log data. This will display the full log message.
You can perform a finer search within the log message.
Log entry data
# Add Log Entry with Logger by Workato
Under App selection, choose Logger by Workato.
Customize the content of your log message.
Toggle Send to Workato Logs and select the log level. Possible log levels are INFO, WARN, and ERROR.
This creates a log entry for every job, including test jobs.
Logger by Workato
Monitor recipe jobs in real-time with logs
The Logs page is updated as each log step is completed. This means that you do not need to wait for the entire recipe job to finish processing before viewing the logs. This enables you to track the real-time progress of long running recipes.
# Log encryption
Logs are encrypted at rest and in transit with a unique encryption key for each workspace and environment (if applicable).
Check out how it works with Workato's Encryption Key Management.
# Log limits
Each log entry has a maximum retention period of 30 days and is independent of the customized retention periods for other components in your workspace.
Each workspace and environment (if applicable) can store a maximum of 1,000,000 log entries. If the limit is exceeded, Workato continues to add new log entries, but old entries, beginning with the least recent are deleted.
# Scenario 1: Exceeding log entry limit
Consider the following scenario. Within a week the following activities occur in your environments:
- Your dev environment created 1,250,000 log entries.
- Your test environment created 1,000,000 log entries.
- Your production environment created 500,000 log entries.
Your logs page displays:
- In your dev environment, only the most recent 1,000,000 log entries.
- In your test environment, all 1,000,000 log entries.
- In your production environment, all 500,000 log entries.
# Scenario 2: Exceeding log retention period
Consider the following scenario. Your workspace created 10,000 log entries on January 1, 2023 and 18,000 log entries on February 1, 2023.
If you view the Logs page on February 15, 2023, you only see the 18,000 log entries that were created on February 1, 2023. The 10,000 log entries created on January 1, 2023 have been deleted due to the maximum retention period of 30 days.
# Size limits
The data column for each log entry has a maximum limit of 100KB. Once the limit is exceeded, the contents are truncated.
# Character encoding
UTF-8 character encoding is used in log entries and international characters are supported (e.g. "こんにちは世界!").