Page tree
Skip to end of metadata
Go to start of metadata

This topic provides examples of information that you might find in a log:

The following example contains a LOG EVENT message that occurred on August 07, 2012, at 11:22:14 A.M. with a severity level of CONFIG from an InstallationTask source class:
(Click the image to expand it.)

The general format of all the log messages in the text file format is:

(<timeOfEvent>),<severityOfEvent>,<sourceOfEvent>,<eventMessageContent>

The severity levels from highest to lowest value are:

  • SEVERE (appears in red)
  • WARNING (appears in yellow)
  • INFO
  • CONFIG
  • FINE
  • FINER
  • FINEST

The following table describes the main log message types:

Message type

Description

LOG EVENT

Describes the following types of information:

  • The start and end of installation tasks (installer logic and behavior) and installation panels
  • The setting of installation properties. These properties can be set and controlled by the platform, or they can be set based on user input fields.
  • General informative data. The structure and content within the description text varies across products.

PROGRESS EVENT

Describes how much of a task is completed. These messages correspond to progress bar updates and the localized resource keys that are used to determine messages on the progress bar.

THROWABLE EVENT

Describes failures with stack traces

Summary section

Provides a summary at the end of the log that contains the same type of data shown on the installation summary panel (for example, whether the installation was successful or unsuccessful, and if unsuccessful, what features failed to install)

Example LOG EVENT messages

The following examples show LOG EVENT messages.

  • The start and end of installation tasks (installer logic and behavior) and installation panels
    (Click the image to expand it.)

    This type of message tells you which tasks ran and when they ran. For example, suppose an installation contains several features that you can select to install. Each task encapsulates logic about one feature, so you can see one or multiple tasks that hold all of the logic related to each feature.
  • The setting of installation properties
    (Click the image to expand it.)

    This type of message supplies the user inputs and variables from the properties that control the infrastructure of the overall installer. A subset of the properties relate to the user inputs entered during the installation.
  • General informative data
    (Click the image to expand it.)

    This type of message describes significant actions that occurred during the installation (for example, important executables that were invoked, significant changes that occurred, and the starting or stopping of Windows services).

Example PROGRESS EVENT message

The following example shows an example PROGRESS EVENT message:
(Click the image to expand it.)

This type of message identifies the progress of tasks. A task encapsulates a chunk of related logic. Some tasks execute logic that can run for hours. Progress messages give a relative measure of how much of a task has been completed. If no progress messages occur for a long period of time, it might indicate that an installation has stopped responding.

Example THROWABLE EVENT message

The following example shows an example THROWABLE EVENT message:
(Click the image to expand it.)

This type of message records exception stack traces. For example, suppose an installation runs 100 SQL commands against a database and halfway through the installation, the database goes down. These messages provide runtime information about the exception that occurred.

Example summary section

The following example shows an example summary:
(Click the image to expand it.)

This type of message appears at the end of an installation, upgrade, or uninstallation. It gives a log-file equivalent of the final summary panel, indicating whether the overall installation succeeded, failed, or finished with warnings. It provides a quick summary of whether the installed product is in a working or broken state.