Configuring Logging

You can configure Business Console logging using the verity_bconsole.xml file. Configure logging to enable easier recovery, or to create reports from logging results (using a third-party reporting tool).

Logging Types

The following log types exist in Business Console.

Status messages—always logged. All levels are enabled by default.

 

Status messages are logged on Business Console initialization, taxonomy creation, and so on.

User actions—logged only if you specify the actions.

 

User actions logged include major actions such as publish, login, training documents, and so on.

Table 1-1 lists the logging types and the levels of logging within each type.

 

Table 1-1    Logging Levels 


Log Type

Level

Description

Status

info

Logs all informational messages.

warning

Logs all warning messages.

error

Logs all error messages.

User actions

access

Logs actions such as logging in, changing user permissions, and opening taxonomies.

struct

Logs changes to the taxonomy structure, including adding a child node, changing the topic, and training a category.

docs

Logs all document manipulations, including adding documents and adding training documents.

publish

Logs all publish actions.

admin

Logs actions taken in the Administration View.


 

 
Note   Level names are case sensitive.
 

 

Status Log Format

The format for a status log is:

[<timestamp>] (level) <message>

For example:

[May 21 09:24:31.2468 -0800] (info) Business Console server started

User Action Log Format

The format for a user action log is:

"<timestamp>",<user>,<action>,[(parameters)]*

For example:

"May 21 06:23:31.2468 -0900", jsmith,login
"May 21 06:23:31.2468 -0900", jsmith,open,tax_alias

Logging Locations

The logging results are located in <dataDir>/services/<bconsole_alias>/logs by default.

You can configure your logging to change the log location by using the bc.server.logdir environment variable.

 

 
Note   The log results are automatically rolled into a daily log by the Business Console server.
 

 

Configuring the verity_bconsole.xml File

You can configure the verity_bconsole.xml file to set both the status messages and user actions logged. If you make changes to the file, restart the Verity K2 Administration Web Server service for any changes to take effect.

Log the status messages by using bc.status.tags environment variable in the verity_bconsole.xml file. To log a level, include it in the tag specification. For example, to log all status levels:

 

info|warning|error

To log only warnings and errors:

warning|error

Log the user actions by using bc.action.tags environment variable in the verity_bconsole.xml file. To specify the user actions to be logged, include the action in the tag specification. For example, to log user access, changes to access permissions, and administration actions:

 

access|admin