thinkWork @ komalk : Managed Mapper

Syslog Module: Enhanced

Komal — Sat, 06 Oct 2007 01:25:00 GMT

Now that we are aware of the internals of syslog module, internals of managed discovery data mapper module, this blog-post aims at providing an example of how various modules in OM 2007 can be connected, configured and leveraged for various purposes.

Let us define the health of a host such that any syslog message generated by it with a severity less than 4 indicates something bad. So, how do we make this happen in OM 2007? We would first need a managed type. So, lets define that:

</ClassType>

Now, that we have this managed type, we need a discovery rule to submit various discovery instances of it. Let's add that to our demo MP too.

<Category>Discovery</Category>

</DiscoveryTypes>

</Discovery>

The data source module 'Demo.Syslog.Discovery.ModuleType' used above would basically be a combination of 2 modules: Syslog and Discovery Data Mapper. The syslog receiver module outputs syslog data which has the hostName element which is used by discovery data mapper module to convert it into discovery data for 'Demo.Syslog.IP' class type. See attached MP for details.

Now, that instances are available in OM 2007, they can be viewed by creating a state view targeted towards the new type 'Demo.Syslog.IP' defined. The attached MP already defines one in a new folder 'Syslog Views' and so importing it into an existing installation of OM 2007 should suffice.

Next is addition of a monitor type and monitor to compute the health of the ''Demo.Syslog.IP' class type. For computation of the state, we would need information about the last message generated by the host. Let us add a few more properties to the class type then:

</ClassType>

Discovery data submitted by the discovery data mapper module will retreive information of the above extra fields from syslog message itself. We define the monitor type 'Demo.Syslog.MonitorType' to do a comparison such that the last facility value is greater than or equal to a least facility value, and that the priority name value matches a regular expression, and so on. See the attached MP for more details.

Now, that such a monitor type is defined, let us see how we use this to define a monitor associated with the 'Demo.Syslog.IP' class type.

<Category>Alert</Category>

<AlertOnState>Error</AlertOnState>

<AlertSeverity>Error</AlertSeverity>

...

</AlertParameters>

</AlertSettings>

</OperationalStates>

<LastFacility>$Target/Property[Type="Demo.Syslog.IP"]/LastFacility$</LastFacility>

<LastSeverity>$Target/Property[Type="Demo.Syslog.IP"]/LastSeverity$</LastSeverity>

<LastPriority>$Target/Property[Type="Demo.Syslog.IP"]/LastPriority$</LastPriority>

<LastPriorityName>$Target/Property[Type="Demo.Syslog.IP"]/LastPriorityName$</LastPriorityName>

<LastTimeStamp>$Target/Property[Type="Demo.Syslog.IP"]/LastTimeStamp$</LastTimeStamp>

<IP>$Target/Property[Type="Demo.Syslog.IP"]/IP$</IP>

<LastMessage>$Target/Property[Type="Demo.Syslog.IP"]/LastMessage$</LastMessage>

</Configuration>

</UnitMonitor>

In the above monitor definition, we also specified an alert to be generated when the state of an entity goes unhealthy. The above configuration means generate an alert and compute the state of an entity of class type 'Demo.Syslog.IP' as unhealthy when

the facility is less than 0 or
severity is less than 4 or
priority is less than 0 or
priority name/time stamp/host name/message doesn't match the regular expression ".*".

Overrides are defined for these threshold values which can be modified in the authoring pane of OM 2007 Console.

To summarize, the attached DEMO MP once imported into the system enables syslog listening on root management server and creates instances of various host names it discovers. At the same time, it computes health of each host which can be overridden using overrides for the 'Demo.Syslog.MonitorType' monitor type.

Discovery Data Managed Mapper

Komal — Fri, 27 Apr 2007 06:37:00 GMT

The aim of this posting is to explain with examples how discovery data can be created out of any other data-item produced by modules and be submitted to OpsMgr.

Let us assume that we have an application that acts as a server for various agents deployed in our system. We would like to collect information about various agents that contact the server and run monitoring rules against them. These agents need to be modeled as a class whose instances/objects identify various agents.

The class could be defined in Management Pack (MP) as follows:

</ClassType>

Table 1: Sample Class

As can be seen above, class MyAgent has one key Property ‘AgentID’ of type int and 5 non-key properties of type string: AgentName, AgentVersion, AgentOwner, LastMessageReceived and Comments.

To submit instances (discovery data) for this class, we would have the following section in MP:

<Category>Discovery</Category>

</DiscoveryTypes>

</Discovery>

</Discoveries>

</Monitoring>

Table 2: Sample Data Generator

The above text in MP tells that there would be a discovery rule running targeted towards System.Computer that would generate instances of type ‘MyAgent’. These instances would be submitted to the system by an instance of AgentDataGenerator module.

A discovery rule expects DiscoveryData. Therefore, output of AgentDataGenerator module should be System!System.Discovery.Data and nothing else. If we have a module that outputs a different type, how do we convert it to DiscoveryData/instance of MyAgent?

