.




Debugging using Trace Files



The first step in troubleshooting problems is to collect the corresponding debug or trace data.



  1. In the Sametime ini, set VP_LDAP_TRACE=1 to turn on tracing.


  2. Delete any old contents of the trace folder: \Trace.


  3. Enable Sametime to start writing trace messages. View Sametime LDAP Trace Files You don’t need to recycle the whole server. You can just restart the
    server application, which is ST Users for authentication or ST Resolve for resolve, and ST Directory. Each Sametime LDAP module prints debug messages to its own
    trace file into the Domino Install Directory\Trace folder. Note: Remember to disable the debug flag immediately after gathering trace
    files: VP_LDAP_TRACE=0


  4. Cross-reference the configuration details in the trace file with the LDAP configuration data defined via the Web administration tool.


  5. In the first run on a trace file, look for keywords such as “error”, “fail”, “unable”, “Warning”, ”timed out”, and exception. View Troubleshooting
    Common Performance-related Issues
    .



Common LDAP Error Codes






















Error codes




Solution



[32] LDAP_NO_SUCH_OBJECT à Object does not exist..




  1. Using the Sametime administration tool, change the search filter settings for the LDAP server. In the Search filter for resolving person names setting, enter the search filter appropriate for the LDAP directory schema. Restart the server.


  2. Check the base DN and scope on where to start searching in the LDAP directory.



[81] LDAP_SERVER_DOWN -> cannot contact the LDAP server”.








  1. 1. Make sure you can ping LDAP Server from the Sametime Server.


  2. 2. Check with the Firewall team or Telnet to the LDAP Server on port 389 (or LDAP Port) to verify that a connection can be established.



[87] LDAP_FILTER_ERROR -> The search filter is incorrect



Using the Sametime administration tool, check the search filter settings for the LDAP server. In the Search filter for resolving person names setting, enter the search filter appropriate for the LDAP directory schema.








Using Ldapsearch utility in the troubleshooting process



Ldapsearch.exe is a built-in utility that is a part of the Domino server package.
It is an LDAP client that connects to a directory server and returns results that matches the
search criteria you specify. The utility is located in the same installation folder as Sametime.



Ldapsearch can be used in the troubleshooting process.
For example, when a Sametime process hangs or is slow to respond under a high load or a Resolve request,
you can check if the directory is alive using the ldapsearch utility to connect to the LDAP directory
and respond to an LDAP search query in a prompt manner.
This way, you can determine whether the issue is with Sametime or the LDAP server.



Usage Example 1


Search the root entry for the “namingcontexts” attribute:




	ldapsearch -h bluepages.ibm.com -b -s base (objectclass=*) namingcontexts

	

Result:



namingcontexts=CN=SCHEMA



namingcontexts=OU=IBMDIRECTORIES,O=IBM.COM



namingcontexts=OU=IBMGROUPS,O=IBM.COM



namingcontexts=OU=BLUEPAGES,O=IBM.COM



namingcontexts=CN=LOCALHOST




Usage Example 2


Look for a specific person:




	ldapsearch -h bluepages.ibm.com -b ou=bluepages,o=ibm.com -s subtree (&(objectclass=person)(John Doe))

	

Result:




	DN: uid=549305756,c=il,ou=bluepages,o=ibm.com

	...<list of attributes and values>...

	


While the LDAP server can respond immediately on some connections, other connections can be very slow and even hang. This is especially relevant for ldapsearch tests.
If ldapsearch returns immediately while the Sametime server is slow to respond, this is not decisive proof that there is a performance problem with the Sametime
server



Usually, the LDAP server simply can't handle the high load on a particular Sametime connection while performing an ldapsearch query that get
a respond within seconds.



For more information and examples of this utility, refer to Using the Ldapsearch utility:
http://www01.ibm.com/support/docview.wss?rs=2338&context=SSYSVG&dc=DA400&uid=swg27002627&loc=en_US&cs=UTF-8&lang=en&rss=ct2338lotus




Collecting pertinent information




If you plan to contact IBM Lotus Sametime Support, please collect the following information before you call.




  • Detailed use-case and scenario of the problem


  • Exact time and date when the problem occurs


  • Client type (Connect client, meeting, Notes client, etc.) and version


  • \Trace folder


  • IBM_TECHNICAL_SUPPORT folder under \Lotus\Domino\data folder on Windows


  • sametime.log


  • sametime.ini


  • StConfig.nsf


  • da.nsf – for Domino Web authentication and SSO


  • names.nsf


  • LDAP server type and info


  • LDIF of problematic user/group




