本主题是公共基本事件模式 v1.0.1 中定义的元素、复杂类型和组的参考。
AssociatedEvent 类型用于对相关联的事件进行分组。它用于标识相关联的事件及其 associationEngine。associationEngine 可能是对创建关联的应用程序的引用。
此属性指定一个 globalInstanceId 数组,那些 globalInstanceId 对应于与此事件相关联的事件。
AssociationEngine 标识在相关或相关联的事件之间建立关联的应用程序。此外, 它还提供用于描述关联类型的属性。AssociationEngine 是 XML 模式中的独立实体, 由 AssociationEngine 标识的应用程序创建的 AssociatedEvent 将引用它。这样就不 需要在每个相关联的事件中重复同一数据。
元素的主标识。此属性必须全局唯一。此属性的建议值是 128 位或 256 位全局 唯一标识(以十六进制字符串形式表示)。一旦设置此值,就绝对不能更改它。此属性是必需的。
此属性应该包含此 AssociationEngine 创建的关联的类型。 一些定义明确的关联如下所示: - Contains - Cleared - CausedBy - MultiPart - Correlated 此属性是必需的。此属性的字符串长度一定不能超过 64 个字符。
创建关联的应用程序的名称(例如 my correlation engine name)。 此属性是必需的。此属性的字符串长度一定不能超过 64 个字符。
AvailableSituation 处理组件所报告的关于其工作状态和可用性的情况。 此情况通过区分某个产品是否已安装、可工作并已准备好处理功能请求或者可工作并 已准备好/未准备好处理管理请求,来为可以对该组件执行的操作提供上下文。现有消息 包括诸如现已准备好处理请求、联机和脱机之类的消息,例如: ADMC0013I: SOAP 连接器在端口 8880 上可用 ADMC0026I: RMI 连接器在端口 2809 上可用
此属性指定情况所报告的组件操作状态。operationalDisposition 是一个字符串,它 可以具有下面这一组值: - STARTABLE - NONSTARTABLE 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此属性指定导致情况被报告的实体或组件的可用性处置。availabilityDisposition 是一个 字符串,它可以具有下面这一组值: - AVAILABLE - NOT AVAILABLE 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此属性指定导致情况被报告的组件操作的处理处置。processingDisposition 是一个 字符串,它可以具有下面这一组值: - FUNCTION_PROCESS - FUNCTION_BLOCK - MGMTTASK_PROCESS - MGMTTASK_BLOCKED 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此元素定义此事件所引用的上下文。此复杂类型存储的数据通过使工作单元执行期间生成的 消息或事件相互相关来帮助进行问题诊断。
此元素允许指定应用程序提供的名称类型值集合,从而进行扩展。通过这种机制,可以添加 CommonBaseEvent 数据模型中未指定的其它属性。此处指定的集合被认为是特定于产品的数据。
此元素允许将相互关联的事件分组到一起并使它们与相应的关联引擎相关。
作为事件或情况“报告者”的组件的标识。如果报告组件不是源组件,则此属性是必需的。 否则,一定不能存在此字段。
目前受事件或情况影响或者曾经受事件或情况影响的组件的标识。对于受情况影响的组件来说, 此属性是必需的。
msgDataElement 是一个属性,它引用 MsgDataElement。 此属性存储的数据用来指定与此事件所存储的消息相关联的所有相关信息。 这是一个可选的不可变属性。它是由发出事件的组件提供的。
situation 是用于描述事件所报告的情况或事件的数据。situation 信息包含一组 必需特性或属性,这些属性是不同产品组和平台之间的公共属性,但是可以将它们 灵活设计,以便能够满足特定于产品的需求。situation 是 Situation 类型 的元素,它指定导致事件被报告的情况的类型。这是一个必需的不可变属性;即,一旦设置 此属性,就一定不能更改它。
任何其它数据。
用于标识此事件的版本的字符串。此字段是可选的,如果未指定此字段,就会假定 公共基本事件的版本为 1.0。如果不想使用该版本,就必须填写此字段,并且它必须与 模式头中指定的版本一致。版本的字符串长度一定不能超过 16 个字符。当应用程序创建 的事件遵循此版本的规范时,应该将此字段设置为 1.0.1。
事件的主标识。此属性必须是全局唯一的,并且可用作事件的主键。此属性是可选的。 但是,一旦设置此值,就一定不能更改它。建议值是 128 位或 256 位全局唯一标识, 并且必须以字母字符(即 a-z 和 A-Z)开头。
此事件所表示的事件类(或 XML 元素)的名称(例如 CommonBaseEvent)。此名称 指示期望该事件包含的任何其它元素。此属性是可选的。如果指定的值为 NULL,则假定值为 CommonBaseEvent。extensionName 的字符串长度一定不能超过 64 个字符。
源提供的事件标识。不保证此值是全局唯一的。此属性是可选的。localInstanceId 的字符串长度一定不能超过 128 个字符。
此属性指定此公共基本事件的创建时间。它使用 XML 模式中指定的名为 dateType 的类型。示例:2004 年 12 月 31 日中午 12:00 将是“2004-12-31T12:00:00”。
事件所描述的状态对于报告该事件的应用程序来说可以察觉到的严重性。按严重性 递增顺序排列的预定义严重性级别如下所示: * 0 “未知” * 10 对于事件仅包含一般信息而未报告错误的情况,必须使用“信息”。 * 20 对于错误事件不影响资源正常操作的情况,必须使用“无害”。 * 30 当需要让用户决定是否需要执行操作以响应事件时,必须使用“警告”。 * 40 当指示需要执行操作但情况此时并不严重时,必须使用“轻微”。 * 50 当指示需要立即执行操作并且涉及的范围很广时(可能会导致临界资源即将耗尽),必须 使用“严重”。 * 60 当指示已发生错误但执行补救操作已太晚时,必须使用“致命”。 相关联的值是 0 到 70。保留的值从 0(表示“未知”)开始并以增量 10 递增, 直到 60(表示“致命”)为止。可以添加其它严重性,但它们一定不能超过 70。 此属性是可选的。
事件随附的文本。这通常是已解析消息字符串,是以特定语言环境的人类可读格式显示的。 此属性是可选的。msg 的字符串长度一定不能超过 1024 个字符。
定义事件的重要性。预定义的优先级如下所示: * 10 低 * 50 中 * 70 高 值是 0 到 100。“低”的保留值是 10,“中”是 50,“高”是 70。 可以添加其它优先级,但它们一定不能超过 100。此属性是可选的。
源定义的编号,它允许发送和处理多条消息的逻辑顺序与消息到达使用者位置 (例如事件服务器或管理工具)的顺序不同。序号帮助使用者对到达顺序 可能有误的消息进行排序。此序号是根据消息的创建时间和特定报告者而定的。 此属性是可选的,没有缺省值。
repeatCount 指定完全相同的事件在指定时间间隔内的出现次数。时间间隔由 elapsedTime 属性指定。“完全相同的事件”的定义是特定于应用程序的,因此本规范 未对其进行定义。此属性是可选的,并且是可变的。repeatCount 可以由发出事件的 组件指定,也可以由事件使用者指定。没有缺省值。如果值为 0 或者没有值,则表示 该事件不重复出现。
此属性指定的是某个时间间隔或耗用时间,在该时间内发生的完全相同事件的 次数就是上述的 repeatCount 属性所指定的次数。如果未对 repeatCount 指定值(或者指定了零值), 则此属性是可选的,并且没有缺省值。但是,如果指定了 repeatCount(它为非零值),则 elapsedTime 是必需的。
此元素提供关于 sourceComponentId 和 reporterComponentId 元素标识的 组件的详细信息。
此属性指定组件的逻辑标识。它必须包含特定应用程序、产品或子系统的名称。 在报告者位置属性指定的作用域中,此值应该是唯一的。指定的信息的类型是在 componentIdType 属性中描述的。 注意:component、subcomponent 和 componentIdType 属性构成了一个逻辑组。 公共基本事件的生成者和使用者应该考虑这些属性之间的内部关系。
此属性为事件的逻辑组件属性指定进一步的区分。它应该包含 component 属性的 子组件的标识,并且应该是事件中指定的最详细定义,例如 ApplicationServer:mycompany.myapp.AdminConsole。 注意:此属性可以是应用程序或操作系统的各部分中的其中一个部分,如模块名、类名 以及类和方法名。
此属性指定 componentIdentificationType 元素中标识的 component 属性的格式和 含义。公共基本事件 V1.0.1 规范定义了下列组件类型: * ProductName:指示组件表示特定产品。 * DeviceName:指示组件表示设备。 * SystemName:指示组件表示系统。 * ServiceName:指示组件表示服务。 * Process:指示组件表示进程。 * Application:指示组件表示一个或多个组件的集合,在此集合中,组件是以 module.component 格式指定的,子组件是以 class.method 格式指定的。 * Unknown:指示组件不是上述类型中的任何一种类型。
此属性为 component 属性中指定的组件的实例指定句柄或标识。当一个组件在系统上 多次运行时,此属性很有用。 注意:此属性应该唯一地标识组件的特定实例。某些环境可能会为 instanceId 属性值 提供适当的构造。
此属性为应用程序指定人类可读的“通用”名称。(可选)可以在名称末尾追加应用程序 版本信息并用“#”号将它们分隔开。例如,“My application#3.2”指定了应用程序 “My application”和版本 3.2。
此属性指定 application 属性中指定的应用程序的主机环境。它标识运行应用程序 的直接环境。例如,“My application”可能位于“BaseAppServer\myNode\server1”。 可以在属性值末尾指定 executionEnvironment 的版本信息并用“#”字符将它们分隔开。 例如,“BaseAppServer\myNode\server1#5.1”。
此属性指定与组件位置相对应的物理地址。此地址可以是各种地址类型中的 其中一种,例如 IP 地址、主机名或 MAC 地址等,因此还应该指定 locationType 元素。 注意:location 地址的建议值是标准主机名。
此属性指定 location 属性值的格式和含义。定义了下列类型: * IPV4:因特网协议 V4 * IPV6:因特网协议 V6 * NWA:请参阅注解*。 * ISDN:请参阅注解*。 * ICD:请参阅注解*。 * OID-OSI:请参阅注解*。 * Dial:请参阅注解*。 * HWA:请参阅注解*。 * HID:请参阅注解*。 * X25:请参阅注解*。 * DCC:请参阅注解*。 * SNA:请参阅注解*。 * IPX:请参阅注解*。 * E.164:请参阅注解*。 * Hostname:主机系统的名称 * FQHostname:主机系统的标准名称 * Devicename:设备的名称 * 注:请参阅分布式管理任务组(DMTF)的公共信息模型(CIM)中的定义,网址为 http://www.dmtf.org/standards/cim。
此属性是一个字符串,它指定生成了事件的正在运行的组件或子组件的进程标识。 该值是特定于平台的。threadId 属性可以与 processId 属性结合使用以进一步描述 组件或子组件。
此属性是一个字符串,它指定 proessId 属性指定的组件或子组件的线程标识。 正在运行的进程可以衍生一个或多个线程以执行其功能。从而 threadId 将相应地更改。 注意:如果使用 processId 和 threadId,通常从主机环境或平台获取它们。
此属性描述给定类型的组件的所有实例的特征。componentType 是一个字符串,它 包含由名称空间限定的名称(类似于 XML QName),该名称包含可选的前缀和本地部分, 并且可以选择用冒号将这两部分分隔开。 提示:此属性并非用于组件的唯一标识,而是,它标识了组件(或资源)的类型, 该类型可以用作附加限定符以便标识组件的实例名称并为其建立作用域。
ConfigureSituation 处理标识自身配置的组件。组件对其配置所作的任何更改 都应该使用此类别进行记录。此外,描述当前配置状态的消息也归入此类别。现有消息 包括诸如“端口号”、“地址”和“进程标识”之类的消息,例如: ADFS0134I: 已配置文件传输,主机=“9.27.11.13”,端口=“9090”,启用安全性=“false”。
此属性指定:对于那些导致情况被报告的情况操作,是否进行了成功处置。 successDisposition 是一个字符串,它可以具有下面这一组值: - SUCCESSFUL - UNSUCESSFUL 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
ConnectSituation 所处理的情况标识了与另一个组件连接的各个方面。 指示连接已失败、已创建连接或者连接已结束的消息全都归入此类别。现有消息 包括诸如连接已复位、连接已失败和无法获取连接之类的消息,例如: DBMN0015W: 创建连接 {0} 时失败 DBMN0033W: 关闭连接 {0} 失败 DBMN0023W: 无法关闭连接 {0}
此属性指定:对于那些导致情况被报告的情况操作,是否进行了成功处置。 successDisposition 是一个字符串,它可以具有下面这一组值: - SUCCESSFUL - UNSUCESSFUL 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此属性指定情况处置,该情况处置表示描述该情况所必需的参数。 situationDisposition 是一个字符串,它可以具有下面这一组值: - INUSE - FREED - CLOSED - AVAILABLE 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
创建了此上下文数据元素的应用程序的名称。 此属性是必需的。此属性的字符串长度一定不能超过 64 个字符。
contextValue 属性的数据类型。此属性是必需的。此属性的字符串长度一定不能超过 64 个字符。
CreateSituation 处理一些记录组件创建实体时间的情况。指示已创建 文档、已创建文件或者已创建 EJB 的消息全都归入此类别。现有消息包括诸如“已创建”、 “将要创建”以及“现在已存在”之类的消息,例如: ADMR0009I: 已创建文档单元格/flatfootNetwork/应用程序/Dynamic Cache Monitor.ear/Dynamic Cache Monitor.ear
此属性指定:对于那些导致情况被报告的情况操作,是否进行了成功处置。 successDisposition 是一个字符串,它可以具有下面这一组值: - SUCCESSFUL - UNSUCESSFUL 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
DependencySituation 处理组件生成的一些情况,这些情况指示那些组件找不到 它们所需的某个组件或功能部件。此类别包括指示找不到所需组件“版本”的消息。 指示找不到资源或者应用程序或子系统不可用的消息也归入此类别。现有消息包括 诸如“找不到”和“没有此类组件”之类的消息,例如: WSVR0017E: 将 J2EE 资源“Pet Store JMS 队列连接工厂”绑定为 resources.xml 中的 jms/queue/QueueConnectionFactory 时遇到如下错误:找不到资源绑定程序
此属性指定导致情况被报告的组件功能部件的依赖性处置。 featureDisposition 是一个字符串,它可以具有下面这一组值: - MET - NOT MET 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
DestroySituation 所处理的情况记录了实体或组件何时被除去或破坏。 指示文档已被破坏或文件已被删除的消息全都归入此类别。现有消息包括诸如 “已创建”、“将要创建”以及“现在已存在”之类的消息,例如: CONM6007I: 数据源的连接池已被破坏(UDDI.Datasource.techs8.server1)。
此属性指定:对于那些导致情况被报告的情况操作,是否进行了成功处置。 successDisposition 是一个字符串,它可以具有下面这一组值: - SUCCESSFUL - UNSUCESSFUL 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此扩展数据元素的值数组是以指定类型(不包括 hexBinary)的字符串形式表示的。 hexBinary 值必须使用 hexValue 属性定义。hexValue 与 values 属性是互斥的。在 这些属性中,只应该定义其中一个属性。此属性是可选的。此属性的字符串长度一定 不能超过 1024 个字符。
hexValue 是字符数组,它存储未包括在上述受支持类型中的任何其它数据类型或 complexType 的数据。hexValue 与 values 属性是互斥的。在这些属性中,只应该 定义其中一个属性。此属性是可选的。
children 属性引用其它 ExtendedDataElement 以指定 ExtendedDataElement 一个结构化 列表。此列表使您能够创建与特定一组 CommonBaseEvent 相对应的相关 ExtendedDataElement 层次结构。因此,这是一种快速高效的相关 ExtendedDataElement 列表访问方法,而不必浏览和检查所有 ExtendedDataElement。此属性是可选的, 并且是可变的。
扩展数据元素的名称。此名称对于 extendedDataElement 层次结构中同一级别的 其它字段来说必须是唯一的,但是,在不同级别或是不同的层次结构中可以存在同名的子代。 此属性是必需的。此属性的字符串长度一定不能超过 64 个字符。
values 属性中指定的值的数据类型。有效类型列示如下。ExtendedDataElement 类型的有效数据类型只有这些。缺省值是“string”。此属性是必需的。此属性的 字符串长度一定不能超过 64 个字符。
FeatureSituation 所处理的情况指示了组件的功能已经为服务请求作好 准备(或尚未作好准备)。指示诸如服务可用以及服务或功能不可用之类的情况都 归入此类别。现有情况包括诸如“现在可用”、“当前可用”以及“传输正在侦听 端口 123”之类的消息,例如: SRVE0171I: 传输 HTTPS 正在侦听端口 9443 MSGS0601I: 尚未安装 WebSphere 嵌入式消息传递
此属性指定导致情况被报告的组件功能的可用性处置。featureDisposition 是一个 字符串,它可以具有下面这一组值: - AVAILABLE - NOT AVAILABLE 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此元素表示一些数据,这些数据用来指定与此事件所存储的消息相关联的所有相关信息。
此属性表示一个字符串数组,那些字符串被用作替换值以将国际化消息解析为格式化文本。 替换值的顺序由数组元素的隐式顺序所暗示。如果没有替换值,则不需要指定 msgCatalogTokens。 此属性是可选的。msgCatalogTokens 属性的字符串长度一定不能超过每个标记 256 个字符。
显示此 msg 属性时使用的语言环境。它的值是符合 IETF RFC 1766 的语言环境代码。此属性是可选的。
OtherSituation 类别的作用是支持具有除预定义类别以外的特定于产品的需求的情况。
ReportSituation 处理从组件报告的情况,如脉动信号或性能信息。 诸如当前 CPU 利用率和当前内存堆大小等数据都归入此类别。现有消息包括诸如 “利用率值”、“缓冲区大小”以及“线程数”之类的消息,例如: IEE890I 控制台备份存储器中的 WTO 缓冲区大小 = 1024
此属性指定所报告的情况的类别。reportCategory 是一个字符串,它可以具有下面这一组值: - PERFORMANCE - SECURITY - HEARTBEAT - STATUS - TRACE - DEBUG - LOG 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
RequestSituation 处理组件用来标识请求的完成状态的情况。通常,这些 请求是组件代表请求者执行的复杂管理任务或事务,而不是普通的简单请求或事务。 现有消息包括诸如“配置同步已启动”和“备份过程已完成”之类的消息,例如: ADMS0003I: 配置同步已完成。
此属性指定:对于那些导致情况被报告的情况操作,是否进行了成功处置。 successDisposition 是一个字符串,它可以具有下面这一组值: - SUCCESSFUL - UNSUCESSFUL 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此属性指定一些请求限定符,这些请求限定符表示描述该情况所必需的参数。 situationQualifier 是一个字符串,它可以具有下面这一组值: - REQUEST INITIATED - REQUEST COMPLETED 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
Situation 指定导致事件被报告的情况的类型。此属性是必需的。
situationType 指定导致事件被报告的情况的类型。请参阅 SituationType 定义以了解 详细信息。此属性是必需的。
categoryName 指定导致事件被报告的情况的类型。categoryName 是一个字符串, 它可以具有下面这一组值:
此属性指定所报告的情况的影响范围。此表后面描述了一组初始值。 此属性是必需的。此属性的字符串长度一定不能超过 64 个字符。
StartSituation 处理组件的启动过程。指示组件已开始启动过程、已完成启动过程 或者已中止启动过程的消息全都归入此类别。
此属性指定:对于那些导致情况被报告的情况操作,是否进行了成功处置。 successDisposition 是一个字符串,它可以具有下面这一组值: * SUCCESSFUL * UNSUCESSFUL 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此属性指定一些情况限定符,这些情况限定符表示描述该情况所必需的参数。 situationQualifier 是一个字符串,它可以具有下面这一组值: * START INITIATED * RESTART INITIATED * START COMPLETED 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
StopSituation 处理组件的关闭过程。 指示组件已开始停止、已停止或者停止过程已失败的消息全都归入此类别。现有消息 包括诸如“停止”、“正在停止”、“已停止”、“已完成”和“正在退出”之类的 消息,例如: WSVR0220I: 应用程序 {0} 已停止 WSVR0102E: 停止 {0} 时发生了错误 MSGS0657I: 正在停止 MQJD JMS 提供程序
此属性指定:对于那些导致情况被报告的情况操作,是否进行了成功处置。 successDisposition 是一个字符串,它可以具有下面这一组值: - SUCCESSFUL - UNSUCESSFUL 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此属性指定一些情况限定符,这些情况限定符表示描述该情况所必需的参数。 situationQualifier 是一个字符串,它可以具有下面这一组值: - STOP INITIATED - ABORT INITIATED - PAUSE INITIATED - STOP COMPLETED 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
此属性指定一些情况限定符,这些情况限定符表示描述该情况所必需的参数。 situationQualifier 是一个字符串,它可以具有下面这一组值: - STOP INITIATED - ABORT INITIATED - PAUSE INITIATED - STOP COMPLETED 这是必需属性,一旦设置此属性,就一定不能更改它。此属性的字符串长度一定不能超过 64 个 字符。
消息的索引或标识,它用于解析消息目录中的消息文本。 此属性是可选的。此属性的字符串长度一定不能超过 64 个字符。
msgCatalogType 属性指定 msgCatalog 的含义和格式。当前非互斥的保留关键字列表包括: - Java - XPG 此属性是可选的,一旦设置此属性,它就不可变。msgCatalogType 属性的字符串长度 一定不能超过 32 个字符。
消息目录的限定名,该消息目录包含 msgCatalogId 指定的已翻译消息。 此属性是可选的。msgCatalog 的字符串长度一定不能超过 128 个字符。
指定事件的消息标识。此标识应该是由字母数字字符或数字字符组成的唯一值字符串。 它可以象消息目录中用于标识消息的数字字符串那样简单,也可以是由字母数字字符 组成的多部分字符串(例如 DBT1234E)。 此属性是可选的。msgId 的字符串长度一定不能超过 256 个字符。
指定 msgId 的含义和格式。如果 msgId 符合或表示标准的或熟知的约定,则它由此属性指定。 示例包括:IBM3.4、IBM4.4、IBM3.1.4、IBM3.4.1、IBM4.4.1 和 IBM3.1.4.1。 非互斥保留关键字包括: - IBM* (* 在上面描述) - JMX - DottedName - Unknown 此属性是可选的。msgIdType 的字符串长度一定不能超过 32 个字符。