Show TOC Start of Content Area

Background documentation Frequency Configuration Group  Locate the document in its SAP Library structure

Use the following method to create a frequency configuration group and to add it to the whole set of groups:

public boolean createFrequencyConfigurationGroup(String groupName, String descriptionID, String description, int dataCollectionType, int periodValue, int periodUnit, int reactOnCollectionFailure, int green2Yellow, int yellow2Red, int yellow2Green, int red2Yellow, int historyaAveragingMode, String unit, int alertRelevantValueType);

The following parameters are available:

·        groupName – the name of the group. The length of this string must not exceed 40 characters, otherwise this group will not be sent to the CCMS.

·        descriptionID – description IDs must be unique. The length of the string must not exceed 30 characters.

·        description – a brief explanation about this group

·        dataCollectionType – defines the way the data is retrieved from the resource.

There are two possibilities :

¡        Passive reporting (the resource is triggered by timer) – in this case, use com.sap.engine.interfaces.monitor.MonitorConstants.POLLED_BY_MONITOR

¡        Active reporting (the resource sends notifications) – in this case, use com.sap.engine.interfaces.monitor.MonitorConstants.PUSHED_BY_RESOURCE

·        periodValue – if dataCollectionType is POLLED_BY_MONITOR, this parameter defines the period value of polling data. If dataCollectionType is PUSHED_BY_RESOURCE, this parameter is ignored.

·        periodUnit – if dataCollectionType is POLLED_BY_MONITOR, this parameter defines the unit of the period. There are three possibilities:

¡        com.sap.engine.interfaces.monitor.MonitorConstants.MINUTE

¡        com.sap.engine.interfaces.monitor.MonitorConstants.HOUR

¡        com.sap.engine.interfaces.monitor.MonitorConstants.DAY

If dataCollectionType is PUSHED_BY_RESOURCE, this parameter is ignored.

·        reactOnCollectionFailure – defines how a monitor belonging to this group must react when the resource fails.

There are two possibilities:

¡        com.sap.engine.interfaces.monitor.MonitorConstants.UNREGISTER_MONITOR – the monitor that belongs to this group unregisters itself and stops monitoring the resource.

¡        com.sap.engine.interfaces.monitor.MonitorConstants.IGNORE – the monitor ignores the problems and remains registered to monitor the resource

·        green2Yellow – defines the value after which the color of the monitored performance values is changed from green to yellow. This is a signal to pay attention to the monitored values.

·        yellow2Red – defines the value after which the color of the monitored performance values is changed from yellow to red. This is a signal that there is a critical condition and that immediate actions must be performed.

·        yellow2Green – defines the value below which the color of the monitored performance values is changed from yellow to green. This is a signal that the monitored values are normal.

·        red2Yellow – defines the value below which the color of the monitored performance values is changed from red to yellow. This is a signal that the critical condition has passed, but the values are still critical.

·        historyaAveragingMode – defines the averaging method to be used for computing history statistics.

There are two possibilities:

¡        com.sap.engine.interfaces.monitor.MonitorConstants.ARITHMETIC_AVERAGING

¡        com.sap.engine.interfaces.monitor.MonitorConstants.TIME_WEIGHTED_AVERAGING

In “arithmetic averaging”, every measurement has equal effect on the resulting average/standard deviation.

In “time weighted averaging”, many measurements in one time interval are treated as one averaged measurement.

According to these different averaging strategies, you get different average / standard deviation results.

·        unit – represents a particular unit for the group, for example “bytes”, “MB”, and so on. Units whose names have more than 4 symbols are cut to 4 symbols when they are sent to the CCMS.

·        alertRelevantValueType – has effect only for CCMS alerting, although it is possible to generate alerts not only based on the last reported value, but also based on differently averaged values.

There are several possibilities:

¡        com.sap.engine.interfaces.monitor.MonitorConstants.LAST

¡        com.sap.engine.interfaces.monitor.MonitorConstants.DISCRETE_HOUR

¡        com.sap.engine.interfaces.monitor.MonitorConstants.DISCRETE_QUARTER

¡        com.sap.engine.interfaces.monitor.MonitorConstants.DISCRETE_MINUTE

¡        com.sap.engine.interfaces.monitor.MonitorConstants.SLIDING_WINDOW_5_MINUTES

This method returns true if the group is created and added to the whole set of groups successfully; otherwise, it returns false.

Example

  boolean result = monitorContext.createFrequencyConfigurationGroup(frequencyGroupName, "TEST.FREQUENCY.GROUP", "Test frequency configuration group",

        MonitorConstants.POLLED_BY_MONITOR, 8, MonitorConstants.MINUTE, MonitorConstants.UNREGISTER_MONITOR,

                 20,40,40,20,

        MonitorConstants.TIME_WEIGHTED_AVERAGING,"1/s",0);

 

 

 

 

End of Content Area