Advanced Logging of Data Source Requests

When working with data sources on mobile platform server, one can executed advanced logging of the following requests:

To execute advanced logging of data source requests, one should use the rules that determine debug info output on requesting the specified resource by a specific API user. Activation of rules initiates logging of events of the types: RPC API Request, Web Service Request, JSON Resource Request with the Debug status in the System Logs subsection. Add, edit, and delete rules events are also logged.

IMPORTANT. When rules are activated, the request processing time increases and server resource consumption increases: the amount of central processing unit (CPU), virtual memory (RAM) and hard disk resource consumption increases.

To add and set up data source request logging rules, use the Data Source Request Logging Debug Rules tab in the System Logs Settings subsection:

The working area displays the list of logging rules. To view the rules list, the administrator should only have the Read-Only privilege for the Access to the Administration Section access option.

If a project is not selected in the Project parameter in the rule, each user in the API Users column is displayed in the format: <project name>: <user name>.

To add a rule:

Make sure that the administrator has the Full Permissions privilege for the Access to the Administration Section access option.
Click the Add Rule button.

After executing the operation the Add Data Source Request Logging Debug Rule dialog box opens:

Set the parameters:

Rule is Active. Select the checkbox to activate the rule and data source request logging in the System Logs subsection.

IMPORTANT. When the rule is activated, request processing time is increased and server resource consumption is increased. To reduce server load, follow the recommendations.

Rule Activity Time. Specify the number of days, hours, and minutes when the rule is active. After the specified time is out, the rule is deactivated, and the Rule is Active checkbox is deselected. Time countdown starts from the moment of rule saving when the rule is created or edited. The default rule activity time is 10 minutes. The maximum rule activity time is 7 days. Mandatory parameter.
Environment. In the drop-down list select the environment, for which requests to all contained resources will be logged. The environment can be selected if the administrator has the Read Debug Logs privilege, which covers all environments, specific environment, or environment project. Only one environment can be selected. Mandatory parameter.

If it is assumed to log requests to all environment resources, one needs to select the environment in the Environment parameter and not to set the parameters: Project, Data Source, and Resources.

Project. In the drop-down list select the project, for which requests to all contained resources will be logged. The project can be selected if it is contained in the environment selected in the Environment parameter, and the administrator has the Read Debug Logs privilege, which covers this project. Only one project can be selected.

If it is assumed to log requests to all project resources, one needs to select the environment in the Environment parameter, select the project in the Project parameter, and not to set the Data Source and Resources parameters.

Data Source. In the drop-down list select the data source, for which requests to all contained resources will be logged. The data source can be selected if it is contained in the project selected in the Project parameter. Only one data source can be selected.

If it is assumed to execute advanced logging of requests to all data source resources, one needs to select the environment in the Environment parameter, select the project in the Project parameter, select the data source in the Data Source parameter and not to set the Resources parameter.

Resources. In the drop-down list select one or several data source resources, requests to which will be logged. The resource can be selected if it is contained in the data source selected in the Data Source parameter.
API Users List. In the drop-down list select one or several API users, whose data source resource requests will be logged. Mandatory parameter.

NOTE. The selected API users can be used within one rule and also should have access permissions to request data of at least one resource selected in the Resources parameter. If resources are not selected, access should be allowed to at least one resource selected in the Data Source parameter, the project selected in the Project parameter, or the environment selected in the Environment parameter.

Click the Save button.

After executing the operations the rule is added to the list of rules. When the Rule is Active checkbox is selected, the system executes advanced logging of events of the types: RPC API Request, Web Service Request, JSON Resource Request with the Debug status in the System Logs subsection taking into account the specified rule parameters.

To edit rule:

Make sure that the administrator has the privileges:

Full Permissions for the Access to the Administration Section access option.
Read Debug Logs for one of the access options:

Access to the Environments Section. Any rule can be edited.
Access to Environment. The rule with corresponding environment can be edited.
Access to Project. The rule with corresponding project or environment containing this project can be edited.

Click the Edit button next to the rule.

After executing the operation the Edit Data Source Request Logging Debug Rule dialog box opens:

Change parameters specified on adding a rule.
Click the Save button.

After executing the operations the rule is edited and refreshed in the rules list.

To disable all rules:

Make sure that the administrator has the Full Permissions privilege for the Access to the Administration Section access option.
Click the Disable All Rules button.

After executing the operations all rules are disabled, and the system does not execute advanced logging of events of the types: RPC API Request, Web Service Request, JSON Resource Request with the Debug status in the System Logs subsection. When rules are disabled, the Rule is Active checkbox is automatically deselected for each rule.

The rule is also automatically disabled if one of the conditions is satisfied:

The environment selected in the Environment parameter is deleted. When the environment is deleted, all rule's parameters are reset.
The project selected in the Project parameter is deleted. When the project is deleted, the parameters are reset: Project, Data Source, Resources, API Users.
The data source selected in the Data Source parameter is deleted. When the data source is deleted, the Data Source and Resources parameters are reset.
The resources selected in the Resources parameter are deleted. When all resources are deleted, the Resources parameter is reset. When one or several resources are deleted, the resources list is refreshed.
The API users selected in the API Users parameter are deleted. When all API users are deleted, the API Users parameter is reset. When one or several API users are deleted, the users list is refreshed.

To delete rule:

Make sure that the administrator has the privileges:

Full Permissions for the Access to the Administration Section access option.
Read Debug Logs for one of the access options:

Access to the Environments Section. Any rule can be deleted.
Access to Environment. The rule, in which corresponding environment is set, is available.
Access to Project. The rule, in which corresponding project or environment containing this project is set, can be deleted.

Click the Delete button next to the rule.

After executing the operation it is asked to confirm rule deletion. If the answer is positive, the rule is deleted from the list.