blackberry.com
BlackBerry Dynamics
Runtime library for iOS applications
from the application developer portal

BlackBerry Dynamics runtime activity log

Introduction

The processing activity of the BlackBerry Dynamics runtime is logged, by the runtime itself. The contents of the activity log may be requested for diagnostic purposes, by the BlackBerry Dynamics technical support team. This is typically only necessary for complex support issues.

The activity log can be written to:

The log is only written to the console if detailed logging is allowed by policy.

The log consists of a sequence of messages about runtime activity. Log messages are divided into a number of categories in the activity logging system. These categories can be used to configure the activity log.

See also:
System administration tasks for application developers links for how to change policy settings.

Log Message Categories

Each message in the activity logging system is assigned to one of the following categories.

Errors
Critical failures.
Warnings
Failures that arose but from which the runtime has recovered.
Info
Normal operational activity.
Detailed
Additional diagnostic information used for troubleshooting complex problems.

The activity logging system can be configured not to print some or all of its messages, based on the above categories. In the default configuration, messages in the Errors, Warnings, and Info categories are printed; messages in the Detailed category aren't printed.

Each logging location is configured differently and independently. The developer configures the console log and the enterprise administrator configures the container log.

Console Log Configuration

The console log is only printed if detailed logging is allowed by policy. The policy setting that controls detailed logging can be changed in the enterprise management console.

The categories of message that will be printed to the IDE console are configured in the build targets of the application project. Different targets can have different activity logging configurations. Configuration can be carried out in the IDE. There are two ways to set the configuration.

Whichever way the configuration is set, changes to console logging are effective the next time the target is built and run. Changes to console logging have no affect on the container log.

Detailed Logging

To set a target's activity logging configuration to print all messages, including messages in the Detailed category:

  1. Open the application Info.plist file*.
  2. Add a row with GDConsoleLogger as its key.
  3. Set String as the type of the new row.
  4. Set GDFilterNone as the value of the new row.

(*In case there are multiple Info.plist files, check that the correct one has been edited by opening the Info tab of the application target being built. The row just added should appear there.)

Next time the target is built and run, the console will include all log messages.

Selective Logging

To set a target's activity logging configuration to print a selection of message categories:

  1. Open the application Info.plist file*.
  2. Add a row with GDConsoleLogger as its key, or change the existing row as follows.
  3. Set Array as the type of the logger row.
  4. For each category that is to be omitted from the console log, add a row under the new row, as an item in the row's array.
  5. Set String as the type of the item row.
  6. Set one of the following as the value of the item row:
    • GDFilterDetailed
    • GDFilterInfo
    • GDFilterWarnings
    • GDFilterErrors
    • GDFilterAll

(*In case there are multiple Info.plist files, check that the correct one has been edited by opening the Info tab of the application target being built. The settings just made should appear there.)

Next time the target is built and run, the console will include log messages that aren't in any of the listed categories.

Container Log Configuration

The categories of message that are printed to the container log file is configured in the BlackBerry Dynamics management console. Access to the management console is required to set this configuration. See the on-line help and other documentation for instructions.

Detailed category-by-category configuration is not available for the container log file.

Changes to container logging are effective immediately if the application is running and connected to the BlackBerry Dynamics proxy infrastructure. Otherwise, changes are effective as soon as the application does connect. Changes to container logging have no effect on the console log.

Note that the application can cause the container log to be uploaded. See the startUpload documentation.