Logger Gadget

The Logger gadget in Openspace logs messages that are returned from the browser, for diagnostic use. You can retain these messages by saving them to a log file.

See ’Working with the Logger Gadget’ in the TIBCO Openspace User’s Guide.

The following table describes the logging properties in the OSProperties.properties file.

Property Description 
log
 Controls where the logging data is sent. The options are:
  • 0 - Logging is switched off. This is not recommended as it means no logging data is being captured.
  • 1 - Send the logging data to the BPM Runtime Appender. This means logging is captured on the BPM server. (For information on logging appenders, see Logging Appenders .)
  • 2 - Send the logging data to the standard output device. This displays logging information on the Logger gadget in Openspace.
  • 3 - Send the logging data to a log file generated by OpenSpace.
  • 4 -Send the logging data to the standard error queue.

    Default: 1 

showUserName
 Controls whether the username of the Openspace session is displayed in log messages. Can be true or false.

Default: true 

propogateStackTraceToClient
 Controls whether the full stack trace information should be passed to the client if an exception occurs. Can be true or false.

Default: true

Note: Although the spelling of this property should have been propagateStackTraceToClient, this is the spelling in the OSProperties.properties file.
The following properties are only applicable if you have set log to 3. 
daysLogKept
 Controls how many days the log file generated by OpenSpace is kept before it is automatically purged. Values of zero or less have special meanings:

daysLogKept=0 means switch off client-side logging.

daysLogKept=<0 means switch to using the server-side com.tibco.openspace logging appender, as follows:

daysLogKept=-1   log to the appender at [INFO] level

daysLogKept=-2   log to the appender at [DEBUG] level

daysLogKept=-3   log to the appender at [TRACE] level

Default: 7 

openspaceClientLogPrefix
 Defines the prefix attached to the name of the log file generated by OpenSpace, if daysLogKept is set to a value greater than zero. The name is in the form:

<openspaceClientLogPrefix>Datestamp-Count-DayOfYear.log

Default: openspace-

This prefix would give filenames like this one: 

openspace-29-Nov-2011.0.333.log
 
switchLog
 Controls how long an individual OpenSpace log file is written to before a new log file is started. The measurement is in milliseconds. For example:

switchLog=3600000      Start a new log file every hour.

Values of zero or less have special meanings. A value of zero means start a new log file daily, close to midnight. A negative value means start a new file at the specified number of milliseconds after midnight each day. For example:

switchLog=0                    Start a new file each day at midnight.

switchLog=-21600000   Start a new log file each day at 06:00.

Default: 0