Let’s look at our module first.

<Assembly>ServerAssembly</Assembly>

<Type>ServerNamespace.MyServer</Type>

</Managed>

</ModuleImplementation>

<OutputType>AgentData</OutputType>

</DataSourceModuleType>

Table 3: Sample Module

From the above definition looks like AgentExplorer is implemented as class MyServer in namespace ServerNamespace in ServerAssembly and it outputs AgentData. AgentData being defined as follows:

<Assembly>ServerAssembly</Assembly>

<Type>ServerNamespace.AgentData</Type>

</Implementation>

</DataType>

Table 4: Sample Data

AgentData is implemented as AgentData in ServerAssembly. AgentData would definitely be inheriting from DataItemBase defined in Microsoft.EnterpriseManagement.HealthService.dll. As a result of this inheritance, AgentData would also provide serialization/deserialization of the contents into/from xml.

Let’s assume the xml representation (serialized version of the datatype) looks like below:

<Name>Sample Agent</Name>

<Name>AgentOwner1</Name>

<Name>AgentOwner2</Name>

</OwnerInfo>

<Message>Client 0 pinging server.</Message>

</AgentData>

Table 5: Sample Data (Serialized)

Now, let us look as to how we can connect the above module to a managed discovery data mapper module and generate discovery data. In short, we would be defining the module from table 2.

<Configuration /

</ProbeAction>

</MemberModules>

</Node>

</Composition>

</Composite>

</ModuleImplementation>

<OutputType>System!System.Discovery.Data</OutputType>

</DataSourceModuleType>

Table 6: Sample Discovery Data Generator

Now, let us look at configuration for DiscoveryMapper module (defined in above table) closely. (Schema is defined in a previous blog posting).

<DiscoveryType>AddUpdate</DiscoveryType>

<SourceObjectId>$MPElement$</SourceObjectId>

<SourceManagedEntityId>$Target/Id$</SourceManagedEntityId>

<Property ID="IDValue">//AgentData/ID</Property>

<Property ID="NameValue">//AgentData/Name</Property>