Appendix




Sametime LDAP Trace Files



The trace file format name when starting version 8.0.x:

<Process_name>_<DDMMYY>_<HHMM>_<Process_Id>_<number of recycled_file>

The trace file name for the StUsers application:

StUsers_090710_1916_6668_000.txt



Trace file name for StAuthentication: (used by Stusers application)

StAuthentication_Stusers_090710_1916_6668_001.txt



Note that several different applications such as Meeting applications in addition to Sametime Stusers application use the authentication module
and use different names to distinguish the trace files of each application. Therefore, the trace file for authentication:


StAuthentication_<name_of_the_executable>_*.txt


Trace file name for StDirectory application:

StLdap_StDirectory_090805_1302_3172_000.txt



Trace file name for STResolve application and group contents:

StLdap_StDirectory_090805_1302_3172_000.txt
StLdap_StResolve_090811_1713_2392_002.txt



NOTE:
A trace file starts with printouts of the LDAP configuration parameters:



   1:  
   2:  	090921_104617INF,LDAP Res,Initialization of configuration module completed successfully
   3:  
   4:  	
   5:  
   6:  	090921_104617INF,LDAP Res,Organization []
   7:  
   8:  	
   9:  
   10:  	090921_104617INF,LDAP Res,Host: [marketing.sales.acme.com[
   11:  
   12:  	
   13:  
   14:  	090921_104617INF,LDAP Res,Reading configuration of directory server marketing.sales.acme.com
   15:  
   16:  	
   17:  
   18:  	// LDAP server host name
   19:  
   20:  	
   21:  
   22:  	090921_104617INF,LDAP Res,host name: marketing.sales.acme.com
   23:  
   24:  	
   25:  
   26:  	// LDAP server port number
   27:  
   28:  	
   29:  
   30:  	090921_104617INF,LDAP Res,port: 389
   31:  
   32:  	
   33:  
   34:  	090921_104617INF,LDAP Res,ssl port: 636
   35:  
   36:  	
   37:  
   38:  	090921_104617INF,LDAP Res,ssl: disabled
   39:  
   40:  	
   41:  
   42:  	// Number of connections
   43:  
   44:  	
   45:  
   46:  	090921_104617INF,LDAP Res,connections: 1
   47:  
   48:  	
   49:  
   50:  	090921_104617INF,LDAP Res,alias dereferencing: 0
   51:  
   52:  	
   53:  
   54:  	090921_104617INF,LDAP Res,use internal proxy: no
   55:  
   56:  	
   57:  
   58:  	090921_104617INF,LDAP Res,Directory: [] [marketing.sales.acme.com]
   59:  
   60:  	
   61:  
   62:  	// Base object when searching for person entries
   63:  
   64:  	
   65:  
   66:  	090921_104617INF,LDAP Res,base dn for searching people:
   67:  
   68:  	
   69:  
   70:  	// Search filter for resolving persons name
   71:  
   72:  	
   73:  
   74:  	090921_104617INF,LDAP Res,filter for searching people:
   75:  
   76:  	(&(objectclass=organizationalPerson)(|(cn=%s*)(givenname=%s*)(sn=%s*)(mail=%s*)))
   77:  
   78:  	
   79:  
   80:  	// Search filter to use when resolving a user name to a distinguish name
   81:  
   82:  	
   83:  
   84:  	090921_104617INF,LDAP Res,filter for searching people by unique id:
   85:  
   86:  	(&(objectclass=organizationalPerson)(|(cn=%s)(givenname=%s)(sn=%s)(mail=%s)))
   87:  
   88:  	
   89:  
   90:  	// Scope for searching for a person : rescursive
   91:  
   92:  	
   93:  
   94:  	090921_104617INF,LDAP Res,scope for searching people: 2
   95:  
   96:  	
   97:  
   98:  	// Base object when searching for group entries
   99:  
   100:  	
   101:  
   102:  	090921_104617INF,LDAP Res,base dn for searching groups:
   103:  
   104:  	
   105:  
   106:  	// Search filter for resolving groups name
   107:  
   108:  	
   109:  
   110:  	090921_104617INF,LDAP Res,filter for searching groups:
   111:  
   112:  	(&(objectclass=groupOfNames)(cn=%*))
   113:  
   114:  	
   115:  
   116:  	// Scope for searching for groups : rescursive
   117:  
   118:  	
   119:  
   120:  	090921_104617INF,LDAP Res,scope for searching groups: 2
   121:  
   122:  	
   123:  
   124:  	// The attribute of the person entry that defines the internal ID of a Sametime user
   125:  
   126:  	
   127:  
   128:  	090921_104617INF,LDAP Res,user id attribute: DN
   129:  
   130:  	
   131:  
   132:  	// The attribute of the person entry that defines the person's name
   133:  
   134:  	
   135:  
   136:  	090921_104617INF,LDAP Res,persons name attribute: cn
   137:  
   138:  	
   139:  
   140:  	090921_104617INF,LDAP Res,persons desc attribute:
   141:  
   142:  	
   143:  
   144:  	// The attribute of the person entry that defines the group's name
   145:  
   146:  	
   147:  
   148:  	090921_104617INF,LDAP Res,groups name attribute: cn
   149:  
   150:  	
   151:  
   152:  	090921_104617INF,LDAP Res,groups desc attribute:
   153:  
   154:  	
   155:  
   156:  	// The group object class used to determine if an entry is a group
   157:  
   158:  	
   159:  
   160:  	090921_104617INF,LDAP Res,object class of a group entry: groupOfNames
   161:  
   162:  	
   163:  
   164:  	090921_104617INF,LDAP Res,object class of a person entry: organizationalPerson
   165:  
   166:  	
   167:  
   168:  	090921_104617INF,LDAP Res,home server attribute:
   169:  
   170:  	
   171:  
   172:  	// Attribute of the person entry that defined the person'email address
   173:  
   174:  	
   175:  
   176:  	090921_104617INF,LDAP Res,e-mail attribute: mail
   177:  
   178:  	
   179:  
   180:  	090921_104617INF,LDAP Res,maximum number of results: 1000
   181:  
   182:  	
   183:  
   184:  	090921_104617INF,LDAP Res,directory-wide search on DN: disabled
   185:  
   186:  	



Links for Tuning LDAP Servers



Tuning Domino
http://www.ibm.com/developerworks/lotus/library/ls-perf_intro/



Tuning Tivoli directory server
http://www.redbooks.ibm.com/abstracts/redp4258.html



Tuning active directory
http://www.microsoft.com/windowsserver2003/evaluation/performance/tuning.mspx



Novell eDirectory tuning
http://www.novell.com/coolsolutions/feature/16117.html



Sun directory server
http://docs.sun.com/source/816-6697-10/tips.html#14520">http://docs.sun.com/source/816-6697-10/tips.html#14520



Tuning OpenLDAP
http://www.openldap.org/faq/data/cache/190.html



Collection of Useful Links



Following is a collection of useful links from this document:



Sametime LDAP directory settings:
http://publib.boulder.ibm.com/infocenter/sametime/v8r0/index.jsp?topic=/com.ibm.help.sametime.imlu.doc/st_adm_ldap_dir_settings_r.html



Optimizing LDAP connections and queries on a Sametime server:
http://www-01.ibm.com/support/docview.wss?uid=swg21200143



Using Java to customize Sametime LDAP settings:
http://www-01.ibm.com/support/docview.wss?rs=899&uid=swg21308532



Sametime 7.5.1.x and 8.0.x Hotfixes on Windows to reduce Resolve load on LDAP directory:
http://www-01.ibm.com/support/docview.wss?rs=899&uid=swg21384060



Sametime 8.0.2.1 running on Linux:
http://www-01.ibm.com/support/docview.wss?rs=477&uid=swg21396511



A useful source on Search Filter Syntax considerations and example:
http://msdn.microsoft.com/en-us/library/aa746475%28VS.85%29.aspx



Sametime users unable to authenticate with Domino Canonical name:
http://www-01.ibm.com/support/docview.wss?rs=477&context=SSKTXQ&dc=DB520&dc=DB560&uid=swg21293951&loc=en_US&cs=UTF-8&lang=en&rss=ct477lotus



Sametime awareness for Domino Web access
Sametime meeting error:
http://www-01.ibm.com/support/docview.wss?uid=swg21236403



Configuring Chat are awareness for Domino Web Access:
"sans-serif" size="2">h