im logging
modifies Windchill RV&S logging levels
Synopsis
im logging [--category=value] [--debug] [--level=value] [--off] [--on] [--target=value] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]]
Description
im logging modifies Windchill RV&S logging levels.
In addition to modifying the logger.properties file, you can use the im logging command to increase or decrease logging levels for several different categories (as outlined below). You can run this command from a client or server machine, and use it to set client or server side logging. Any category included in the logger.properties file can be used. For example:
im logging --target=client --category=DEBUG --level=5
changes debug logging on the client to level 5.
|
|
• The client and server do not need to be restarted after making changes.
• Logging changes last only until the Windchill RV&S Server or Windchill RV&S Client is restarted.
• You need the DebugServer permission in the mks:im ACL to run this command.
• server.log logs information about this command when it runs.
• HLL API has been deprecated from Integrity Lifecycle Manager version 12.0. Therefore, the option --category=HLL does not work.
|
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• --category=value
where value specifies the category name. Possible values are:
◦ DEBUG
Logs debug messages. Note: This command overrides the settings in , but only until the Windchill RV&S Server is restarted. Additionally, this option does not explicitly log debug exceptions. To log exceptions, open logger.properties, uncomment mksis.logger.exception.includeCategory.DEBUG, and set the value to 10.
◦ SQL
Logs all SQL commands to server.log. For example, if you view an issue, the SELECT statement is logged. When editing an issue, the INSERT, UPDATE, and SELECT statements are logged. --level=5 logs all SQL commands. --level=10 adds additional information such as Rollback time.
If SQL logging is enabled on the Windchill RV&S Server, you can set SQL logging levels for specific users. Setting the logging level can assist in isolating specific user commands and improving server performance. For example, if logging levels are high and server performance is impacted, reducing logging levels may improve performance.
To set SQL logging levels for a user, type:
im/si --diag=sqllogging username logginglevel
where
username is the user ID of the user whose commands you want to log.
logginglevel is one of the following number or text values: high(0), medium (5), low (10), or off (-1)
For example, typing:
im diag --diag=sqllogging jriley high
logs all workflow and document SQL commands for the user jriley to the category SQL-jriley.
◦ CACHE
Logs cache operation information. Levels 0–3 are not verbose. Levels 4–15 are verbose.
◦ SMTP
Logs communication between the Windchill RV&S Server and SMTP server.
◦ IM-NOTIFICATION
Logs e-mail notification.
◦ ACL
Logs permission checking to server.log. For example, the add label command logs the following:
2007-08-16 13:45:17,140 INFO [mksis.Windchill RV&SServer] ACL(5): Check user administrator for permission CreateProject against acl mks:im. Resolved ACL: mks:im Decision: GRANTED
◦ TRANSACTION
Logs all transactions performed by a specific user, for example, im logging --category=TRANSACTION-jdoe --on logs all transactions performed by jdoe. To log all cache transactions, type TRANSACTION-system
◦ SILIB
Similar to TRANSACTION, this option logs more information about a single command performed by a user, for example, im logging --category=SILIB-jdoe --on.
◦ SICIAGENT
Provides communications between functionality for workflows and documents, and configuration management, and communications between the Windchill RV&S Client and Windchill RV&S Server.
◦ REALM
Logs NT realm information.
◦ API
Logs Windchill RV&S API information.
◦ LDAP
Logs LDAP security scheme information.
• --debug
is equivalent to --category=DEBUG.
• --level=value
where value specifies the log level (-1 disables logging, 10 logs all messages)
• --off
is equivalent to --level=-1 (no reporting in this category).
• --on
is equivalent to --level=10 (logs all messages in this category).
• --target=value
specifies the target the debugging is enabled for. Valid values for --target are client, server, and proxy. The default value for --target is server.
See Also
