Enabling trace logging

You can enable trace logs for different features within IBM OpenPages® to help you to diagnose issues that you might encounter.

You can enable trace log options in the following ways:

Use the LogCollector user interface. For more information, see Gathering logs with the LogCollector user interface.
Change the auroralogging.properties file. To use this method, follow the steps in this topic.

About this task

Trace logging generates a large amount of data on the application server. Enable trace logging only during testing and when other users are not on the system. Make sure to disable trace logging before users access the server again.

When trace logging is enabled, separate log files are created in the <OP_HOME>/aurora/logs/debug directory. These log files have a suffix that indicates the log type, such as <server_name>-workflow.log, and <server_name>-sdk.log.

Generally, trace logs contain the following information:

Enter and exit messages for relevant API calls.
Timings for each method.
Targeted debug logging.
Some appenders also support apiutilinterceptor and apiutilinterceptorresponse loggers, which log HTTP API requests and responses.

The following trace logs are available:

Table 1. Appenders and associated loggers
Purpose	Appender	Loggers	Log file location
Logs API requests.	`api`	`apimove`, `apiresource`, `apischeduler`, `appservice`, `resourceutil` `respviewrule`, `toolboxmanager`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-api`<log_suffix>`.log
Applications Common Logger	`app-common`	`addnewappcommon`, `app-common`, `dependcommon`, `relationcommon`, `sosacommon`, `taglibcommon`, `utilcommon`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-app-common`<log_suffix>`.log
Tracks LDAP operations for the LDAP user provisioning.	`auth`	`ldapui`, `logon`, `logonerrortag`, `logonfilter`,`opappsession`, `opsession`, `securityservice`, `securityutil`, `sso`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-auth`<log_suffix>`.log
Logs information for debugging the antivirus scanner.	`avscanner`	`avscanner`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-avscanner`<log_suffix>`.log
Logs application-specific cache messages.	`cache`	`auroracache`, `metadatacache`, `objectprofilecache`, `respviewcache`, `sdkcache`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-cache`<log_suffix>`.log
Logs all calculations.	`calculation`	`calcservice`, `calculation`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-calculation`<log_suffix>`.log
Logs computed fields, reporting fragments, and connections to IBM® Cognos® Analytics from OpenPages.	`cognos`	`cognos`, `cognosreports`, `cognosservice`, `reportsservice`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-cognos`<log_suffix>`.log
Logs information specific to IBM Cloud Pak® for Data or SaaS operations.	`cp4dsaas`	`cp4dldap`, `cp4dsecurity`, `rabbitmq`, `saasuser`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-cp4dsaas`<log_suffix>`.log
Logs all database Create/Read/Update/Delete operations and associated access data.	`dataaccess`	`dataaccess`	`<OP-HOME>`/aurora/logs/`<server_name>`-dataaccess`<log_suffix>`.log
Logs database service operations.	`dbquery`	`dbservice`, `queryapiservice`, `queryservice`, `repositoryservice`, `resourcemanager`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-dbquery`<log_suffix>`.log
Logs email activity including whether email messages are sent successfully.	`emailnotification`	`emailnotification`, `emailnotificationsolutions`, `emailnotificationtrigger`, `emailnotificationreport`, `emailnotificationsitegenerator`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-emailnotification`<log_suffix>`.log
Logs third-party feeds, such as Thomson Reuters or Wolters Kluwer, and IBM Knowledge Catalog integrations.	`feeds`	`feeds`, `apiutilinterceptor`, `apiutilinterceptorresponse`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-feeds`<log_suffix>`.log
Logs information for debugging connections to Solr on the search server from the OpenPages application server for Global Search.	`globalsearch`	`globalsearch`, `searchapi`, `searchservice`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-globalsearch`<log_suffix>`.log
Logs information for loss events.	`lossevent`	`lossevent`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-lossevent`<log_suffix>`.log
Logs machine learning operations to debug issues with machine learning integration.	`machinelearning`	`machinelearning`, `apiutilinterceptor`, `apiutilinterceptorresponse`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-machinelearning`<log_suffix>`.log
Logs successful and failed login and logout attempts.	`opaccess`	`opaccess`	`<OP-HOME>`/aurora/logs/`<server_name>`-opaccess`<log_suffix>`.log
Logs database access.	`persistence`	`persistence`, `persistenceroot`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-persistence`<log_suffix>`.log
Logs information for questionnaire operations.	`questionnaire`	`questionnaire`, `questionnaireservice`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-questionnaire`<log_suffix>`.log
Logs debug information for the reporting framework generation.	`reportingframework`	`reportingframework`, `rps`	`<OP-HOME>`/aurora/logs/`<server_name>`-reportingframework`<log_suffix>`.log
Logs access to custom REST API endpoints.	`rest`	`rest`, `restinterceptor`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-rest`<log_suffix>`.log
Logs REST API information.	`restapi`	`restapi`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-restapi`<log_suffix>`.log
Logs information for debugging the third-party component, named Quartz, which is used by the OpenPages Scheduling service.	`scheduler`	`quartz`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-scheduler`<log_suffix>`.log
Logs information for debugging the OpenPages Scheduler Service.	`scheduler`	`scheduler`, `schedulerapi`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-scheduler`<log_suffix>`.log
Logs all SDK API calls.	`sdk`	`sdk`, `sdkinvocation`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-sdk`<log_suffix>`.log
Logs SDK API calls.	`sdkgeneral`	`sdkcomparison`, `sdkcomputation`, `sdkobjectprofile`, `sdkmeta`, `sdkreg`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-sdkgeneral`<log_suffix>`.log
Logs security encryption operations.	`security`	`securityencrypt`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-security`<log_suffix>`.log
Logs services operations.	`services`	`serviceapp`, `serviceaudit`, `servicecommon`, `servicenps`, `servicepublish`, `servicerepo`, `serviceresource`, `serviceschema`, `serviceutil`, `serviceview`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-services`<log_suffix>`.log
Logs trigger evaluations and executions.	`trigger`	`triggerapi`, `triggerlifecycle`, `triggers`, `triggersdk`, `triggerutil`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-trigger`<log_suffix>`.log
Logs API requests from the UI.	`uiapi`	`appcontroller`, `apprestcontroller`, `basecontroller`, `componentsfilter`, `dashboard`, `modelresource`, `servicefilter`, `typescontroller`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-uiapi`<log_suffix>`.log
Logs debugging information for the integration with IBM Watson® Language Translator.	`watson`	`watson`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-watson`<log_suffix>`.log
Logs IBM watsonx Assistant™ operations.	`watsonother`	`watsonassistant`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-watsonother`<log_suffix>`.log
Logs Watson classifier operations.	`watsonother`	`watsonclassifier`, `apiutilinterceptor`, `apiutilinterceptorresponse`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-watsonother`<log_suffix>`.log
Logs Watson mapping operations.	`watsonother`	`watsonmapping`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-watsonother`<log_suffix>`.log
Logs trace information for the Microsoft Office integration.	`webdav`	`webdav`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-webdav`<log_suffix>`.log
Logs all workflow API calls, model calls, and action evaluations.	`workflow`	`workflow`, `workflowapi`, `workflowmodel`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-workflow`<log_suffix>`.log
Logs read access to track audit user activities.	`ateventdataservices`	`activitytrackereventdata`	`<OP-HOME>`/aurora/logs/debug/`<server_name>`-services.log

