Following are two lists of properties/elements of the Common Base Event specification, provided so you can use them as a quick online reference when constructing Common Base Events. This sheet is designed so if you need more information about a using a property, you can click on the section number and are whisked directly to the appropriate section of the "Common Base Event Best Practices" guide for more information on that property and the best ways to use it, including all the best practices the authors of the guide concocted and the pitfalls they ran into.
Start converting those log files!
Required properties by alphabetical order
| Element/property | Description | Section |
|---|---|---|
| Component identification: application | Specifies the human-readable "common" name of the associated business solution | 2.3.5.4 |
| Component identification: component | Identifies the manageable resource associated with the event | 2.3.5.5 |
| Component identification: componentIdType | Specifies the format and meaning of the component property | 2.3.5.6 |
| Component identification: componentType | Identifies the type of component that is identified in component/componentIdType | 2.3.5.7 |
| Component identification: executionEnvironment | Specifies the hosting environment for the component specified in the component property | 2.3.5.9 |
| Component identification: instanceId | Specifies the operational instance of the component that reports the event | 2.3.5.10 |
| Component identification: location | Specifies the physical address that corresponds to the location of a component | 2.3.5.2 |
| Component identification: locationType | Specifies the format and meaning of the value in the location property | 2.3.5.3 |
| Component identification: processId | Specifies the process identifier of the "running" process within the component that reports the event | 2.3.5.11 |
| Component identification: subComponent | Identifies the specific part of a component that is associated with the event | 2.3.5.8 |
| Component identification: threadId | Specifies the thread identifier of the "running" thread within the component that reports the event | 2.3.5.12 |
| creationTime | Specifies the time the event was created | 2.3.2 |
| reporterComponentId | Identifies the component that reported the situation | 2.3.3|More info |
| situation | Important: describes the situation that was detected | 2.3.6 |
| situation: categoryName | Categorizes the situation reported by the event | 2.3.6.1 |
| SituationType | Provides the additional data associated with each situation category | 2.3.7 |
| SituationType: AvailableSituation | Describes a component's operational state and availability | 2.3.7.9 |
| SituationType: AvailableSituation: availabilityDisposition | Specifies the availability disposition of the component associated with the event | 2.3.7.9.2 |
| SituationType: AvailableSituation: operationDisposition | Specifies whether the component associated with the event has the ability to be started | 2.3.7.9.1 |
| SituationType: AvailableSituation: processingDisposition | Specifies the processing disposition of a component operation associated with the event | 2.3.7.9.3 |
| SituationType: AvailableSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.9.4 |
| SituationType: ConfigureSituation | Identifies information about a component's configuration data and indicates changes to that data | 2.3.7.5 |
| SituationType: ConfigureSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.5.2 |
| SituationType: ConfigureSituation: successDisposition | Specifies whether the configuration situation described by the event was successful | 2.3.7.5.1 |
| SituationType: ConnectSituation | Describes aspects about a connection to another component | 2.3.7.4 |
| SituationType: ConnectSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.4.3 |
| SituationType: ConnectSituation: situationDisposition | Specifies additional information to describe the connection process | 2.3.7.4.2 |
| SituationType: ConnectSituation: successDisposition | Specifies whether the connection process described by the event was successful | 2.3.7.4.1 |
| SituationType: CreateSituation | Describes a component's attempt to create an entity | 2.3.7.10 |
| SituationType: CreateSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.10.2 |
| SituationType: CreateSituation: successDisposition | Specifies whether the create situation associated with the event was successful | 2.3.7.10.1 |
| SituationType: DependencySituation | Describes a dependency relationship between two components | 2.3.7.8 |
| SituationType: DependencySituation: dependencyDisposition | Specifies the availability status of the dependency item associated with the event | 2.3.7.8.1 |
| SituationType: DependencySituation: reasoningScope | Specifies the scope of the situation | 2.3.7.8.2 |
| SituationType: DestroySituation | Describes a component's attempt to destroy or remove an entity | 2.3.7.11 |
| SituationType: DestroySituation: reasoningScope | Specifies the scope of the situation | 2.3.7.11.2 |
| SituationType: DestroySituation: successDisposition | Specifies whether the destroy situation associated with the event was successful | 2.3.7.11.1 |
| SituationType: FeatureSituation | Announces whether a feature of a component is ready to service requests | 2.3.7.7 |
| SituationType: FeatureSituation: featureDisposition | Specifies the availability disposition of a component feature associated with the event | 2.3.7.7.1 |
| SituationType: FeatureSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.7.2 |
| SituationType: OtherSituation | Describes situations that cannot be represented in any of the defined situation categories | 2.3.7.13 |
| SituationType: reasoningScope | Specifies the scope of the situation | 2.3.7.1 |
| SituationType: ReportSituation | Conveys general information about a component | 2.3.7.12 |
| SituationType: ReportSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.12.2 |
| SituationType: ReportSituation: reportCategory | Specifies the type of data reported by the event | 2.3.7.12.1 |
| SituationType: RequestSituation | Represents the processing of a request by a component | 2.3.7.6 |
| SituationType: RequestSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.6.3 |
| SituationType: RequestSituation: situationQualifier | Specifies additional information to describe the request situation | 2.3.7.6.2 |
| SituationType: RequestSituation: successDisposition | Specifies whether the request situation described by the event was successful | 2.3.7.6.1 |
| SituationType: StartSituation | Describes a start situation | 2.3.7.2 |
| SituationType: StartSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.2.3 |
| SituationType: StartSituation: situationQualifier | Specifies additional information to further describe the start situation | 2.3.7.2.2 |
| SituationType: StartSituation: successDisposition | Specifies whether the startup process described by the event was successful | 2.3.7.2.1 |
| SituationType: StopSituation | Describes a stop situation | 2.3.7.3 |
| SituationType: StopSituation: reasoningScope | Specifies the scope of the situation | 2.3.7.3.3 |
| SituationType: StopSituation: situationQualifier | Specifies additional information to describe the stop situation | 2.3.7.3.2 |
| SituationType: StopSituation: successDisposition | Specifies whether the stop process described by the event was successful | 2.3.7.3.1 |
| sourceComponentId | Identifies the component that was affected by the situation | 2.3.3|More info |
| version | A string used to identify the version of the Common Base Event specification event | 2.3.1 |
Optional properties by alphabetical order
| Element/property | Description | Section |
|---|---|---|
| Aggregating events: elapsedTime | Indicates the time interval during which some number of identical events occurred | 2.4.6.2 |
| Aggregating events: repeatCount | Specifies the number of occurrences of identical events within a specified time interval | 2.4.6.1 |
| AssociatedEvents | Allows for associated Common Base Events to be identified and grouped together so that they can be interpreted as a group by an appropriate association engine | 2.4.11 |
| AssociatedEvents: associationEngine | Specifies the application that establishes the association among events by value or by reference | 2.4.11.1 |
| AssociatedEvents: associationEngineInfo | Specifies the reference to the AssociationEngine element | 2.4.11.2 |
| AssociatedEvents: resolvedEvents | Contains an array of globalInstanceIds that identifies those events that are associated with this event | 2.4.11.3 |
| AssociationEngine | Identifies the application (association engine) that establishes the association among related events | 2.4.12 |
| AssociationEngine: id | Specifies the primary identifier for the AssociationEngine element | 2.4.12.3 |
| AssociationEngine: name | Specifies the name of the application that creates the association | 2.4.12.1 |
| AssociationEngine: type | Describes the type of association created by this association engine | 2.4.12.2 |
| ContextDataElement | Defines the context or contexts that an event refers to | 2.4.9 |
| ContextDataElement: contextId | The actual content value for the context specified by reference | 2.4.9.4 |
| ContextDataElement: contextValue | The actual content value for the context specified by value | 2.4.9.3 |
| ContextDataElement: name | Specifies the name of the application that created the contextDataElement | 2.4.9.2 |
| ContextDataElement: type | Specifies the data type of the contextDataElement | 2.4.9.1 |
| ExtendedDataElement | Offers a standard way to extend a Common Base Event to provide supplemental information in a consistent format | 2.4.10 |
| ExtendedDataElement: children | Refers to other related ExtendedDataElement properties to specify the structured list of data elements | 2.4.10.5 |
| ExtendedDataElement: hexValue | The actual content value for the extendedDataElement specified as a hexValue | 2.4.10.4 |
| ExtendedDataElement: name | Provides a name used to identify and qualify the data contained in the ExtendedDataElement | 2.4.10.1 |
| ExtendedDataElement: type | Specifies the data type of the values for the ExtendedDataElement | 2.4.10.2 |
| ExtendedDataElement: values | The actual content value for the ExtendedDataElement specified as a value | 2.4.10.3 |
| extensionName | Communicates the nature of the content found in the ExtendedDataElement property | 2.4.5 |
| globalInstanceId | Property provides a globally unique identifier that can be used to refer to or index the specific event | 2.4.2 |
| localInstanceId | Provides a locally unique identifier that can be used to refer to or index the specific event | 2.4.1 |
| Messages: msg | Contains the human-readable text that accompanies the event | 2.4.8.2 |
| Messages: msgCatalog | The name of the message catalog that contains the locale-dependent message template | 2.4.8.8 |
| Messages: msgCatalogId | Retrieves the locale-dependent message template from a message catalog | 2.4.8.7 |
| Messages: msgCatalogTokens | An array of string values that contain substitution data used to render an internationalized message as fully formatted text | 2.4.8.10 |
| Messages: msgCatalogType | Specifies the format of the msgCatalog | 2.4.8.9 |
| Messages: msgDataElement | Provides additional information about the message | 2.4.8.3 |
| Messages: msgId | Specifies the message identifier for the event | 2.4.8.4 |
| Messages: msgIdType | Specifies the format of (how to interpret) the msgId property | 2.4.8.5 |
| Messages: msgLocale | Specifies the locale for which the message is rendered | 2.4.8.6 |
| priority | Defines the importance of the event to establish a relative order in which the event records should be processed | 2.4.4 |
| sequenceNumber | Sequences events in a logical order | 2.4.7 |
| severity | Indicates the severity level of the event from the point of view of the component that reports the event | 2.4.3 |
| Description | Name | Size | Download method |
|---|---|---|---|
| At-a-glance Common Base Event properties guide | ac-cbeproperties.html | 30KB | HTTP |
Information about download methods
Learn
- Common Base Event Best Practices Guide": You can find the "Common Base Event Best Practices Guide" with the other documentation for components of the Autonomic Computing Toolkit, either in HTML or PDF.
-
"The Common Event Infrastructure: From technical preview to production" (developerWorks, April 2005): This article provides an overview of the changes and added functions of the Common Event Infrastructure from technical preview to production release.
-
"Create a simple resource model for processing Common Base Events from a file" (developerWorks, June 2004): Learn how to create a simple resource model for processing Common Base Events that are stored in a file.
-
"Standardize messages with the Common Base Event model" (developerWorks, October 2004): This article explains how the model provides a sound base for problem determination.
-
"Meet the experts: Abdi Salahshour" (developerWorks, May 2005): Abdi Salahshour explains how the Common Base Event format lays the groundwork for true autonomic maturity.
-
"Using the Common Event Infrastructure with WebSphere Studio" (developerWorks, December 2004): This article shows how CEI solves the problem of diverse and inconsistent logging formats and infrastructures and can be used to help integrate technology for applications and solutions that need to produce and consume Common Base Events.
-
"Common Base Event logging" (developerWorks, April 2005): Learn how to configure Common Base Event logging in the Java language. This tutorial shows how.
-
"Streamline Common Base Event logging" (developerWorks, January 2006): This tutorial shows you how to streamline Common Base Event logging instrumentation in the Java programming language to reduce complexity and instrumentation code size.
- developerWorks technical events and webcasts: Stay current with the latest technology.
- developerWorks autonomic computing zone: Visit the developerWorks autonomic computing zone to expand your knowledge of automating systems.
- developerWorks blogs: Get involved in the developerWorks community.
Get products and technologies
- Autonomic Computing Toolkit: You can start your autonomic computing journey with the latest version of the Toolkit.
- Common Base Event Specification v1.0.1: This specification defines a mechanism for managing events in business enterprise applications and how to communicate events in the autonomic computing model.
- IBM trial software: Build your next development project with trial software, available for download directly from developerWorks.
Discuss
- Dave Bartlett's blog: Listen in as Dave talks about integrating autonomic computing standards and capabilities throughout every layer in a system.
Kane Scarlett is the editor of the Autonomic computing technology zone for developerWorks. His past publishing work was with such magazines as Unix Review, Advanced Systems, and the -World publications (Java-, Sun-, NC-, Linux-), as well as some little oddball journals like National Geographic Magazine.
