Appendix I: Common Base Event format

This appendix describes the Common Base Event format specification and Common Base Event properties.

Common Base Event format specification

For details on the Common Base Event format specification, refer to the latest version of Canonical Situation Data Format: The Common Base Event v1.0.1 at www.eclipse.org/tptp.

Common Base Event Properties

This topic is a reference for the elements, the complex types and the groups defined in the Common Base Event Schema v1.0.1.

Elements

AssociationEngine
Extension of: cbe:AssociationEngineType
This element identifies the application (association engine) that establishes the association among related events. This element also defines properties that describe the type of association.
CommonBaseEvent
Extension of: cbe:CommonBaseEventType

CommonBaseEvents
Extension of: cbe:CommonBaseEventsType

Complex types

AssociatedEventType
The AssociatedEvent type allows for associated events to be grouped.  It allows for identifying 
associated events and its associationEngine.  The associationEngine MAY 
be the reference to the application that created the association.
Attribute: resolvedEvents
AssociationEngineType
The AssociationEngine identifies the application that establishes association 
among related or associated events.  In addition, it provides properties to describe the type of the association.  
The AssociationEngine is a stand-alone entity in the XML schema and the AssociatedEvents created by the 
application that is identified by the AssociationEngine refer to it.  
This will eliminate the need to repeat the same data in every associated event.
Attribute: id
Attribute: type
Attribute: name
AvailableSituation
The AvailableSituation deals with the situations reported from the component, regarding 
its operational state and availability. This situation provides a context for operations that can be 
performed on the component by distinguishing if a product is installed, operational and ready to process 
functional requests, or operational and ready/not ready to process management requests. Existing message 
include words like those that now ready to take requests, online, and offline, for example:

ADMC0013I: SOAP connector available at port 8880
ADMC0026I: RMI Connector available at port 2809
Extension of: cbe:SituationType
Content sequence:
CommonBaseEventsType
Content sequence:
CommonBaseEventType
Content sequence:
Attribute: version
Attribute: globalInstanceId
Attribute: extensionName
Attribute: localInstanceId
Attribute: creationTime
Attribute: severity
Attribute: msg
Attribute: priority
Attribute: sequenceNumber
Attribute: repeatCount
Attribute: elapsedTime
ComponentIdentificationType
This element provides the detailed information about the components
that are identified by the sourceComponentId and the reporterComponentId elements.  
				
Attribute: component
Attribute: subComponent
Attribute: componentIdType
Attribute: instanceId
Attribute: application
Attribute: executionEnvironment
Attribute: location
Attribute: locationType
Attribute: processId
Attribute: threadId
Attribute: componentType
ConfigureSituation
The ConfigureSituation deals with the components identifying their configuration. Any 
changes that a component makes to its configuration should be logged using this category. 
Additionally, messages that describe current configuration state fall into this category. 
Existing message include words like port number is, address is, and process id, for example:
ADFS0134I: File transfer is configured with host="9.27.11.13", port="9090", securityEnabled="false".
Extension of: cbe:SituationType
Content sequence:
ConnectSituation
The ConnectSituation deals with the situations that identify aspects about a connection to 
another component. Messages that say a connection failed, that a connection was created, or that a connection 
was ended all fall into this category. Existing messages include words like connection reset, connection failed, 
and failed to get a connection, for example:
DBMN0015W: Failure while creating connection {0}
DBMN0033W: connection close failure {0}
DBMN0023W: Failed to close a connection {0}
Extension of: cbe:SituationType
Content sequence:
ContextDataElementType
Attribute: name
Attribute: type
CreateSituation
The CreateSituation deals with the situations documenting when a component creates an entity. 
Messages telling that a document was created, or a file was created, or an EJB was created all fall 
into this category. Existing message include words like was created, about to create, and now exists, for example:
               
ADMR0009I: Document cells/flatfootNetwork/applications/Dynamic Cache Monitor.ear/Dynamic Cache Monitor.ear was created
Extension of: cbe:SituationType
Content sequence:
DependencySituation
The DependencySituation deals with the situations that components produce to say that they cannot find 
some component or feature that they need. This category includes messages about not finding the 'version' 
of the component that was expected. Messages that say a resource was not found, or that an 
application or subsystem that was unavailable, also fall into this category. Existing messages 
include words like could not find, and no such component, for example:
               
WSVR0017E: Error encountered binding the J2EE resource, Pet Store JMS Queue Connection Factory, 
as jms/queue/QueueConnectionFactory from resources.xml no resource binder found
Extension of: cbe:SituationType
Content sequence:
DestroySituation
The DestroySituation deals with the situations documenting when 
         an entity or component was removed or destroyed. Messages telling that a document 
         was destroyed or a file was deleted all fall into this category. Existing message 
         include words like was created, about to create, and now exists, for example:
               
CONM6007I: The connection pool was destroyed for data source (UDDI.Datasource.techs8.server1).
Extension of: cbe:SituationType
Content sequence:
ExtendedDataElementType
Content sequence:
Attribute: name
Attribute: type
FeatureSituation
The FeatureSituation deals with the situations that announce that a feature of a component 
is now ready (or not ready) for service requests. Situations that indicate things like services being 
available and services or features being unavailable fall into this category. Existing situations include 
words like now available, currently available, and transport is listening on port 123, for example:
               
SRVE0171I: Transport HTTPS is listening on port 9443 
MSGS0601I: WebSphere Embedded Messaging has not been installed
Extension of: cbe:SituationType
Content sequence:
MsgDataElementType
This element represents the data that is used to specify all of the 
related information that is associated with the message that this event holds.
				
Content sequence:
Attribute: msgLocale
OtherSituation
The OtherSituation category is to provide support for the situation that is product specific 
         requirement other than the predefined categories.
Extension of: cbe:SituationType
Content sequence:
ReportSituation
The ReportSituation deals with the situations reported from the component, 
such as heartbeat or performance information. Data such as current CPU utilization, 
current memory heap size, etc. would fall into this category. Existing messages include 
words like utilization value is, buffer size is, and number of threads is, for example:
IEE890I WTO Buffers in console backup storage = 1024
Extension of: cbe:SituationType
Content sequence:
RequestSituation
The RequestSituation deals with the situations that a component uses to 
identify the completion status of a request. Typically, these requests are complex
management tasks or transactions that a component undertakes on behalf of a requester and 
not the mainline simple requests or transactions. Existing messages include words like 
configuration synchronization started, and backup procedure complete, for example:
ADMS0003I: Configuration synchronization completed.
Extension of: cbe:SituationType
Content sequence:
Situation
The situation specifies the type of the situation that caused the event to be reported. 
This is an REQUIRED property.
				
Content sequence:
Attribute: categoryName
SituationType
Attribute: reasoningScope
StartSituation
The StartSituation deals with the start up process for a component. Messages that 
indicate that a component has begun the startup process, that it has finished the startup process, or 
that it has aborted the startup process all fall into this category. 
				
Extension of: cbe:SituationType
Content sequence:
StopSituation
The StopSituation deals with the shutdown process for a component. 
         Message that indicate that a component has begun to stop, that it has stopped, 
         or that the stopping process has failed all fall into this category. Existing messages 
         include words like stop, stopping, stopped, completed, and exiting, for example:
WSVR0220I: Application stopped: {0}
WSVR0102E: An error occurred stopping, {0}
MSGS0657I: Stopping the MQJD JMS Provider
Extension of: cbe:SituationType
Content sequence:
Attribute: situationQualifier

Groups

msgCatalogGroup
msgIdGroup

Parent topic: Stand-alone Generic Log Adapter User's Guide