BESAdmin.info - Your Technical Support Source

Yahoo Buzz Technorati Stumbleupon Reddit Myspace Digg Delicious

How to change logging level for BlackBerry Enterprise Server components


Doc ID: KB00765
Modified Date: 10-02-2009
Document Type: Support

Products

  • BlackBerry® Enterprise Server



Environment

  • BlackBerry® Enterprise Server version 4.1 and 5.0
  • BlackBerry Administration Service



Overview

For BlackBerry Enterprise Server 4.1 :

Warning: The following procedure involves modifying the computer registry. This can cause substantial damage to the Windows® operating system. Document and back up the registry entries prior to implementing any changes.

Increasing the value of DebugLogLevel registry entry on the BlackBerry Enterprise Server increases the level of details written to the debug logs. For maximum detail in the logging, change the DebugLogLevel value to 4.

The DebugLogLevel registry entry can be found in the following location:

HKEY_LOCAL_MACHINESOFTWAREResearch In MotionBlackBerryServerDebugLogFile

Registry Entry Definition
DebugLog Level

Determines the level of information that will be logged. The default level is 3. This is a hexadecimal DWORD value.

DebugLogFile

Determines where the information is logged. The default setting is C:Program FilesResearch In MotionBlackBerry Enterprise Serverdebuglog.txt

Note: Leave the debuglog.txt on the end of the path when it has been altered. If a file name does not exist, then the log will not be created.



Note: In BlackBerry® Enterprise Server version 2.0 for IBM® Lotus® Domino®, the debug log level appears as a single digit within square brackets, for example[4]. In BlackBerry Enterprise Server version 2.1 to 4.1 for IBM Lotus Domino, the debug log level appears as [40000].

The BlackBerry Server Configuration tool will allow the administrator to assign specific log levels to each module, but only up to Log Level 4. To increase this, registry entries will be required to change. Please note that increasing the logging level of a module will increase the size of the associated log files, and steps should be taken to ensure that available disk space is maintained. All of the associated Registry Keys are located :

HKEY_LOCAL_MACHINESOFTWAREResearch In MotionBlackBerry Enterprise ServerLogging Info

To increase the logging level for the BlackBerry Dispatcher, for example, the subfolder in the Registry is "Dispatcher".

Once the desired module is expanded, the keyword to locate is DebugLogLevel. This is a Hexadecimal DWORD. Double-click on the key to change the value.


For BlackBerry Enterprise Server 5.0 :

Follow the steps below to change the logging level for a specific BlackBerry server component:

  1. Login BlackBerry Administration Service console
  2. Under Servers and components, select BlackBerry Solution Topology
  3. Expand BlackBerry Domain
  4. Expand Component view
  5. Click on Logging
  6. Choose a BlackBerry server
  7. Click the Logging details tab
  8. Click Edit instance at the bottom of the page
  9. Choose Debug for the specific server component
  10. After changes have been made, click Save all

Important: Restarting certain BlackBerry Enterprise Server services will delay email message delivery to BlackBerry smartphones. For more information, see KB04789

The changes made above will take effect when the affected BlackBerry service is restarted.

If the BlackBerry Enterprise Server services cannot be restarted due to other restrictions, steps outlined below will take effect immediately. Please follow the steps below to increase the logging for BlackBerry Administration Service console:

  1. Navigate to <drive>:Program FilesResearch In MotionBlackBerry Enterprise ServerBASjbossejbserver within Windows Explorer
  2. To change logging for the BAS-Application Server enter the defaultconf directory for the BAS-Native Code Container navigate to nccconf.
  3. Make a copy of the log4j.xml file to an alternate location for back up
  4. Open the log4j.xml file with a text editing program such as Notepad
  5. Under the heading with the value <appender name="BAS.FILE" class="com.rim.bes.bas.logutility.DailyLogFileAppender"> change the following string: <param name="Threshold" value="${bas.server.file.log.level}"/> to read <param name="Threshold" value="DEBUG"/>

    Note: The DEBUG value can also be set to INFO, WARN, ERROR, FATAL, or TRACE.

    Note: If you opt to use the TRACE level logging be sure to restore the backed up log4j.xml file to prevent excessive disk space usage from trace level logging.

  6. To limit logging for a specific function or package within BAS search for the section titled "<!-- Limit loggers -->" and beneath this value add an entry in similar to the following:
    <logger name="com.rim.bes.bas.notificationmanager">
    <level value="TRACE”/>
    </logger>
  7. Save the file and perform the action generate the logs
  8. Once the log has been obtained, copy the log4j.xml which were backed up in Step 3 and overwrite the modified log4j.xml to return it to its original setting



Additional Information

For BlackBerry Enterprise Server version 4.1, the BlackBerry Enterprise Server services do not need to be restarted when changing the logging level in registry.