Skip to main content

6.3. Maintenance Tools

6.3.1. Universal APIDFX Call Logging (available when the dfx-ks-api package is installed)​

A call log for Universal APIDFX methods has been added, where you can view all requests processed by the system.

To open the log, go to the Administration workspace, open the Maintenance Tools folder, and select the APIDFX Request Log shortcut. The call registry will be displayed.

When opening a registry record, the following information is displayed:

  • Method name;

  • Request date and time;

  • Request body;

  • Response body;
    For requests that retrieve attribute values from the system, the Response body field does not contain this data for security reasons.

  • The user account under which the request was executed.

6.3.2. External API Call Logging​

It is now possible to configure logging for external API call methods. After enabling the logging feature for the required methods, you can view the logs in the shortcut.

6.3.2.1. Configure Logging for an API Method​

  1. In the navigation pane, select the Studio workspace 1.

  2. Select the Integration shortcut group 2, then select the External APIs shortcut 3.

  3. Select the API connection for which you want to configure method logging 4.

  4. Go to the Methods tab 1, then in the left panel select the method 2 for which you want to enable logging.

  5. Enable the Logging toggle.

  6. If needed, enable the Log response body 1 and Log request body 2 toggles.

  7. In the Retention period (days) field 3, enter the number of days you want to retain the log in the shortcut.

Note:

  1. In the toolbar, select Save.

6.3.2.2. Change the Log Retention Period at the System Level​

  1. In the navigation pane, select the Administration workspace 1.

  2. Select the Settings shortcut group 2, then select the System Settings shortcut 3.

  3. Open the msg.externalApiLogs.retentionDays key 4.

  4. In the Value field 1, enter the number of days you want to retain the log in the shortcut.

  5. In the toolbar, select Save 2.

This value will apply to all system methods that have call logging enabled and for which no per-method retention period has been specified.

6.3.2.3. View Method Logs​

  1. In the navigation pane, select the Administration workspace 1.

  2. Select the Maintenance Tools shortcut group 2, then select the External API Logs shortcut 3.

This shortcut displays all logs for methods for which you have enabled logging. Each log record contains the following data:

  • API Code — the code of the API connection to which the method belongs.
  • Method Name — the name of the method itself.
  • Request Date — the date when the method was executed and recorded in the log.
  • Response Code — the HTTP status code indicating the method's execution status. The main types of codes, based on their first digit:
    • 1xx — Informational
    • 2xx — Successful operations
    • 3xx — Redirections
    • 4xx — Client errors
    • 5xx — Server errors
  • User — the platform user who initiated the method execution.

6.3.3. Elasticsearch Synchronization Incidents​

Every time data is updated in the system (for example, when a document is modified), synchronization with Elasticsearch is performed to ensure up-to-date search results. If Elasticsearch is temporarily unavailable (for example, a stopped container or a connection issue), the synchronization fails. Such errors are no longer retried automatically — the system records them in an incident log.

This allows users with the Admin or SysOps role to view the list of incidents, analyze the cause of the error, and after resolving it, retry the synchronization.

6.3.3.1. View the List of Incidents​

To view the list of synchronization incidents:

  1. In the navigation pane, select the Administration workspace 1.

  2. Select the Maintenance Tools shortcut group 2, then select the Elasticsearch Synchronization Incidents shortcut 3.

    The list displays the following data:

    • A Entity — the object for which the error occurred (for example, dfx_Document if the error occurred during document synchronization).
    • B Object ID — the unique identifier of the object (for example, a document) for which the error occurred.
    • C Operation — the type of operation that caused the error.
    • D Error Count — the number of times the error occurred for this item. That is, if multiple actions were performed on the same document and each action caused a synchronization error, this field shows the total number of errors for that document instead of creating a separate record for each error.
    • E First Error Date
    • F Last Error Date — relevant if the error occurred multiple times for the same item. If there is only one error, the first and last error dates will be the same.

  3. To view the error details, open the record — the Error Text will be available in the corresponding field on the form.

6.3.3.2. Retry Synchronization​

After resolving the cause of the error (for example, after Elasticsearch is back online), you can retry the synchronization.

To do this:

  1. Go to the incident list (see the previous section).

  2. In the incident list, select one or more records 1.

  3. In the toolbar, select Retry Synchronization 2.

    The action is also available in the record's context menu.

  4. Select Yes to confirm the action.

Note:

After a successful synchronization, the record will disappear from the incident registry. Old records are automatically deleted according to the elfts.indexingLog.retentionDays system setting (default — 30 days). To change the record retention period, you can modify the system settings.