The Logs panel is a simple, but a very helpful tool that allows you to immediately get all the new logs from Salesforce within the IDE and to open them in-place without switching to any other application.
You can call the Logs panel from the Main Menu:
View ⇒ Logs Window.
At first, in the opened panel you will only see a list of all the projects in the current solution with checkboxes next to their names.
To get the logs for a project (or projects) you should tick the corresponding checkbox and press the Download Logs button at the top left corner of the panel. Once you do this, The Welkin Suite will start polling each project’s organization (that you’ve selected) for the new logs and will display them in the list, when they appear. Usually, it won’t take more than 5-10 seconds to get the new logs in the IDE, but in cases of heavy logs activity (e.g. hundreds of logs during some seconds), it may require a bit more time to update the list.
While the button is pressed, The Welkin Suite sends requests to Salesforce for the new logs every 20 seconds. You can change this value, for example, to decrease the number of API calls to your organization from the IDE. To do so, click the Log Settings button and set up the needed interval.
To stop the polling process for new logs you should press the Download Logs button once more and The Welkin Suite will stop downloading any new logs while the old logs will still be visible in the list.
In this panel, you can find all needed information about the logs:
- Application — the name of the application that triggered the log:
- for API clients, this value is the
- for browser clients, this value is
- Operation — the name of the operation that triggered the log,
- Start Time — start time of the transaction with seconds,
- Length — length of the log in bytes,
- Duration — duration of the transaction in milliseconds,
- Status — the status of the transaction. This value is either
Successor the text of an unhandled Apex exception,
- Request — the request type:
API— the request came from an API;
Application— the request came from the Salesforce user interface,
- Location — the location of the origin of the log:
Monitoring— generated as part of the debug log monitoring and visible to all administrators. These types of logs are maintained until the user or the system overwrites them,
SystemLog— generated as part of the system log monitoring and visible only to you. These types of logs are only maintained for 60 minutes or until the user clears them,
Preserved— a system log that is maintained longer than 60 minutes. Used for internal support,
- User — information about the author of the logged action.
You have an ability to set the visible columns in the Logs panel. You can hide the columns that currently don't provide any useful information for you. By default, the 'Request' and 'Location' columns are hidden, but you can return them to the panel and hide any other column whenever necessary. Click on the Configure columns button and check the necessary columns in the list.
These settings apply to a single session in TWS, so if you close the program and then re-open it, all the changes you made to the column visibility will be restored to defaultю
To find the data that you need in all the logs you can use filters in the header of each column, or you may sort data in ascending or descending order by clicking on a column's header.
Clicking on the Filter icon in a column's header will open the filter window. Here you can specify the search parameters and quickly find the exact version that you need.
First of all, you should select the item that will be determined as a search scope. You can check only the items that you are interesting in, or you can check Select all. The next inputs help you to get a more precise search result:
- the drop-down lists with search conditions:
Is equal to,
Is not equal to,
Does not contain,
Is contained in,
Is not contained in,
Is not empty,
Is less than,
Is less than or equal to,
Is greater than,
Is greater than or equal to,
Is not null,
- a text input, where you can type a text for the condition above,
- the button Match case, which makes the search case-sensitive,
- a drop-down list with the logic operators
The buttons at the bottom of the Filter window help you to manage the search process. You will get the search result immediately after selecting the search scope and selecting the search parameters. If you want to close the Filter window, click the Filter button, or the
x button in the top right corner — the filter still will be active (and its icon will be highlighted). To cancel the filter, open this filter again by clicking the filter's icon and click the Clear filter button.
The Date column has the same filter, except one field — instead of a text input there is a date input, so you can type the exact date or choose it from the calendar.
The Clear button allows you to remove the log files that are present in the log list when you no longer need them. This option comes in handy when you are generating lots of log files and need to clear this list when switching to another task or sub-task. E.g., if the current list of your downloaded log files is too big, or in case the list contains lots of outdated logs, which have already been deleted on your Salesforce Organization, navigating in this list gets a lot harder.
Additional actions with logs
If you find a log that you want to view in a text format, double-click it in the Logs panel, and it will be opened in the editor via Debug Logs Viewer. Please note that the logs content is downloaded once you open them, so the bigger the log the more time it will require being opened. You can find all log files that you downloaded in the Logs folder, which is placed in your project's folder.
In addition, you can easily debug any existing log file in the Debug mode of The Welkin Suite.
Also, you can easily set Debug log levels directly in the IDE without switching to Salesforce settings. To change the log level select any file in the Logs panel, click on the button Configure Debug Log Levels and select a necessary level for the type of log that you need. To apply the setting click the OK button. In addition, the button 'Set Retrospective Debugger Log Levels', so you can modify the log level in one click, and continue your working process.
This option helps you to save your time and concentrate on developing without switching between other applications or services.
The last option gives you the ability to switch to your local time in the Logs panel.
The start time for your log files changes automatically according to the selected status of this option. You can easy back to the UTC time by clicking on it again at any time. The following changes you can see directly in the Debug Log viewer.
In this section:
This also may be useful: