Location and use of log files for Universal Device Service modules

Article ID: KB29852

Type: Support Content

Last Modified: 09-27-2013

 

Product(s) Affected:

  • Universal Device Service
Jump to: Environment | Overview
CollapseEnvironment
  • Universal Device Service 6.0 to 6.2
  • BlackBerry Enterprise Service 10 version 10.0 to 10.1
  • BlackBerry Device Service
CollapseOverview

Log Locations

The Universal Device Service modules create log files which can be used for troubleshooting issues. Logs for the Core, Communication, and Scheduler modules are created as Comma-Separated Values (CSV) files, which can be opened as a spreadsheet or using a plain text editor; logs for Web Services, Console Module and Installer are in plain text.

By default, the log files created are found at the following locations:

  • Web Services
    • UDS 6.x - C:\Program Files (x86)\Research In Motion\Universal Device Service\Logs\BWS
    • BES10 version 10.x - C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\Logs\BWS
  • Communication Module
    • UDS 6.x - C:\Program Files (x86)\Research In Motion\Universal Device Service\Logs\Comm
    • BES10 version 10.x - C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\Logs\Comm
  • Core Module
    • UDS 6.x - C:\Program Files (x86)\Research In Motion\Universal Device Service\Logs\Core
    • BES10 version 10.x - C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\Logs\Core
  • Administration Console Module
    • UDS 6.x - C:\Program Files (x86)\Research In Motion\Universal Device Service\Logs\GUI
    • BES10 version 10.x - C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\Logs\RIM.UDS.GUI
    • Additional logs for Console Module (Catalina, localhost_access, commons-daemon, host-manager log) can be found at the following paths:
      • UDS 6.x - C:\Program Files (x86)\Research In Motion\Universal Device Service\RIM.BUDS.Gui\logs
      • BES10 version 10.x - C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\RIM.BUDS.Gui\logs
  • Installer
    • UDS 6.x - C:\Program Files (x86)\Research In Motion\Universal Device Service\Logs\Installer
    • BES10 version 10.x - C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\Logs\Installer
  • Scheduler
    • UDS 6.x - C:\Program Files (x86)\Research In Motion\Universal Device Service\Logs\Scheduler
    • BES10 version 10.x - C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\Logs\Scheduler
  • BlackBerry Secure Connect Service
    • C:\Program Files (x86)\Research In Motion\BlackBerry Enterprise Service 10\Logs\<DATE>\XXXXBSCYYY.log

Logging Levels

Logging is accomplished via the Log4Net library. For more information, see the Log4Net homepage.

The following log levels can be configured for the some of the logs listed above. During logging, the level at which the event was captured will be documented in the log file in order to quickly assess event severity.

  • Off - No events will be logged.
  • Fatal - Very severe error events which will likely lead to application failure. This is the default LevelMax threshold.
    • Example: Failure to connect to required resource.
  • Error - Error events which are not expected to lead to application failure.
    • Example: Operational errors.
  • Warn - Potentially harmful events.
    • Example: Authentication failure.
  • Info - General status messages for application operations.
    • Example: Console login.
  • Debug - Detailed information regarding application operations. This is the default LevelMin threshold.
  • Trace - Very detailed information regarding application operations. Should only be used when investigating an issue with BlackBerry Technical Support Services.
  • All - All events will be logged.

Change Log level

To change the logged level for Core, Communication, or Scheduler module, follow these steps:

  1. Navigate to C:\Program Files (x86)\Research In Motion\BlackBerry Universal Device Service\
  2. Double-click on the desired module (Core, Communication, or Scheduler).
  3. Open the Web.config file for Core or Communication module, and RIM.BUDS.Service.exe.config for Scheduler in a plain-text editor such as Notepad.
  4. Locate the filter block within the file.

    Example:
    <filter type="log4net.Filter.LevelRangeFilter">
    <param name="LevelMin" value="DEBUG" />
    <param name="LevelMax" value="FATAL" />
    </filter>
  5. Modify the values for LevelMin and LevelMax to reflect the desired logging level. For example, setting LevelMin to INFO will provide normal operation logging without the fine detail provided by DEBUG.
  6. Save and Close the file.

To change the logged level for the Administration Console, follow these steps:

  1. Navigate to C :\Program Files (x86)\Research In Motion\Universal Device Service\RIM.BUDS.Gui\webapps\ROOT\WEB-INF\classes
  2. Open the log4j.config file in a plain-text editor such as Notepad.
  3. Locate the log4j.rootCategory line within the file.

    Example:
    log4j.rootCategory=INFO, stdout, file
  4. Update the first parameter for rootCategory, to reflect the desired logging level.
  5. Save and Close the file.
  6. Restart BlackBerry Administration Console Windows service.

To change the logging level for BlackBerry Web Services, follow these steps:

  1. Navigate to C:\Program Files (x86)\Research In Motion\BlackBerry Universal Device Service\BWS\server\default\conf
  2. Open the jboss-log4j.xml in a plain-text editor such as Notepad.
  3. Locate the <!- Limit BWS loggers -> and <!- Limit BWSUtil loggers -> sections within the file:

    Example:
    <!- Limit BWS loggers ->
    <logger name="com.rim.bes.bas.bws">
    <level value="DEBUG"/>
     <appender-ref ref="BWS.FILE"/>
    </logger>
    <!- Limit BWSUtil loggers ->
    <logger name="com.rim.bes.bas.bwsutil">
    <level value="DEBUG"/>
     <appender-ref ref="BWS.FILE"/>
    </logger>
  4. Modify the value for level value to reflect the desired logging level.
  5. For example, setting level value to DEBUG will provide normal operation logging without the fine detail provided by TRACE.
  6. Save and Close the file.

To change the logging level for BlackBerry Secure Connect Service, follow these steps:

  1. Open regedit and navigate to HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Research In Motion\BlackBerry Enterprise Service\Logging Info\BSCAdapter
  2. Change the DebugLogLevel value to 3 (INFO) or 4 (DEBUG)
  3. Restart the BlackBerry Secure Connect service under Windows services.

Disclaimer

By downloading, accessing or otherwise using the Knowledge Base documents you agree:

   (a) that the terms of use for the documents found at www.blackberry.com/legal/knowledgebase apply to your use or reference to these documents; and

   (b) not to copy, distribute, disclose or reproduce, in full or in part any of the documents without the express written consent of RIM.


Visit the BlackBerry Technical Solution Center at www.blackberry.com/btsc.