« Proof for Homeland security we are out of the country... | Main| Microsoft adds IM and SharePoint to hosted Exchange »

A hidden Sametime Gem

Category
Hidden away in the Sametime program directory is a little executable called STDebugTool.exe, it's not documented anywhere publicly so what does it do? Well it turns out if you've ever spoke to Lotus Support with a Sametime issue they'll sometimes have you add a a couple of lines to the Sametime.INI one is probably [Debug] and the other would be a line relating to the area you are having problems, now a few of these lines are documented in Technotes, but most of them you only ever get if you call in with an issue and Lotus want to get debug output. When these changes are implemented you end up with debug text files (sometimes very very large files) in the Trace directory below the Sametime program directory. The problem with this approach is that debug parameters in the Sametime.ini don't take effect until you reeboot. This is fine for smaller organizations, but for large organizations, taking a server down just to enable a debug parameter can be very tedious to it's users. So this is where STDebugtool.exe comes into play.

STDebugTool allows you to add some of these parameters (but not all) whilst the server is active and running. So how does it work? Well the first thing you need to do is start STDebugTool from a command prompt, this will give you a chevron > command prompt. When this is running you can now set debug parameters, but how do you know what debug parameters are accepted? Well after a bit of playing around if you type "f" (case sensitive) into the debugtool it will return a long list of possible parameters (you'll be amazed at how many there are). ? will also return some simple help.

So now that you have a debug parameter lets enable one, lets say for example you're having some issues with LDAP and you want to turn on LDAP debug. Here's what you'd do, into the stdebugtoll you would type (case sensitive) s VP_LDAP_TRACE 1 followed by enter (I assume s stands for set), you can put in multipe debug parameters. Once you have set the parameter, you can type in "r" for them to take effect (I am guessing r stands for refresh), then you can quit out of the debugtool by typing "q". These debug parameters will now take effect until you reboot the server or you change their value.

Click on more to see the 6.5.1 debug parameters that are available...

ADMMSG_TRACE
BL_Attr
BL_CHANNEL
BL_CommunityCnl
BL_CONNECTION
BL_DIRCNL
BL_GW_CHANNEL
BL_Nodes
BL_PEERS
BL_PREF_LOGIN
BL_PUSH_OBJ
BL_SCENARIO_TRACE
BL_TRACK
BL_Verbose
OD_COMMUNITY_CNL
OD_DEBUG_LOGIN_COP
OLD_RESOURCE
PLACE_ACTIVITY
PLACE_ADMIN_DEBUG
ST_AUTH_TOKEN_TRACE
ST_DDA_BROWSE_TRACE
ST_DDA_CONFIG_TRACE
ST_DDA_GROUPS_TRACE
ST_DDA_US_TRACE
ST_NL_TRACE
STLOG_STATISTICS_TRACE
UBQ
UBQ_DLL
UBQ_NDR_POOL
UCM_BUFFER
UCM_DEBUG
UCM_KERNEL
UCM_MESSAGES
UCM_NOTIFY
UCM_SELECT
UCM_SPAWN
UCM_TLS_DEBUG
VP_AUTH_ASYNC
VP_AUTH_TRACE
VP_DB_LMBCS_TRACE
VP_DB_TRACE
VP_DEBUG
VP_DEBUG_CHAT_LOGGING
VP_DTREE_TRACE
VP_LOG_TRACE
VP_LOG_TRACE_COMM_EVENTS
VP_LOG_TRACE_CONFIG
VP_LOG_TRACE_CONNECTION
VP_LOG_TRACE_PLACE_EVENTS
VP_MESSAGES
VP_NOTES_THREADS_TRACE
VP_OD_DEBUG
VP_OM_LOGGING
VP_POLLING_DEBUG
VP_POLLING_IN_MSG
VP_POLLING_MX_CNL
VP_PRIVACY_TRACE
VP_PROT_STORAGE_TRACE
VP_REG_TRACE
VP_RESOLVE_DEBUG
VP_RESOLVE_TRACE
VP_SNIFF
VP_STORAGE_CNL_TRACE
VP_STORAGE_TRACE
VP_US_TRACE
VPCONFIG_ATTR_LIST_TRACE
VPCONFIG_ATTRIBUTES_TRACE
VPCONFIG_COMMUNITYCNL_TRACE
VPCONFIG_TRACE
VPDIR_DEBUG
VPDIR_HOTFIXES_DEBUG
VPHMX_PURE_HTTP_DEBUG
VPHMX_PURE_HTTP_HEADER
VPK_DEBUG
VPLOG_BB_DEBUG
VPMX_CNL_DEBUG
VPMX_DEBUG
VPMX_HTTP_DEBUG
VPMX_MSG_DEBUG
VPMX_ROUTING_DEBUG
VPMX_TCP_DEBUG
VPPLACE_DEBUG
VPS_AUTH_DEBUG
VPS_DEBUG_CHANNEL_MSG
VPS_DEBUG_COMM_EVENTS
VPS_DEBUG_CONFIG
VPS_DEBUG_COP
VPS_DEBUG_GATEWAY_MSG
VPS_DEBUG_LOGIN_MSG
VPS_DEBUG_OTM_MSG
VPS_DEBUG_SERVICE_MSG
VPS_DEBUG_STATS_MSG
VPS_DEBUG_USER_MSG

Comments

Gravatar Image1 - Carl,
I can't wait to test this item. Very cool, thanks a lot !!
Jack

Gravatar Image2 - I guess the cat's out of the bag - this showed up in my IBM support RSS feed this morning:

http://www-1.ibm.com/support/docview.wss?rs=899&uid=swg21189604&ca=lsall


Gravatar Image3 - Cool, hopefully the next technote will explain what each parameter is ! Great that they finally published it. I think mine has a little more felsh too

Gravatar Image4 - .EXE!!

What about us using a proper platform? I often wish we didn't

Post A Comment

:-D:-o:-p:-x:-(:-):-\:angry::cool::cry::emb::grin::huh::laugh::rolleyes:;-)