Monitoring, Logging & Profiling

iSQL: Built-in Interactive SQL Console

The interactive SQL console enables users to query the database, besides exporting the results in a variety of formats. The iSQL console is available by default, however System Administrators can limit the console's accessiblity by configuring the appropriate envirionment variable. For more information, see: Application Configuration via Environment Variables.

Figure: Example Interactive SQL Query and Results

iSQL: Test Performance

To test the performance of your database you can use the [Test Performance] button, the Number of runs the test makes can be modified.

Figure: Example Test Performance and Results

Configuring System Logging

Codebeamer uses Apache Log4j for logging. While the default logging levels are carefully selected, sometimes the defaults do not provide enough information for tracking down a more complex problem in CodeBeamer.

Codebeamer administrators can now change these log4j settings without restarting their codebeamer server. This is done by the Change Logging Configuration page accessible from the System Admin menu.

Figure: Change Logging Configuration

Usage:

To change some classes/packages log4j settings, paste the new log settings in the Logging changes textbox, using the same syntax as found in the installdir/tomcat/common/classes/log4j.properties file. Do not modify the log4j.properties file, instead change logging levels only through this System Admin ► Change Logging Configuration menu.

For example the:

log4j.logger.com.intland.codebeamer.controller.admin.LoggingConfiguratorController=INFO

This configuration parameter will change the LoggingConfigurationController's logger to INFO level.

Multiple log4j settings can be changed at once; just put them in multiple lines similar to the log4j.properties file.

Rollover:

Rollover archives the log files, and creates new ones to continue logging, see more here. Rollover happens based on the log4j configuration, by default every day - effectively separating the logs of different days. These archive files are kept based on the CB_LOGFILE_TTL environment variable, or for 90 days by default.

Configuring Groove Script Logging

Codebeamer uses Apache Log4j for logging. Groovy scripts by default have no logging at all. Users' script must have an active logger setup and write INFO, or DEBUG messages to it. You have to know the Logger ID (for Java class, this is typically the canonical class name), for scripts this can be anything.

Once you enabled logging in your custom Groovy Script either with INFO or DEBUG level, the log messages will appear in the cb.txt logfile, for example:

2020-05-07 06:24.21,021 INFO event.impl.CustomScriptExecutor - responsible user found BOUJMIG [WorkflowActionManager-79] [2424] {}
2020-05-07 06:24.21,022 INFO event.impl.CustomScriptExecutor - end of of custom action <starc_cust_act_map_System_resp.groovy> [WorkflowActionManager-79] [2424] {}

Now, enable Custom Script DEBUG Logging on codebeamer side as well. Go to System Admin ► Logging Configuration page and add the following to the Logging Configuration:

log4j.logger.com.intland.codebeamer.event.impl.CustomScriptExecutor=DEBUG

Reproduce the issue and capture the necessary logs. Once all done don't forget to reset Custom Script Logging level back to INFO by entering:

log4j.logger.com.intland.codebeamer.event.impl.CustomScriptExecutor=INFO

Monitoring Server Resources: Memory Usage, Thread Count and Database Connections

From codeBeamer 9.3, a You must login to see this link. Register now, if you have no user account yet. application is available for monitoring codebeamer server resources.

Warning emails about low available disk space

Codebeamer has a built in functionality that periodically checks the free disk space where the codebeamer instance is running, and if the disk space goes "low" then it sends an email to System Administrators.

The goal is to avoid running out of disk space, due that it can cause serious problems and data loss.

Low disk periodic check works as follows:

• It checks if the disk space is below 10 Gigabytes or below 5% of total disk space of the disk where codebeamer is installed.
• If either of the above happens, System Administrators will receive a warning email, with the following content::
  
• This warning email is sent once per day to avoid spamming the System Administrators.

"interactive" : {
    "warnLowDiskSpace" : {
        "emailTo" : "administrator@example.com",
        "enabled" : true,
        "minFreeDisk" : 90000,
        "minPercentage" : 50,
        "emailFrequency" :
    }
},
"diskSpaceVolumes" : {
    "name" : "linux",
    "path" : "/dev/nvme0n1p6",
    "threshold" : 90000
},

The attributes of the warnLowDiskSpace section are:

diskSpaceVolumes (CB 10.0)

Multiple disk volumes can be monitored with this property. It has to be used with warnLowDiskSpace together.

The attributes of the diskSpaceVolumes section are:

Example for Windows:

"diskSpaceVolumes" : [ {
    "name" : "diskC",
    "path" : "C:\\",
    "threshold" : 10240
  }, {
    "name" : "diskE",
    "path" : "E:\\",
    "threshold" : 20480
  }, {
    "name" : "diskF",
    "path" : "F:\\"
  } ],

Example for Linux:

"diskSpaceVolumes" : [ {
    "name" : "disk1",
    "path" : "/dev/sda1",
    "threshold" : 10240
  }, {
    "name" : "disk2",
    "path" : "/dev/sda2",
    "threshold" : 20480
  }, {
    "name" : "disk3",
    "path" : "/dev/sda3"
  } ],