A Common Base Event is a common structure for an event. It defines common fields, the values that these fields can take, and the exact meanings of these values for an event.
The following table presents a summary of all the fields in the Common Base Event and their usage requirements for problem determination events.
Field name | Log events | Base specification |
---|---|---|
Version | Required | Required |
creationTime | Required | Required |
severity | Required | Optional |
Msg | Required | Optional |
sourceComponentId* | Required | Required |
sourceComponentId.location | Required | Required |
sourceComponentId.locationType | Required | Required |
sourceComponentId.component | Required | Required |
sourceComponentId.subComponent | Required | Required |
sourceComponentId.componentIdType | Required | Required |
sourceComponentId.componentType | Required | Required |
sourceComponentId.application | Recommended | Optional |
sourceComponentId.instanceId | Recommended | Optional |
sourceComponentId.processId | Recommended | Optional |
sourceComponentId.threadId | Recommended | Optional |
sourceComponentId.executionEnvironment | Optional | Optional |
situation* | Required | Required |
situation.categoryName | Required | Required |
situation.situationType* | Required | Required |
situation.situationType.reasoningScope | Required | Required |
situation.situationType.(specific Situation Type elements) | Required | Required |
msgDataElement* | Recommended | Optional |
msgDataElement .msgId | Recommended | Optional |
msgDataElement .msgIdType | Recommended | Optional |
msgDataElement .msgCatalogId | Recommended | Optional |
msgDataElement .msgCatalogTokens | Recommended | Optional |
msgDataElement .msgCatalog | Recommended | Optional |
msgDataElement .msgCatalogType | Recommended | Optional |
msgDataElement .msgLocale | Recommended | Optional |
extensionName | Recommended | Optional |
localInstanceId | Optional | Optional |
globalInstanceId | Optional | Optional |
priority | Discouraged | Optional |
repeatCount | Optional | Optional |
elapsedTime | Optional | Optional |
sequenceNumber | Optional | Optional |
reporterComponentId* | Optional | Optional |
reporterComponentId.location | Required (2) | Required (2) |
reporterComponentId.locationType | Required (2) | Required (2) |
reporterComponentId.component | Required (2) | Required (2) |
reporterComponentId.subComponent | Required (2) | Required (2) |
reporterComponentId.componentIdType | Required (2) | Required (2) |
reporterComponentId.componentType | Required (2) | Required (2) |
reporterComponentId.instanceId | Optional | Optional |
reporterComponentId.processId | Optional | Optional |
reporterComponentId.threadId | Optional | Optional |
reporterComponentId.application | Optional | Optional |
reporterComponentId.executionEnvironment | Optional | Optional |
extendedDataElements* | Note 3 | Optional |
contextDataElements* | Note 4 | Optional |
associatedEvents* | Note 5 | Optional |