Procedure

Log on to the OpenPages application server.
Disable trace logging in the UI by changing Applications > Common > Administration > Enable Manage Trace Options to false.
The auroralogging.properties file is automatically updated by the LogCollector user interface. Before you edit the auroralogging.properties file manually, disable trace logging to keep the UI and the auroralogging.properties file in sync. Otherwise the trace logging settings in the UI will not match the settings in the auroralogging.properties file.
Go to the <OP_HOME>/aurora/conf directory.
Back up the auroralogging.properties file.
Open the auroralogging.properties file with a text editor.
To use a trace logger, add the name of the logger to the loggers = entry near the beginning of the file, and add its associated appender to the appenders = entry.
For example, to enable workflows, add the logger and appender as follows:
```
appenders = CONSOLE, FILE, startup, reportingframework, ateventdataservices, workflow
loggers = startup, reportingframework, rps, workflow, activitytrackereventdata
```
To enable logging for single sign-on authentication events, add the opappsession, securityutil, sso, authentication, logon loggers to the loggers = entry along with the associated appender auth to appenders = entry as shown in the following example:
```
appenders = CONSOLE, FILE, startup, reportingframework, ateventdataservices, auth
loggers = startup, reportingframework, activitytrackereventdata, rps, opappsession, securityutil, sso, authentication, logon
```
1. To increase the logging level from DEBUG to TRACE, do the following steps.
  Attention: When the logging level is set to TRACE, the log can contain Personal Information (PI) such as usernames and emails.
  1. Locate the following lines:
```
#TRACE level may contain sensitive information such as user names
appender.auth.filter.threshold.type = ThresholdFilter
appender.auth.filter.threshold.level = DEBUG
```
  2. Change appender.auth.filter.threshold.level = DEBUG to appender.auth.filter.threshold.level = TRACE.
Save your changes and close the file.
When you finish debugging, disable the loggers.
Restore the backup of the auroralogging.properties file. Or, remove the logger and appender names from the loggers = and appenders = entries in the properties file.
Logging configuration is automatically refreshed in 60 seconds without requiring a server restart.