Administration Guide

Local Navigation

Log files for BlackBerry Enterprise Server Express components

You can use log files to record the activity of BlackBerry® Enterprise Server Express components and troubleshoot issues with the components. The BlackBerry Enterprise Server Express creates a log file for each BlackBerry Enterprise Server Express component and saves the log files on the computer that hosts the BlackBerry Enterprise Server Express. By default, the BlackBerry Enterprise Server Express saves the log files in C:\Program Files\Research In Motion\BlackBerry Enterprise Server\Logs. Each BlackBerry Enterprise Server Express instance saves the log files in folders that it creates daily and organizes by date. To prevent the BlackBerry Enterprise Server Express log files from taking up too much disk space, you can change how BlackBerry Enterprise Server Express components create and delete log files.

The size of log files varies based on the number of users in your BlackBerry Enterprise Server Express environment and the level of user activity. It is a best practice to monitor and control the amount of disk space taken up by the BlackBerry Enterprise Server Express log files.

By default, the BlackBerry Enterprise Server Express names log files <server_name>_<component_identifier>_<instance>_<yyyymmdd>_<log_number>.txt (for example, BBServer01_MAGT_01_20070120_0001.txt). An event that the BlackBerry Enterprise Server Express writes to a log file begins with a five-digit number, where the first digit represents the logging level. For example, the following log file entry logs level 3, which are informational level events: [30000] (03/12 14:03:42.315):{0x18CC} [ENV] Computer Host Name: host_name.

Changing the location where BlackBerry Enterprise Server Express components save log files

Change the location where BlackBerry Enterprise Server Express components save log files

  1. In the BlackBerry® Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. Click Edit instance.
  4. In the General section, in the Log file path field, type the path where you want to save the log files.
  5. Click Save all.
  6. On each computer that hosts a BlackBerry® Enterprise Server Express component or BlackBerry Enterprise Server Express service, in the Windows® Services, restart the BlackBerry Enterprise Server Express services.

Store the log files for BlackBerry Enterprise Server Express components in one folder

You can store the log files for BlackBerry® Enterprise Server Express components in one folder instead of permitting the BlackBerry Enterprise Server Express to save the log files in folders that it creates daily and organizes by date.
  1. In the BlackBerry Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. Click Edit instance.
  4. In the General section, in the Create folder for daily logs drop-down list, click False.
  5. Click Save all.
  6. On each computer that hosts a BlackBerry Enterprise Server Express component or BlackBerry Enterprise Server Express service, in the Windows® Services, restart the BlackBerry Enterprise Server Express services.

Changing how BlackBerry Enterprise Server Express components create log files

Add a prefix to the file names of the log files for BlackBerry Enterprise Server Express components

  1. In the BlackBerry® Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. Click Edit instance.
  4. In the General section, in the Log file prefix field, type the prefix that you want to add to the log files.
  5. Click Save all.
  6. On each computer that hosts a BlackBerry® Enterprise Server Express component or BlackBerry Enterprise Server Express service, in the Windows® Services, restart the BlackBerry Enterprise Server Express services.

Change the maximum size of the log file for a BlackBerry Enterprise Server Express component

When the log file for a BlackBerry® Enterprise Server Express component reaches its maximum size, the BlackBerry Enterprise Server Express either creates an additional log file for the component or overwrites the current one, depending on whether you turn on log auto-roll.

By default, log auto-roll is turned on for all BlackBerry Enterprise Server Express components, which means that the BlackBerry Enterprise Server Express creates an additional log file when the current log file reaches its maximum size.

You can specify a different maximum size for each log file.

  1. In the BlackBerry Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. On the Logging details tab, click Edit instance.
  4. In each section, in the Maximum size of daily log files (MB) field, type the file size.
  5. Click Save all.
  6. On the Servers and components menu, locate and restart the components that contain the logging settings that you changed.

Change the logging level for a BlackBerry Enterprise Server Express component

You can select whether the information that you save to the log files is detailed or limited by changing the logging level for a BlackBerry® Enterprise Server Express component. A more detailed logging level can help you troubleshoot issues with a BlackBerry Enterprise Server Express component.
  1. In the BlackBerry Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. On the Logging details tab, click Edit instance.
  4. In each section, in the Log level drop-down list, click one of the following menu items:
    • To write error messages to the log files, click Error.
    • To write warning messages to the log files, click Warning.
    • To write daily activities to the log files, click Information.
    • To write additional information to the log files that can help you troubleshoot issues with your organization's environment, click Debug.
  5. Click Save all.
  6. On the Servers and components menu, locate and restart the components that contain the logging settings that you changed.

Create an additional log file for a BlackBerry Enterprise Server Express component when the current log file reaches its maximum size