<Property ID="VersionValue">concat(//AgentData/MajorVersion, “.”, //AgentData/MinorVersion)</Property>

<Property ID="OwnerValue">//AgentData/OwnerInfo/Name</Property>

<Property ID="MessageValue">//AgentData/Message</Property>

</Evaluate>

</Properties>

<TypeId>$MPElement[Name="MyAgent"]$</TypeId>

<Name>$MPElement[Name="MyAgent"]/AgentID$</Name>

<Value>IDValue</Value>

</Property>

<Name>$MPElement[Name="MyAgent"]/AgentName$</Name>

<Value>NameValue</Value>

</Property>

<Name>$MPElement[Name="MyAgent"]/AgentVersion$</Name>

<Value>VersionValue</Value>

</Property>

<Name>$MPElement[Name="MyAgent"]/AgentOwner$</Name>

<Value>OwnerValue[0]</Value>

</Property>

<Name>$MPElement[Name="MyAgent"]/LastMessageReceived$</Name>

<Value>MessageValue</Value>

</Property>

<Name>$MPElement[Name="MyAgent"]/Comments$</Name>

<Value>No Comments!</Value>

</Property>

</Properties>

</ClassInstance>

</ClassInstances>

</Detailed></ManagedEntity>

Table 7: Configuration for Generic Data Mapper

The TimeGenerated element specifies the time stamp associcated with discovery data.

DiscoveryType element can be AddUpdate/Snapshot/Remove based on kind of discovery operations performed.

DiscoverySourceType element specified source of discovery data submitted to the system. In the sample case, it’s a rule. However, discovery data can be submitted via task/user/system as well.

SourceId is also required besides the DiscoverySourceType. $MPElement$ retrieves the Id of rule in which it is being used.

SourceManagedEntityId is managed entity Id of the target in this case, which is System!System.Computer.

The Properties element section in configuration allows to evaluate a bunch of xpath expressions from serialized data item (e.g., see table 5). The evaluation can be conditional as well. The ‘If’ attribute requires an xpath expression whose evaluates to a non-empty string will cause the included properties to be evaluated. There can be multiple Evaluate element sections. The mapper would build a list of property elements (as permitted by the ‘Evaluate/if’ attribute) referenced by an ID associated with xpath expressions. Xpath functions are permitted. (See VersionValue). ID can refer to a list as well here (See OwnverValue).

Explanation for PropertySets element is not required for this sample case.

The ClassInstances section allows creation of multiple class instances based on evaluation of ‘If’ attribute. If the ‘If’ attribute permits, then instance for specified ‘TypeId’ will be created. The Properties associated with it are defined as name-value pairs. Name takes an Id to the property of the class whose value needs to be populated. The Value element can take values either from configuration, values from propertyID’s defined earlier (see IDValue, NameValue, etc), values hard-coded (See Comments) and values from a member of ID referencing a list (See AgentOwner).

Also, make note of Optional attribute defined on Property element (See Comments). When set to true, the mapper would not include that particular property in submission list if the value evaluates to an empty string.

RelationshipInstances can be discovered similarly. See schema for more info.

See all the pieces combined together in attached MP.

Schema for Discovery Data Managed Mapper

Komal — Thu, 26 Apr 2007 01:45:00 GMT

Following is the schema of configuration for discovery data managed mapper module.

<xsd:complexType name="PropertyInclusion">

<xsd:sequence>

<xsd:element name="Name" type="xsd:string" />

<xsd:element name="Value" type="xsd:string" />

</xsd:sequence>

<xsd:attribute name="Optional" type="xsd:boolean" use="optional" />

<xsd:attribute name="GenNewInstance" type="xsd:boolean" use="optional" />

</xsd:complexType>

<xsd:complexType name="DiscoveryMapperConfigType">

<xsd:choice>

<xsd:element name="Simple">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="TimeGenerated">

<xsd:complexType>

<xsd:simpleContent>

<xsd:extension base="xsd:string">

<xsd:attribute name="IsXpath" type="xsd:boolean" />

<xsd:attribute name="UseCurrent" type="xsd:boolean" use="optional" />

</xsd:extension>

</xsd:simpleContent>

</xsd:complexType>

</xsd:element>

<xsd:element name="XmlBlob">

<xsd:complexType>

<xsd:simpleContent>

<xsd:extension base="xsd:string">

<xsd:attribute name="IsXpath" type="xsd:boolean" />

</xsd:extension>

</xsd:simpleContent>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

<xsd:element name="Detailed">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="TimeGenerated">

<xsd:complexType>

<xsd:simpleContent>

<xsd:extension base="xsd:string">

<xsd:attribute name="IsXpath" type="xsd:boolean" />

<xsd:attribute name="UseCurrent" type="xsd:boolean" use="optional" />

</xsd:extension>

</xsd:simpleContent>

</xsd:complexType>

</xsd:element>

<xsd:element name="DiscoveryType">

<xsd:simpleType>

<xsd:restriction base="xsd:string">

<xsd:enumeration value="Snapshot" />

<xsd:enumeration value="AddUpdate" />

<xsd:enumeration value="Remove" />

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

<xsd:element name="DiscoverySourceType">

<xsd:simpleType>

<xsd:restriction base="xsd:string">

<xsd:enumeration value="Rule" />

<xsd:enumeration value="Task" />

<xsd:enumeration value="User" />

<xsd:enumeration value="System" />

</xsd:restriction>

</xsd:simpleType>

</xsd:element>

<xsd:element name="SourceObjectId" type="xsd:string" />

<xsd:element name="SourceManagedEntityId" type="xsd:string" />

<xsd:element name="Properties">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Evaluate" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Property" minOccurs="1" maxOccurs="unbounded">

<xsd:complexType>

<xsd:simpleContent>

<xsd:extension base="xsd:string">

<xsd:attribute name="ID" type="xsd:string" />

</xsd:extension>

</xsd:simpleContent>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

<xsd:attribute name="If" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

<xsd:element name="PropertySets">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Set" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Property" minOccurs="1" maxOccurs="unbounded" type="PropertyInclusion" />

</xsd:sequence>

<xsd:attribute name="ID" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

<xsd:element name="ClassInstances">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="ClassInstance" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="TypeId" type="xsd:string" />

<xsd:element name="Properties">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Property" minOccurs="0" maxOccurs="unbounded" type="PropertyInclusion" />

<xsd:element name="PropertySet" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:attribute name="Name" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

<xsd:attribute name="If" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

<xsd:element name="RelationshipInstances">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="RelationshipInstance" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="TypeId" type="xsd:string" />

<xsd:element name="SourceTypeId" type="xsd:string" />

<xsd:element name="TargetTypeId" type="xsd:string" />

<xsd:element name="SourceProperties">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Property" minOccurs="0" maxOccurs="unbounded" type="PropertyInclusion" />

<xsd:element name="PropertySet" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:attribute name="Name" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

<xsd:element name="TargetProperties">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Property" minOccurs="0" maxOccurs="unbounded" type="PropertyInclusion" />

<xsd:element name="PropertySet" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:attribute name="Name" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

<xsd:element name="Properties">

<xsd:complexType>

<xsd:sequence>

<xsd:element name="Property" minOccurs="0" maxOccurs="unbounded" type="PropertyInclusion" />

<xsd:element name="PropertySet" minOccurs="0" maxOccurs="unbounded">

<xsd:complexType>

<xsd:attribute name="Name" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

<xsd:attribute name="If" type="xsd:string" />

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:sequence>

</xsd:complexType>

</xsd:element>

</xsd:choice>

</xsd:complexType>

</SchemaType>