When a user binds connectors to controls, sometimes it maintains a state of loading while fetching the data or while executing any functionality of the subcategory connector API. in this state user is not aware of the exact status or error faced by the connector.
Usually, developers check the status of the connector from the browser’s dev tool. To avoid this hectic method and make it simpler to check the status of the request, the Studio has introduced the Connectors Logs feature.
Connectors’ Logs is very useful to understand the status of the request of one or more connectors collectively in the preview screen itself. It is available only in preview mode for the users and developers of the microapp. You can resize the panel and also can relocate it on the screen according to your convenience.
Using Connector Logs
To take advantage of the connector logs feature in your app preview you have to enable it from the Settings under Preview Settings (By default it is disabled). You will see the option to enable and disable connector logs, by enabling this option, you can see all the live connectors logs while previewing the app, and lets you debug the app and check the data points quickly.
Next click on the preview app option and you will see an icon above on the screen right beside where the environment is mentioned. Click on that icon and your connector logs will be shown on the screen.
Connector Logs – features
Logs
Search
In the Connector Logs panel, we have a search bar that takes names of connectors or connector initiators such as control and actions as its input.
Filter by
The Filter By section of the panel enables you to filter all the present connectors logs in the screen in four different categories.
- All Logs – Show all the connector logs present on the screen.
-
Success Logs – Show all the connector logs which have a successful response. Any connector log with a status code of 2XX will be considered a success type.
-
Error Logs – Show all the connector logs which have an error response. Any connector log with a status code other than 2XX will be considered a failure and will be in Red. Anything with the prefix FC-Code is a failure induced by the creator’s condition and the code will be the one they define.
- Loading Logs – Show all the connector logs which have a pending response.
Clear Logs
On the very right-hand side, there is a button for Clear Logs which cleans the panel including all connector logs.
Download Logs
This option in the connector logs panel supports you with the feature to download details of the connector logs.
You get two options while downloading the connector logs. You can choose from All Logs and Error Logs to download all the connector logs and connector with error logs present on the screen respectively.
It downloads the logs in a JSON format file.
Name
The names of the connectors can be viewed on the Connector Logs panel. The naming on the panel is provided in a certain format which is the name of the used connector followed by its subcategory.
You can click on any name or row from the list of connector logs on the panel. This will open a window where you can view the request and response details of that connector.
You will have options to collapse or copy the request and response data of the connector.
Status
The connector logs feature has a column of status. This is a very simple yet effective feature that enables the users to view the status of the connector with its status code and also along with additional info such as the failure condition effect.
In the above image, there are two connectors that are having errors along with their failure condition configured during adding the subcategory.
Type
This column from the panel simply shows how/from where the connector is being initiated. in your app. In the Studio, we can add connectors in different ways such as in the data-bind section and action section. This column will inform the user about the type of connector being used.
In the above image, you can see that under the Type column we have data and action.
Initiator
On the panel of Connector Logs, we have a column for Initiator. This column provides information regarding the initiator of the connectors in the micro app. These initiators can be controls and actions, anywhere the connectors are called or bound to.
If the initiator of the connector is the control it will display the unique name of the control and if it is a trigger-dependent action then it will display the unique name of the control followed by the action of that control, from where the connector API call has been triggered.
Time
When an API call is made, the whole process to fetch data takes a certain time. The TIME section on the panel provides the time taken from calling the API to fetching the data, basically showing how long the request took.
You will notice that the time taken by the request is shown much less under the network tab from the web browser’s dev tools, than the time shown on the connector logs panel. The above time data present on the connector logs panel is the entire request time of the connector’s call from initiating the request to completing the request, also including the time taken by other factors applied on the connector such as data transformation, failure conditions, and more.
Timeline
The Timeline section of the connector enables you to view how much time it is taking for the API to load and provide a success or an error response. You can also view the type and the initiator of the API call.
Watchlist
The Watchlist section of the connector logs enables you to watch out for all the keywords, variables, and controls as well as its properties being used.
You will have a list of variables and keywords from where one can check all the dependencies, connectivity, control and profile details.
In the image above you can see that the data is shown along with its data type (JSON) along with where it is being used in the application, basically the hierarchy of keywords and variables and controls.