BEA Logo BEA Log Central Release 5.0

  Corporate Info  |  News  |  Solutions  |  Products  |  Partners  |  Services  |  Events  |  Download  |  How To Buy

 

   Log Central Doc Home   |   Configuration Guide   |   Previous Topic   |   Next Topic   |   Contents   |   Index

Log Central Message and Message Definition Formats

 

A Log Central message consists of a message header and a message body. A message definition is associated with a message based on the message ID and subsystem values in the message header. The following sections provide detailed descriptions of the Log Central message and message definition formats:

Example of a Log Central Message and Message Definition

Message Header

Log ID

Logging Level

Date and Time

Subsystem

Message ID

Host

Process ID

User ID

Function

Entity

Message Body

Message Definition

Summary

Severity

Description

Recommendation

Execute on Upload

Trap ID

Trap Enabled

Auto Acknowledge

For information about how Log Central constructs a log message, see Construction of Log Messages in Overview.

 


Example of a Log Central Message and Message Definition

The following figure shows the fields that are in a Log Central message.

Figure A-1 Log Central Message Fields

The following figure shows the fields that are in a Log Central message definition.

Figure A-2 Log Central Message Definition Fields

 


Message Header

The following sections describe the fields in a message header:

Log ID

Logging Level

Date and Time

Subsystem

Message ID

Host

Process ID

User ID

Function

Entity

For more information about message headers, see IL_SM_LOG_TABLE: Message Header Definition in Database Schema.

Log ID

Description:

Value that distinguishes one set of log messages from another, which lets logically separate log information be stored in one database. For example, the log IDs IRX and DCS might distinguish messages logged by a drug claim system from those logged by a document control system.

Format:

String

Size:

Up to 3 characters

Optional?:

Optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_LOG_ID

Logging Level

Description:

Logging level

Format:

Character

Size:

1 character

Range:

Possible values:

Optional?:

Not optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_REP_MODE

Date and Time

Description:

Month, day, hour, minute, second, and year on the machine that generated the message.

Format:

Mmm dd hh:mm:ss yyyy

Optional?:

Not optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_KEY_TS

Subsystem

Description:

Subsystem that generated the message. The subsystem_create and subsystem_delete commands, which are described in Commands, let you add and delete subsystems.

Format:

String

Size:

Up to 8 characters

Optional?:

Not optional. In a message definition file, this field must be in the first definition, and is optional for the succeeding definitions.

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_SS_NAME

Message ID

Description:

Identifies the type of message within a subsystem. Together, the Subsystem and Message ID uniquely identify a message.

Format:

Integer

Range:

1 through 99999

The convention for message ID values is:

Optional?:

Not optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_ID

Host

Description:

Network host for the system that generated the message. This value can include dots, underscores, and dashes.

Format:

String

Size:

Up to 64 characters

Optional?:

Not optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_HOST_NAME

Process ID

Description:

PID of the process that generated the message.

Format:

Integer

Range:

1 through 99999

Optional?:

Not optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_PID

User ID

Description:

User ID of the process that generated the message.

Format:

String

Size:

Up to 8 characters

Optional?:

Not optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_UID

Function

Description:

Internal function that generated the message. The convention for function values is:

Format:

String

Size:

Up to 40 characters

Optional?:

Optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_FCT_NAME

Entity

Description:

Value that helps correlate a message with messages from other managed nodes. You can use this value to define a domain. The domain can be a Tuxedo domain or WebLogic Enterprise domain, but is not required to be one of these types of domains. The default value is "None."

For example, if a system has three managed nodes and each managed node has a Log Monitor with an entity name of LogMonWLE, these Log Monitors constitute a domain.

For another example, if you have a Tuxedo domain for sales information, you can set the entity name to "Sales" for each Log Monitor in the domain.

For information about setting and using the entity value, see Creating Filters, and the section DEFINE_LOG_MONITOR in Configuration Files.

Format:

String

Size:

Up to 21 characters

Optional?:

Optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_TRAN_KEY

 


Message Body

Description:

Text determined by the application developer.

Format:

String

Size:

Up to 2000 characters

Optional?:

Not optional

Corresponding Field:

In the IL_SM_LOG_TABLE database table: MSG_TEXT

 


Message Definition

The following sections describe the fields in a message definition:

Summary

Severity

Description

Recommendation

Execute on Upload

Trap ID

Trap Enabled

Auto Acknowledge

For more information about message definitions, see:

Summary

Description:

Summary of the Description field which describes the condition or event that the message is reporting.

Format:

String

Size:

Up to 40 characters

Optional?:

Not optional

Corresponding Fields:

In a message definition file: SUMMARY

In the IL_MSG database table: LOG_SDESC

Severity

Description:

Possible values:

Format:

String

Size:

N/A

Optional?:

Not optional. In a message definition file, this field must be in the first definition, and is optional for the succeeding definitions.

Corresponding Fields:

In a message definition file: SEVERITY

In the IL_MSG database table: LOG_MSG_SEVERITY

Description

Description:

Description of the condition or event that the message is reporting.

Format:

String

Size:

With the Recommendation field, up to 2 Gb.

Optional?:

Optional

Corresponding Fields:

In a message definition file: DESCRIPTION

In the IL_MSG database table: LOG_MSG_DESC_REC

Recommendation

Description:

Recommended action for handling the message.

Format:

String

Size:

With the Description field, up to 2 Gb.

Optional?:

Optional

Corresponding Fields:

In a message definition file: RECOMMENDATAION

In the IL_MSG database table: LOG_MSG_DESC_REC

Execute on Upload

Description:

Path to a script or executable file that the Central Collector runs when it stores the message in the Log Central database.

Format:

String

Size:

Up to 40 characters

Optional?:

Optional

Corresponding Fields:

In a message definition file: EXECUTE_ON_UPLOAD

In the IL_MSG database table: LOG_MSG_PARSE_FNC

Trap ID

Description:

Basic SNMP trap to generate for the message. For information about generating basic SNMP traps, see "Configuring SNMP Traps" in the Log Central Online Help.

Format:

Integer

Range:

1 through 99999

Optional?:

Optional

Corresponding Fields:

In a message definition file: TRAP_ID

In the IL_MSG database table: LOG_MSG_TRAP_ID

Trap Enabled

Description:

Flag that indicates whether or not to generate a basic SNMP trap for the message. For information about generating basic SNMP traps, see "Configuring SNMP Traps" in the Log Central Online Help.

Format:

String

Range:

YES

NO (default)

Optional?:

Optional

Corresponding Fields:

In a message definition file: TRAP_ENABLED

In the IL_MSG database table: LOG_MSG_TRAP_ENABLED

Auto Acknowledge

Description:

Flag that indicates whether or not to automatically acknowledge the message. One reason to acknowledge messages is to keep track of the system problems that are currently being resolved or actively investigated.

Format:

String

Range:

YES

NO (default)

Optional?:

Optional

Corresponding Fields:

In a message definition file: AUTO_ACKNOWLEDGE

In the IL_MSG database table: LOG_MSG_AUTO_ACK