IBM Support

SDI 7.2 - How to Enable Real Time debug logging on Security Directory Integrator server

How To


Summary

When symptoms need to be investigated in a SDI server process, certain environments 'e.g. production' do not allow the steps to be performed to enable DEBUG in the LOG4J framework. For modifications to the log4j.properties file to take effect in a server, a restart of the SDI server process is required. For an alternative method of collecting detailed logs on an assembly line, the steps documented in this note can be followed.

Objective

To provide a set of steps to be executed locally on the SDI server to enable / disable detailed log for an assembly line actively running in a SDI server instance.

Environment

SDI 7.2.0.3

Steps

Command Syntax

For complete syntax of the debug operation provided with the tdisrvctl utility, refer to https://www.ibm.com/support/knowledgecenter/SSCQGF_7.2.0.3/com.ibm.IBMDI.doc_7.2.0.3/c_admin_operations.html


Linux - Example cmds to enable / disable detail logging for the 'SDS_ChgLog_AL' assembly line in the 'SDS' config 

Step 1: Setting env parameters used in example

export SDI_HOME=/opt/IBM/TDI/V7.2
export SDI_SOLDIR=/opt/IBM/TDI/Sol72
export SDI_CONFIG=SDS
export SDI_AL=SDS_ChgLog_AL
export SDI_PORT=1099

Step 2: How to determine the available 'configs' on the running SDI Server.

$SDI_HOME/bin/tdisrvctl -s $SDI_SOLDIR -p $SDI_PORT -T $SDI_SOLDIR/serverapi/testadmin.jks -W administrator -K $SDI_SOLDIR/serverapi/testadmin.jks -P administrator -v -op status
The command output will show the name of the configs activity running in the server
--- Configs ---
0 # SDS # RUNNING
--- AssemblyLines ---
CTGDJB095I In viewAllALStatus method.
CTGDJB096I Number of running Configs:1.
1 # SDS_ChgLog_AL # RUNNING # Get:2071, getclient:0, Add:2070, Modify:0, Delete:0, Errors:0, Skip:0, Lookup:0, CallReply:0, reply:0, Ignore:0, Switches:0, Nochange:0
CTGDJB073I Return Code: 0.

Step 3: (optional) Verify the current Debug mode value of the components in the AssemblyLines of a specified Config

$SDI_HOME/bin/tdisrvctl -s $SDI_SOLDIR -p $SDI_PORT -T $SDI_SOLDIR/serverapi/testadmin.jks -W administrator -K $SDI_SOLDIR/serverapi/testadmin.jks -P administrator -v -op report -c $SDI_CONFIG
* Command output shows the config name, assemblyline names, connector names, and debug stated. 
CONFIG REPORT
=============
 Config         : SDS
--- AssemblyLines ---
 Name           : SDS_ChgLog_AL
 Comment        : None

--- Components in AssemblyLine SDS_ChgLog_AL ---
 Name           : IBMDirectoryServerChangelogConnector
 Mode           : Iterator
 State          : Enabled
 Debug          : Enabled
 Template       : system:/Connectors/ibmdi.IBMDirectoryServerChangelog
 Parser         : [parent]
 Comment        : None
 Name           : FileConnector
 Mode           : AddOnly
 State          : Enabled
 Debug          : Disabled
 Template       : system:/Connectors/ibmdi.FileSystem
 Parser         : system:/Parsers/ibmdi.CSV
 Comment        : None

Step 4: Using the 'Config' name identified in Step 2, enable the debug mode for all components in the running AssemblyLine 'SDS_ChgLog_AL'

$SDI_HOME/bin/tdisrvctl -s $SDI_SOLDIR -p $SDI_PORT -T $SDI_SOLDIR/serverapi/testadmin.jks -W administrator -K $SDI_SOLDIR/serverapi/testadmin.jks -P administrator -v -op debug -c $SDI_CONFIG -r $SDI_AL -on

Step 4a: (optional) Using the 'Config' name identified in Step 2, enable the debug mode for specified component in the running AssemblyLine 'SDS_ChgLog_AL'

$SDI_HOME/bin/tdisrvctl -s $SDI_SOLDIR -p $SDI_PORT -T $SDI_SOLDIR/serverapi/testadmin.jks -W administrator -K $SDI_SOLDIR/serverapi/testadmin.jks -P administrator -v -op debug -c $SDI_CONFIG -r $SDI_AL -alc IBMDirectoryServerChangelogConnector -on
When you review the content of the <solution directory>/logs/ibmdi.log the content of the CONN,CURRENT, and WORK objects should be seen for the connectors of the mentioned assembly line.

Step 5: Using the 'Config' name identified in Step 2, disable the debug mode for all components in the running AssemblyLine 'SDS_ChgLog_AL'

$SDI_HOME/bin/tdisrvctl -s $SDI_SOLDIR -p $SDI_PORT -T $SDI_SOLDIR/serverapi/testadmin.jks -W administrator -K $SDI_SOLDIR/serverapi/testadmin.jks -P administrator -v -op debug -c $SDI_CONFIG -r $SDI_AL -off

Step 5a: (optional) Using the 'Config' name identified in Step 2, disable the debug mode for specified component in the running AssemblyLine 'SDS_ChgLog_AL'

$SDI_HOME/bin/tdisrvctl -s $SDI_SOLDIR -p $SDI_PORT -T $SDI_SOLDIR/serverapi/testadmin.jks -W administrator -K $SDI_SOLDIR/serverapi/testadmin.jks -P administrator -v -op debug -c $SDI_CONFIG -r $SDI_AL -alc IBMDirectoryServerChangelogConnector -off

Windows - Example cmds to enable / disable detail logging for the 'SDS_ChgLog_AL' assembly line in the 'SDS' config

