Configure the logging of Collibra REST API v1 calls

Note This is a legacy feature that logs calls to the deprecated version 1 of the Collibra REST Core API.

You can use Collibra Platform in a web interface, but also through REST API calls. Every API call is logged in the component_call_logging database table. You can configure the methods that you want to log and the maximum number of entries to store.

Steps

  1. Open the DGC service settings for editing:
  2. In the API call logging, make the necessary changes.
    SettingDescription
    Enabled
    • True: API call logging is enabled for REST Core API v1 (deprecated) calls.
    • False (default): API call logging is disabled for REST Core API v1 (deprecated) calls.
    Maximum number of log entries (Requires restart)

    The maximum number of API calls to store in the component_call_logging database table. Once this number is reached, the oldest records are overwritten.

    The default value is 1,000,000.

    Pattern duration listThe list of methods and a corresponding minimum duration time. The minimum duration time is the minimum time before the method is stored in the database.
     Minimum duration
    		The time in milliseconds that an API call must last before it is logged.
     Method pattern
    		The method that you want to log in the database. For each pattern that you want to log, you have to add a new pattern.
  3. Click Save all.

What's next?

Restart the environment to apply your changes. For more information, go to Stop an environment and Start an environment.