If you turn on log auto-roll for a BlackBerry® Enterprise Server Express component, the BlackBerry Enterprise Server Express creates a new log file for the component when the current log file reaches the maximum size. If you turn off log auto-roll for a BlackBerry Enterprise Server Express component, the BlackBerry Enterprise Server Express overwrites the current log file for the component when the log file reaches the maximum size. By default, log auto-roll is turned on for all BlackBerry Enterprise Server Express components.

  1. In the BlackBerry Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. On the Logging details tab, click Edit instance.
  4. In each section, in the Log auto-roll drop-down list, click True.
  5. Click Save all.
  6. On the Servers and components menu, locate and restart the components that contain the logging settings that you changed.

Change the identifier of the log file for a BlackBerry Enterprise Server Express component

You can identify the log file for a BlackBerry® Enterprise Server Express component by the identifier that is included in the file name. For example, a log file that is named BBServer01_SYNC_01_20080120_001.txt uses the default component identifier SYNC to identify the BlackBerry Synchronization Service component.

  1. In the BlackBerry Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. On the Logging details tab, click Edit instance.
  4. In each section, in the Log identifier field, type a new identifier name.
  5. Click Save all.
  6. On the Servers and components menu, locate and restart the components that contain the logging settings that you changed.

Prevent a BlackBerry Enterprise Server Express component from creating a daily log file

  1. In the BlackBerry® Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. On the Logging details tab, click Edit instance.
  4. In each section, in the Daily file creation drop-down list, click False.
  5. Click Save all.
  6. On the Servers and components menu, locate and restart the components that contain the logging settings that you changed.

Configure when the BlackBerry Enterprise Server Express deletes a log file

  1. In the BlackBerry® Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. On the Logging details tab, click Edit instance.
  4. In each section, in the Maximum age of daily log files field, type the number of days that you want the BlackBerry® Enterprise Server Express to delete the log files after.
  5. Click Save all.
  6. On the Servers and components menu, locate and restart the components that contain the logging settings that you changed.

Change the character encoding of the log file for a BlackBerry Enterprise Server Express component

You can change the character encoding of the log files of a BlackBerry® Enterprise Server Express component so that the encoding supports the tools that you use to parse and examine the log files. You can specify a different character encoding for each BlackBerry Enterprise Server Express component. You can use the ANSI®, UTF-8, and UTF-16LE character encoding methods.
  1. In the BlackBerry Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that contains the logging settings that you want to change.
  3. On the Logging details tab, click Edit instance.
  4. In each section, in the Log encoding drop-down list, click one of the following character encodings:
    • ANSI
    • UTF-8
    • UTF-16LE
  5. Click Save all.
  6. On the Servers and components menu, locate and restart the components that contain the logging settings that you changed.

Restore logging settings to default values for all components

  1. In the BlackBerry® Administration Service, on the Servers and components menu, expand BlackBerry Solution topology > BlackBerry Domain > Component view > Logging.
  2. Click the instance that you want to restore to default values.
  3. On the Logging details tab, click Edit instance.
  4. Click Reset logging defaults.
  5. Click Save all.
  6. For the changes to take effect, perform any of the following actions to restart the BlackBerry® Enterprise Server Express services:
    • To restart services other than the BlackBerry Administration Service, on the Servers and components menu, locate and restart the services that you restored to default values.
    • To restart the BlackBerry Administration Service, on the computer that hosts the BlackBerry Administration Service, in the Windows® Services, restart the BlackBerry Administration Service - Native Code Container service.

Component identifiers for log files

You can identify the names for the BlackBerry® Enterprise Server Express log files using the following component identifiers:

Component identifier

Logging component

ACNV

BlackBerry Attachment Service attachment conversion

ALRT

BlackBerry Enterprise Server Alert Tool

ASCL

BlackBerry Attachment Service client

ASMN

BlackBerry Attachment Service attachment monitor

ASRV

BlackBerry Attachment Service component

BBAS-AS

BlackBerry Administration Service – Application Server

BBAS-NCC

BlackBerry Administration Service – Native Code Container

CBCK

backup connector

CMNG

management connector

CNTS

IBM® Lotus Notes® connector

ConfigTool

BlackBerry Enterprise Server Express configuration tool

CONN

BlackBerry Synchronization Connector

CTRL

BlackBerry Controller

DBNS

BlackBerry database notification service

DISP

BlackBerry Dispatcher

EXTS

extension connector

HHCG

BlackBerry Configuration Panel

MAGT

BlackBerry Messaging Agent

MAST

BlackBerry Mail Store Service

MDAT

BlackBerry MDS Connection Service

POLC

BlackBerry Policy Service

ROUT

BlackBerry Router

SYNC

BlackBerry Synchronization Service

TAT

BlackBerry Threshold Analysis Tool


Was this information helpful? Send us your comments.