Step 1: Setting env parameters used in example

set SDI_HOME=C:\IBM\TDI\V7.2
set SDI_SOLDIR=C:\IBM\TDI\Sol72
set SDI_CONFIG=SDS
set SDI_AL=SDS_ChgLog_AL
set SDI_PORT=1099

Step 2: How to determine the available 'configs' on the running SDI Server.

%SDI_HOME%/bin/tdisrvctl -s %SDI_SOLDIR% -p %SDI_PORT% -T %SDI_SOLDIR%/serverapi/testadmin.jks -W administrator -K %SDI_SOLDIR%/serverapi/testadmin.jks -P administrator -v -op status
The command output will show the name of the configs activity running in the server
--- Configs ---
0 # SDS # RUNNING
--- AssemblyLines ---
CTGDJB095I In viewAllALStatus method.
CTGDJB096I Number of running Configs:1.
1 # SDS_ChgLog_AL # RUNNING # Get:2071, getclient:0, Add:2070, Modify:0, Delete:0, Errors:0, Skip:0, Lookup:0, CallReply:0, reply:0, Ignore:0, Switches:0, Nochange:0
CTGDJB073I Return Code: 0.
Step 3: (optional) Verify the current Debug mode value of the components in the AssemblyLines of a specified Config
%SDI_HOME%/bin/tdisrvctl -s %SDI_SOLDIR% -p %SDI_PORT% -T %SDI_SOLDIR%/serverapi/testadmin.jks -W administrator -K %SDI_SOLDIR%/serverapi/testadmin.jks -P administrator -v -op report -c %SDI_CONFIG%
* Command output showing the 'Debug' state of a compoent
CONFIG REPORT
=============
 Config         : SDS
--- AssemblyLines ---
 Name           : SDS_ChgLog_AL
 Comment        : None

--- Components in AssemblyLine SDS_ChgLog_AL ---
 Name           : IBMDirectoryServerChangelogConnector
 Mode           : Iterator
 State          : Enabled
 Debug          : Enabled
 Template       : system:/Connectors/ibmdi.IBMDirectoryServerChangelog
 Parser         : [parent]
 Comment        : None
 Name           : FileConnector
 Mode           : AddOnly
 State          : Enabled
 Debug          : Disabled
 Template       : system:/Connectors/ibmdi.FileSystem
 Parser         : system:/Parsers/ibmdi.CSV
 Comment        : None

Step 4: Using the 'Config' name identified in Step 2, enable the debug mode for all components in the running AssemblyLine 'SDS_ChgLog_AL'

%SDI_HOME%/bin/tdisrvctl -s %SDI_SOLDIR% -p %SDI_PORT% -T %SDI_SOLDIR%/serverapi/testadmin.jks -W administrator -K %SDI_SOLDIR%/serverapi/testadmin.jks -P administrator -v -op debug -c %SDI_CONFIG% -r %SDI_AL% -on

Step 4a: (optional) Using the 'Config' name identified in Step 2, enable the debug mode for specified component in the running AssemblyLine 'SDS_ChgLog_AL'

%SDI_HOME%/bin/tdisrvctl -s %SDI_SOLDIR% -p %SDI_PORT% -T %SDI_SOLDIR%/serverapi/testadmin.jks -W administrator -K %SDI_SOLDIR%/serverapi/testadmin.jks -P administrator -v -op debug -c %SDI_CONFIG% -r %SDI_AL% -alc IBMDirectoryServerChangelogConnector -on
When you review the content of the <solution directory>/logs/ibmdi.log the content of the CONN,CURRENT, and WORK objects should be seen for the connectors of the mentioned assembly line.

Step 5: Using the 'Config' name identified in Step 2, disable the debug mode for all components in the running AssemblyLine 'SDS_ChgLog_AL'

%SDI_HOME%/bin/tdisrvctl -s %SDI_SOLDIR% -p %SDI_PORT% -T %SDI_SOLDIR%/serverapi/testadmin.jks -W administrator -K %SDI_SOLDIR%/serverapi/testadmin.jks -P administrator -v -op debug -c %SDI_CONFIG% -r %SDI_AL% -off

Step 5a: (optional) Using the 'Config' name identified in Step 2, disable the debug mode for specified component in the running AssemblyLine 'SDS_ChgLog_AL'

%SDI_HOME%/bin/tdisrvctl -s %SDI_SOLDIR% -p %SDI_PORT% -T %SDI_SOLDIR%/serverapi/testadmin.jks -W administrator -K %SDI_SOLDIR%/serverapi/testadmin.jks -P administrator -v -op debug -c %SDI_CONFIG% -r %SDI_AL% -alc IBMDirectoryServerChangelogConnector -off

Additional Information

* This example uses the default certificates provided in testadmin.jks to secure the connection to the SDI server. If custom certificates have been deployed in the SDI Server, make appropriate changes to the example commands.  
For additional information concerning 'tdisrvctl' please refer to 
Command Line Interface – tdisrvctl utility https://www.ibm.com/support/knowledgecenter/SSCQGF_7.2.0.3/com.ibm.IBMDI.doc_7.2.0.3/c_admin_commandline_interface_tdisrvctl_util.html
Command Line Reference
https://www.ibm.com/support/knowledgecenter/en/SSCQGF_7.2.0.3/com.ibm.IBMDI.doc_7.2.0.3/c_admin_commandline_reference.html

[{"Business Unit":{"code":"BU008","label":"Security"},"Product":{"code":"SSCQGF","label":"Tivoli Directory Integrator"},"Component":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB24","label":"Security Software"}}]

Product Synonym

SDI;TDI

Document Information

Modified date:
08 February 2019

UID

ibm10870940

Page Feedback