Platform Logging System

Overview

The platform provides the ability to create logs and monitor operations for the following commonly investigated/validated modules:

  1. API Calls
  2. Workflows

This allows a user with the correct access level to investigate possible issues with sending/receiving data via the API or errors with workflow logic.

Procedures

1. Enable logging for the user.

Go to Setup > Monitoring > Log Setting. This will display the list users with logging enabled. Open your user or click New to create a new logging profile.

This will display a wizard similar to the screen below. At this point, fill up the required information and select the modules and workflows where you need logging to be enabled for as well as select the level of logging for each.

The following table can be used as a guide for the different fields/sections of the wizard.

Field Description
System Indicates if the logging will be made against the system user. This is normally done to view the logs for scheduled workflows. These are executed by the system user and are not tied to any particular UI user.
User Applicable only when the System checkbox is not ticked. Allows the selection of the user that the log profile will belong too. This is done since different platform users prefer different levels of logging. All events to be logged will be filtered for this user.
Start Date Date when logging will start. This can be a date in the past but logging will only start i the next instance that the module is executed.
Duration, minutes Indicates how long the logging will be enabled in minutes. Note that leaving this blank will result to the system to NOT generate logs.
Log Modules
Column Definition
Module Available module where logging can be enabled.
Level

Indicates the level of logging. Available options are:

  • Error (Default Option): Generates a log when the module encounters an error.
  • Info: Generates a log for informational messages.
  • Debug: Full logging (i.e. both Error and Info along with other ancillary information).

Click Submit to save the changes.

2. View the log details

This feature allows for the exporting of the log information depending on the modules and log-type configurations that were made for the user's logging profile. To access the logs, go to the user's logging profile via Setup > Monitoring > Log Setting and click the profile to open its details. A page similar to the one below will be displayed:

 

From the details page, the Log Records should be populated with log entries. The Export button can be clicked which will allow you to download a CSV file containing the log entries for offline viewing or further investigation.

Alternatively, the real-time logging can be used to view all log-enabled events. This can be accessed via the Log button on the account pop-up as shown in the screenshot below:

This will open a new tab/window that will contain the real-time logs in the application in the context of active logging profiles.

The data rendered here are visible to all users of the system as long as there are active logging profiles. Confidential information such as passwords, credit card data, bank account details, and session Ids are masked whenever they are included in this view.

Have more questions? Submit a request

Comments

Powered by Zendesk