Using the Generic Configuration Reporter (SAP Library - Developing Applications Using Java)

Using the Generic Configuration Reporter

Use

The Generic Configuration Reporter enables you to build configuration monitors that display properties obtained from the property files stored in the database in the monitoring tree.

At the Monitoring Service startup, a resource MBean (hereafter called Generic Configuration Reporter) is created with object name com.sap.default:name=ConfigurationReporter,j2eeType=GenericConfigurationResourceMBean.This MBean provides methods with which the properties data is extracted from the database in a generic way. On top of this, configuration monitors that report data from property sheets (kept in the database) can be easily created without the need to instantiate and register resource MBeans at the server side (the role of the resource MBeans is taken by the Generic Configuration Reporter).

Procedure

To complete this procedure use the monitor-configuration.xml.

This graphic is explained in the accompanying text

The procedure emphasizes the differences between building a configuration monitor on top of the generic configuration reporter, and building it as a normal monitor relying on data supplied by a reregistered resource MBean.

The Example section shows a complete example of using the generic configuration reporter.

...

1. Create a group in the monitoring semantics section of the XML in the same way as for a standard configuration monitor.

2. Describe the configuration monitor in the monitor-tree section of the XML:

a. As the resource MBean in this case is the generic configuration reporter, the name and type of the monitored resource must be:

<monitored-resource

name="com.sap.default:name=ConfigurationReporter,j2eeType=GenericConfigurationResourceMBean"

type="MBEAN"/>

b. Specify the location of the properties file in the <observed-property-sheet> tag.

The following options are available for specifying the location:

i. You can enter the absolute path, that is, the path to the property file in the database. To do this, use the <absolute-path path="<your_path>"> tag.

Using this approach, you will receive all the global properties that are under this path.

Note

The path to the desired property file can be seen using the Configuration Adapter Service runtime. To access this service, in the NWA, choose Configuration Management → Infrastructure Management → Java Configuration Browser.

For example, the absolute path for extracting data from a service starts as follows:

cluster_data/server/cfg/services/<service_name>

Do not write Propertysheet <service_name> at the end, but only <service_name>. This requirement is valid not only for services, but for all types of property files.

ii. You can enter the name of a service whose properties you want to display. To do this, use the <service-properties service-name="<service_name>"> tag.

Using this approach, you will receive a combination of global and local variables available under this path. That is, if you have five properties and one of them is changed locally, you will get 1 local and four global properties.

Note

This can only be used if you want to monitor properties of a service.

c. If you do not want to monitor all properties but just a subset of them, specify the properties to be displayed. Do this in the <reported-properties> tag:

<reported-properties>

<name>CCMS_Mapping</name>

<name>CCMS_System_Mode</name>

</reported-properties>

If you leave the <reported-properties> tag empty, no property will be listed; but if this tag is missing, all properties from the specified file will be listed.

Example

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE monitor-configuration SYSTEM "monitor-configuration.dtd">

<monitor-configuration>

<monitor-semantics>

<simple-configuration-group name="GenericConfigurationReporter">

<description ID="Generic Configuration Reporter">Generic Configuration Reporter Example</description>

</simple-configuration-group>

<config-configuration-group name="GenericConfigurationMonitor.absolute-path">

<description ID="Generic Configuration Monitor">Generic Configuration Monitor using absolute-path</description>

<data-collection>

<polled-by-monitor period="1" unit="MINUTE"/>

</data-collection>

</config-configuration-group>

<config-configuration-group name="GenericConfigurationMonitor.service-name">

<description ID="Generic Configuration Monitor">Generic Configuration Monitor using service-name</description>

<data-collection>

<polled-by-monitor period="1" unit="MINUTE"/>

</data-collection>

</config-configuration-group>

</monitor-semantics>

<monitor-tree>

<configuration-monitor name="Generic Configuration abs.path" configuration-group="GenericConfigurationMonitor.absolute-path">

<monitored-resource name="com.sap.default:name=ConfigurationReporter,j2eeType=GenericConfigurationResourceMBean" type="MBEAN"/>

<configuration-attribute-mapping>

<configuration-attribute>

<observed-property-sheet>

<absolute-path path="cluster_data/server/cfg/element-info">

</absolute-path>

</observed-property-sheet>

</configuration-attribute>

</configuration-attribute-mapping>

</configuration-monitor>

<configuration-monitor name="Generic Configuration service-name" configuration-group="GenericConfigurationMonitor.service-name">

<monitored-resource name="com.sap.default:name=ConfigurationReporter,j2eeType=GenericConfigurationResourceMBean" type="MBEAN"/>

<configuration-attribute-mapping>

<configuration-attribute>

<observed-property-sheet>

<service-properties service-name="monitor">

</service-properties>

</observed-property-sheet>

</configuration-attribute>

</configuration-attribute-mapping>

</configuration-monitor>

</object>

</applications>

</monitor-tree>

</monitor-configuration>