Monitoring

Details about each traversal and synchronization errors can be examined in the History menu. Click on Show Details to get information about each traversal and inspect the errors during synchronization.

Here you can find general information about the traversal, e.g. the mode and type of the traversal, along with the count of discovered items in the source system and the number of items indexed to the search engine. Detailed information about failed operations can be found in the button section of the page.

The errors are categorized into item-level, job-level and initialization errors. Each item-level error associates exactly a single item, while a job-level error and an initialization error associates a dynamic subset of items within the source system which could not be processed by the connector.

From the configuration validation on the Configuration page and the error reporting on the History page the Admin UI should provide sufficient information to understand the state of your connector. By default, logging is not accessible, because this would raise a security vulnerability. But if necessary, to get more insight into system state, you can enable the logging endpoints for a connector product. In order to view the logs in the Log Viewer of the Admin UI, you have to add the following to the application.properties file:

It is also possible to change the log levels of the different loggers if you activate the loggers endpoint with the following setting in the application.properties file:

When the logfile endpoint is enabled, the logs can be also downloaded from the UI to share it with our Support Team. The logs can be retrieved and downloaded from the Logs menu. For downloading the logs, click on DOWNLOAD LOGS under LOGVIEWER.

The Connector provides metrics which can be natively pulled by Prometheus. The current snapshot of the metrics can be downloaded together with the System State, but to monitor the connector continuously and aggregate the metrics, we recommend to deploy your own Prometheus instance. To retrieve the list of available metrics, invoke the REST endpoint /actuator/metrics:

Detailed information about the connector, including its configuration, traversals (such as history, errors or jobs), and runtime details, can be obtained from the Log Viewer using the DOWNLOAD DIAGNOSTICS option under LOGVIEWER. Here you can also get information about the general system state including a subset of aggregated metrics and thread dump under 'Runtime information'. This option helps us to detect performance bottlenecks, among other things.

Upon selecting DOWNLOAD DIAGNOSTICS, you can choose the specific type of information you wish to download.

Once you have made your selection, click on CONFIRM & DOWNLOAD DIAGNOSTICS to proceed with the download.

To simplify the detection of errors, you can now group multiple loggers and simultaneously change their log level directly in the Admin UI. To do this, navigate to the Logger LOG GROUP in the Logs menu.

Four pre-defined log groups, namely item, principal, web, and SQL, are utilized to trace jobs related to items and principals, as well as to capture information regarding the database and web-based activities.

To adjust the log level, click on the log level located on the right side. A menu will appear, allowing you to choose the desired logging level.

When configuring logger groups, you simultaneously change the logging levels for all packages associated with that group. If you specifically want to adjust the logging level for an individual package, you can do so under LOGGERS in the Logs menu.

The shutdown actuator endpoint provides a possibility to initiate the shutdown of the application via REST request. In order to avoid security vulnerability the endpoint is disabled by default. However it can be enabled by adding the following to the `application.properties file: