org.miloss.fgsms.sla.rules

Class HighCPUUsage

java.lang.Object

org.miloss.fgsms.sla.rules.HighCPUUsage

All Implemented Interfaces:

PluginCommon, SLARuleInterface

public class HighCPUUsage
extends Object
implements SLARuleInterface

Author:

AO

Field Summary

Fields inherited from interface org.miloss.fgsms.plugins.sla.SLARuleInterface

ENCRYPTED_MASK, UNDEFINED_VALUE

Constructor Summary

Constructors

Constructor and Description
HighCPUUsage()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	CheckNonTransactionalRule(ServicePolicy pol, List<NameValuePair> params, AtomicReference<String> nullableFaultMsg, boolean pooled) Returns True is the rule's conditions have been met (SLA Violation).
boolean	CheckTransactionalRule(AddDataRequestMsg req, List<NameValuePair> params, AtomicReference<String> nullableFaultMsg) Returns True is the rule's conditions have been met (SLA Violation) Web Service Transaction performance data This function should never throw an exception
boolean	CheckTransactionalRule(MachinePerformanceData req, List<NameValuePair> params, AtomicReference<String> nullableFaultMsg) Returns True is the rule's conditions have been met (SLA Violation) Machine Performance data This function should never throw an exception
boolean	CheckTransactionalRule(ProcessPerformanceData req, List<NameValuePair> params, AtomicReference<String> nullableFaultMsg) Returns True is the rule's conditions have been met (SLA Violation) Process Performance data This function should never throw an exception
boolean	CheckTransactionalRule(SetStatusRequestMsg req, List<NameValuePair> params, AtomicReference<String> nullableFaultMsg) Returns True is the rule's conditions have been met (SLA Violation) This represents when a Status message comes in to the status service, such as from an OS agent.
boolean	CheckTransactionalRule(String url, List<BrokerData> data, List<NameValuePair> params, AtomicReference<String> nullableFaultMsg) Returns True is the rule's conditions have been met (SLA Violation) Statistical Message Broker data This function should never throw an exception
List<PolicyType>	GetAppliesTo() Returns a list of service policy types that this plugin can be applied to use Utility.getAllPolicyTypes() if it applies to everything.
String	GetDisplayName() end user facing display name
String	GetHtmlFormattedDisplay(List<NameValuePair> params) returns a html encoded string contain usually the rule name plus the configured values.
String	GetHtmlFormattedHelp() returns html formatted help to guide users towards proper usage.
List<NameValuePair>	GetOptionalParameters() returns a list of optional parameters
List<NameValuePair>	GetRequiredParameters() returns a list of required parameters
AlertType	GetType() If the rule is triggered, this defines what type of rule this is.
boolean	ValidateConfiguration(List<NameValuePair> params, AtomicReference<String> outError, ServicePolicy policy) Validates the configuration settings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HighCPUUsage

public HighCPUUsage()

Method Detail

CheckTransactionalRule

public boolean CheckTransactionalRule(SetStatusRequestMsg req,
                             List<NameValuePair> params,
                             AtomicReference<String> nullableFaultMsg)

Description copied from interface: SLARuleInterface

Returns True is the rule's conditions have been met (SLA Violation) This represents when a Status message comes in to the status service, such as from an OS agent. This function should never throw an exception

Specified by:

CheckTransactionalRule in interface SLARuleInterface

Parameters:

req - Set Status message

params - per service policy, rule instance parameters this can be null

nullableFaultMsg - the human readable text explaining what happened or why the rule was triggered

Returns:

CheckTransactionalRule

public boolean CheckTransactionalRule(ProcessPerformanceData req,
                             List<NameValuePair> params,
                             AtomicReference<String> nullableFaultMsg)

Description copied from interface: SLARuleInterface

Returns True is the rule's conditions have been met (SLA Violation) Process Performance data This function should never throw an exception

Specified by:

CheckTransactionalRule in interface SLARuleInterface

Parameters:

req - process performance data

params - per service policy, rule instance parameters this can be null

nullableFaultMsg - the human readable text explaining what happened or why the rule was triggered

Returns:

CheckTransactionalRule

public boolean CheckTransactionalRule(MachinePerformanceData req,
                             List<NameValuePair> params,
                             AtomicReference<String> nullableFaultMsg)

Description copied from interface: SLARuleInterface

Returns True is the rule's conditions have been met (SLA Violation) Machine Performance data This function should never throw an exception

Specified by:

CheckTransactionalRule in interface SLARuleInterface

Parameters:

req - machine performance data

params - per service policy, rule instance parameters this can be null

nullableFaultMsg - the human readable text explaining what happened or why the rule was triggered

Returns:

CheckTransactionalRule

public boolean CheckTransactionalRule(AddDataRequestMsg req,
                             List<NameValuePair> params,
                             AtomicReference<String> nullableFaultMsg)

Description copied from interface: SLARuleInterface

Returns True is the rule's conditions have been met (SLA Violation) Web Service Transaction performance data This function should never throw an exception

Specified by:

CheckTransactionalRule in interface SLARuleInterface

Parameters:

req - web service transaction data

params - per service policy, rule instance parameters this can be null

nullableFaultMsg - the human readable text explaining what happened or why the rule was triggered

