Logging for provisioning

In new deployments of i2 Analyze, the provisioning process logs information to the console, and to the console.log and i2_Analysis_Repository.log files. This topic explains how to add provisioning logging to existing deployments, and how to configure the logging level.

Before you begin

The logging that you add or configure through this topic is for the provisioning mechanism that was introduced in i2 Analyze version 4.4.4. To see output, you must already have configured user provisioning in your deployment.

About this task

Adding provisioning logging to an existing deployment of i2 Analyze involves adding a new logger named com.i2group.provisioning.UsersAndGroups to the log4j2.xml file.

When provisioning logging is active, changing the logging level just requires changing the value of the level attribute.

After any change to the log4j2.xml file, you must redeploy the Liberty server so that the change takes effect.

Procedure

To add provisioning logging to an existing deployment of i2 Analyze that was upgraded to version 4.4.4 or later:

  1. Using an XML editor, open the log4j2.xml file for the deployment. The file is in the toolkit\configuration\fragments\common\WEB-INF\classes directory.

  2. Add the following <Logger> element to the file, alongside all the others:

    <!-- User and group provisioning -->
<Logger additivity="false" level="INFO" name="com.i2group.provisioning.UsersAndGroups">
  <AppenderRef ref="APOLLOLOG"/>
  <AppenderRef ref="CONSOLE"/>
</Logger>

    This element is configured identically to the one that new deployments of i2 Analyze have by default.

  3. (Optional) To log more information about the provisioning process, change the value of the level attribute in the <Logger> element to DEBUG:

    <Logger additivity="false" level="DEBUG" name="com.i2group.provisioning.UsersAndGroups">

To apply your changes to the i2 Analyze application:

  1. Stop Liberty:

    setup -t stopLiberty

  2. Update the i2 Analyze application:

    setup -t deployLiberty

  3. Start Liberty:

    setup -t startLiberty

Note: If you follow this procedure in a deployment that provides high availability, you must complete each step on every Liberty server in your environment before you move to the next step.