Configure your Connectivity Hub log settings

In Upland BA Insight Connectivity, you can configure specifications for the log files that are collected when various administration actions are performed.

Prerequisites

Specifying log collection in Connectivity Hub

To specify your log collection settings from the Connectivity Hub administration portal, do the following:

  1. In the Connectivity Hub administration portal, click Tools > Configuration > Log Settings tab.

  2. Complete the following fields:

    Refer to the Tune Your Log Configuration Settings table for more information on logging levels.

    1. In the Admin site logging level field, specify the logging level for your admin site actions.

    2. In the Scheduler service logging level field, specify the logging level for your scheduler actions.

    3. In the Crawl service logging level field, specify the logging level for crawl service actions.

    4. In the Enable audit logging field, enable the checkbox to turn on the audit logging functionality.

    5. In the Cache database field, select the cache database you are using for your audit logging from the drop-down menu. Upland BA Insight recommends that you create a new database to store your audit logging information. For more information on creating a cache database, see How to Manage Your Cache Database.

Specifying log collection outside of Connectivity Hub

To specify your log collection settings from outside of the Connectivity Hub administration portal, you must update the relevant logging.config file.

Collecting administration site logs

You should view these logs for the following reasons:

  • You cannot save a specific content or connection

  • You cannot an exception when performing an UI operation, like opening a target, dataset etc

  • You cannot connect to cache/configuration database

  • Content TestBench shows an exception/error/warning

  1. In your ConnectivityHub installation directory, navigate to the Admin Site folder.

  2. To see your log entries, click the Logs folder.

  3. To configure your logging settings, open the Logging.config file in a text editor. Refer to the Tune Your Log Configuration Settings for more information.

Collecting job logs

You should view these logs for the following reasons:

  • Unexpected behavior when you run the target sync.

  • Items missing from incremental crawl.

  • Unexpected behavior when you run Security Sync or any other connection task.

  1. In your ConnectivityHub installation directory, navigate to the Quartz Server folder.

  2. To see your log entries, click the Logs folder.

  3. Depending on the logging level selected while starting or scheduling a job, all or a part of the log entries can be seen from the Administration portal under Tools > Logs. The information logged by each task in particular can also be seen from Tasks > Actions > View Logs.

  4. To configure your logging settings, open the Logging.config file in a text editor. Refer to the Tune Your Log Configuration Settings for more information.

Tune Your Log Configuration Settings

Change the following attributes of log file to suit your logging requirements.

Do not change the value "ALL" of the <level> element found inside the <root> section of the Logging.config file. To change the level for the file logging, set the value of the <threshold> element found in the "DefaultRollingFileAppender" appender section. To modify the level of the logs that can be seen in the UI, set the "Log level" value from the drop-down box while starting or scheduling a new job.
Changing the log level from the default (INFO) to another level such as DEBUG or TRACE, generates more log entries in the log file. This comparison is based on the default log level and impacts crawl performance. For this reason, only change a log level setting if additional information is required for troubleshooting. For the best performance, set your normal production logging level to INFO.
Parameter value Description
threshold value Fatal This records critical errors that make the system unusable.
Error This indicates a serious runtime failure that prevents part of the system from completing a task. The application can continue running, but a key execution operation failed.
Warn

This records potential failures that are not critical to the execution of the program. This log level logs only warnings and errors in order to catch obvious problems.
Info

This collects general information about the Connectivity Hub’s normal operations. For example, successful startup, configuration summaries, or key state changes.

This records the completion of different stages of the logged process, and other information as notes. These logs also display everything that WARN does in addition to INFO messages and lets support, solutions, and developers resolve less obvious issues such as items:

  • Missed after a crawl

  • Not removed from the index

  • Items whose security is not updated

The maximum space that is used by the WARN and INFO log files is 500MB.
Debug This collects detailed technical information that useful for developers when diagnosing issues. It is used for deeper troubleshooting by showing technical details required to resolve most errors and issues. These logs display everything that INFO log files show as well as some debugging information. The maximum space that is used by these log files is 4GB.
Trace

This records full details for troubleshooting, and contains all of the log messages. The temporary files that are created at run-time for processed items are not deleted. Additional report files are created during any incremental crawls. For this reason, the TRACE files are the most verbose of the log files. The maximum space that is used by these log files is 16GB.

These details include:

  • All of the log messages

  • Temp files that are created for processed items

  • Additional report files that are created during incremental crawls. (These files have EnumReportor ItemReport in their names and the .data extension.)

  • These files contain items that are enumerated by the crawl.
maximumFileSize - This sets the maximum log file size to archive, in bytes (also supports suffixes like KB and MB). By default, this is set to 10MB.
maxSizeRollBackups - This sets the maximum number of log files to archive.