Returns:

CheckTransactionalRule

public boolean CheckTransactionalRule(String url,
                             List<BrokerData> data,
                             List<NameValuePair> params,
                             AtomicReference<String> nullableFaultMsg)

Description copied from interface: SLARuleInterface

Returns True is the rule's conditions have been met (SLA Violation) Statistical Message Broker data This function should never throw an exception

Specified by:

CheckTransactionalRule in interface SLARuleInterface

Parameters:

url - The url of the broker in question

data - BrokerData, generally a list of queue, topics and their associated metrics

params - per service policy, rule instance parameters this can be null

nullableFaultMsg - the human readable text explaining what happened or why the rule was triggered

Returns:

CheckNonTransactionalRule

public boolean CheckNonTransactionalRule(ServicePolicy pol,
                                List<NameValuePair> params,
                                AtomicReference<String> nullableFaultMsg,
                                boolean pooled)

Description copied from interface: SLARuleInterface

Returns True is the rule's conditions have been met (SLA Violation).

This is used for non transactional rules. Implementors should access the database and perform whatever calculations are required in order to determine if the rule's conditions are met or not.

This function should never throw an exception.

The calling function is typically the NonTransactionalSLAProcessor which operates on a set schedule that can be adjusted by administrators. It operates using the Quarts schedulers

Since no data is provided, an implementor is expected to access data on their own. To access global settings

Open the fgsms databases

 Connection con =null;
 if (pooled)
  con= Utility.GetPerformanceDBConnection();
 else
  con = Utility.GetPerformanceDB_NONPOOLED_Connection();
 //or use Utility.ConfigurationDBConnection(); for the configuration database
 try {
 // do something
 } catch (Exception ex) {
 // log some message
 } finally {
 if (con != null) {
 try {
 con.close();
 } catch (Exception e) {
 }
 }
 }
 

Specified by:

CheckNonTransactionalRule in interface SLARuleInterface

Parameters:

pol - This is a reference the service policy that this rule is attached to. Do not modify, unexpected results may occur

params - per service policy, rule instance parameters this can be null

nullableFaultMsg - the human readable text explaining what happened or why the rule was triggered

pooled - Indicates the usage of pooled database connections or not

Returns:

true if the rule indicates that a problem has occurred

See Also:

NonTransactionalSLAProcessor, RuleBaseType, Utility, AuditLogger, DBSettingsLoader, SLACommon, SetServicePolicyRequestMsg, ServicePolicy, SLA

GetDisplayName

public String GetDisplayName()

Description copied from interface: PluginCommon

end user facing display name

Specified by:

GetDisplayName in interface PluginCommon

Returns:

GetHtmlFormattedHelp

public String GetHtmlFormattedHelp()

Description copied from interface: PluginCommon

returns html formatted help to guide users towards proper usage. Always include the following fields

• Applies to - what policies types it applies to
• Required and optional parameters
• Description
• State if this is processed as data comes in, or periodically (some aggregated data)

Html is allowed, javascript is not

Specified by:

GetHtmlFormattedHelp in interface PluginCommon

Returns:

GetRequiredParameters

public List<NameValuePair> GetRequiredParameters()

Description copied from interface: PluginCommon

returns a list of required parameters

Specified by:

GetRequiredParameters in interface PluginCommon

Returns:

GetOptionalParameters

public List<NameValuePair> GetOptionalParameters()

Description copied from interface: PluginCommon

returns a list of optional parameters

Specified by:

GetOptionalParameters in interface PluginCommon

Returns:

ValidateConfiguration

public boolean ValidateConfiguration(List<NameValuePair> params,
                            AtomicReference<String> outError,
                            ServicePolicy policy)

Description copied from interface: SLARuleInterface

Validates the configuration settings. This is called by both the user interface as well as whenever someone attempts to add or change a service policy containing this federation target.

Specified by:

ValidateConfiguration in interface SLARuleInterface

Parameters:

params - parameters for this instance for a SLARule for validation

outError - human readable error message representing whatever the problem areas are

policy - a reference to the proposed service policy

Returns:

True if the configuration is valid, false otherwise

GetType

public AlertType GetType()

Description copied from interface: SLARuleInterface

If the rule is triggered, this defines what type of rule this is. This is used to determine which type of Alert Type is sent to subscribers

Specified by:

GetType in interface SLARuleInterface

Returns:

GetHtmlFormattedDisplay

public String GetHtmlFormattedDisplay(List<NameValuePair> params)

Description copied from interface: SLARuleInterface

returns a html encoded string contain usually the rule name plus the configured values. Encrypted values should use the field ENCRYPTED_MASK. Input params list may be from direct user input, therefore you should validate the input before processing. Html is allowed, javascript is not example: "Response time is greater than 50 ms" "Consumer Identity contains (encrypted)

Specified by:

GetHtmlFormattedDisplay in interface SLARuleInterface

Returns:

See Also:

StringEscapeUtils, Utility

GetAppliesTo

public List<PolicyType> GetAppliesTo()

Description copied from interface: PluginCommon

Returns a list of service policy types that this plugin can be applied to use Utility.getAllPolicyTypes() if it applies to everything. Also Utility.IsContains()

Specified by:

GetAppliesTo in interface PluginCommon

Returns: