Metrics Mapping into CBE Format

This topic describes how the monitoring agent uses the Common Base Event (CBE) format in to write the event objects described in this section. This section is not intended to repeat information on CBE specifications, which are publicly available.

See Also
About Metrics
About Setting Up the Monitoring Agent

For each event that is collected by a probe run by the monitoring agent, a corresponding <CommonBaseEvent ...> ... </CommonBaseEvent> XML tag containing all related information is written to the output CBE file.

The severity attribute in the events generated by the Monitoring Agent has the following possible values:

If the event has a metric named status
  • If the status metric value is 0: severity=10 (which maps the CBE severity "Information". It means there is no issue).
  • If the status metric value is 1: severity=50 (which maps to CBE severity "Critical". It means there is a severe issue).
If the event has no status metricseverity=10

Example of CBE Mapping

The following is an example of how event objects are mapped into CBE format:

< CommonBaseEvent priority = "0"
   repeatCount="0" 
   severity="10" 
   creationTime = "2014-03-23T19:11:45" 
   msg = "" 
   version = "1.0.1" 
   elapsedTime="0"> 
   < extendedDataElements name = "version" type="string"> 
      < values > 6.217.0.12083 </ values > 
   </ extendedDataElements > 
   < extendedDataElements name = "freemem" type="string">
      < values > 38101392</values> 
   </ extendedDataElements > 
   < extendedDataElements name = "totalmem" type="string">
      < values > 40239104</values> 
   </ extendedDataElements > 
   < extendedDataElements name = "period" type="string"> 
      < values > 300</values> 
   </ extendedDataElements > 
   < extendedDataElements name = "modeName" type="string">
      < values > production</values> 
   </ extendedDataElements > 
   < sourceComponentId processId = "11489" 
      subComponent="" 
      component="healthCheck"
      location="10.1.3.247" 
      threadId="" 
      componentIdType="ProductName"
      locationType="IPV4" 
      instanceId="monitoring_agent" 
      componentType="ProductName"/> 
   < situation categoryName = "ReportSituation"> 
      < situationType reportCategory = "STATUS" 
         reasoningScope="INTERNAL" 
         xsi:type="ReportSituation"/> 
   </ situation > 
</ CommonBaseEvent >

The msg attribute contains an optional human readable message for this event.

Each extended... attribute has a name and a value. The name corresponds to a metric suffix name. In our example, we have an attribute name version with a value of 6.219.0.12083, so the actual metric name corresponding to this extended attribute is healthCheck.version.

The component attribute of the sourceComponentId element contains the metric name. In our example, we have a component name with the value healthCheck.

The instanceId attribute of the sourceComponentId element contains the probe instance name. In our example, we have an instanceId attribute with a value of monitoring_agent.

The value of CBE attributes and tags which are not documented in this section may change and therefore must not be used for the purpose of integrating the monitoring agent's output CBE file into a customer's monitoring solution.