org.miloss.fgsms.plugins.sla

Interface SLARuleInterface

All Superinterfaces:

PluginCommon

All Known Implementing Classes:

ActionContainsIgnoreCase, ActionEqualsIgnoreCase, AllFaults, AllSuccesses, BrokerQueueSizeGreaterThan, ChangeInAvailabilityStatus, ConsumerContainsIgnoreCase, ConsumerEqualsIgnoreCase, CustomSLARule, FaultsOverTimeGreaterThan, FaultsOverTimeLessThan, HighCPUUsage, HighCPUUsageOverTime, HighDiskUsageOverTime, HighMemoryUsage, HighMemoryUsageOverTime, HighNetworkUsageOverTime, HighOpenFileHandles, HighThreadCount, InvocationsOverTimeGreatThan, InvocationsOverTimeLessThan, LowDiskSpace, MeanTimeBetweenFailureGreatThan, MeanTimeBetweenFailureLessThan, QueueOrTopicDoesNotExist, RequestContentContainsIgnoreCase, RequestMessageSizeGreaterThan, RequestMessageSizeLessThan, ResponseContentContainsIgnoreCase, ResponseMessageSizeGreaterThan, ResponseMessageSizeLessThan, ResponseTimeGreaterThan, ResponseTimeLessThan, StaleData, TransactionalAgentMemoContainsIgnoreCase, XPathExpression

public interface SLARuleInterface
extends PluginCommon

Service Level Agreement Rule Plugin Interface - This will allow developers to add custom Rules into fgsms.

All implementations should be stateless

Deployment Instructions

To deploy your own implementation of an SLARuleInterface implementation, build your jar file and any supporting jars and copy them to each fgsms server that contains fgsms.AuxServices.war and fgsmsServices.war in the WEB-INF/lib folder

To use your implementation

Use the PCS web service to set the service policy for a specific web service, adding an SLA with a SLARuleGeneric as the rule and at least one action defined. Use SLARuleGeneric to define the implementing class as your implementing class. Optionally, specify any per service settings necessary for making a rule determination. This can also be done from fgsmsWeb and fgsmsBootstrap web user interfaces.

Since:

6.2

Author:

AO

See Also:

PCS, SLARuleGeneric, org.miloss.fgsms.services.interfaces.policyconfiguration.SLAActionGeneric, NonTransactionalSLAProcessor, RuleBaseType, Utility, AuditLogger, DBSettingsLoader, SLACommon, SetServicePolicyRequestMsg, ServicePolicy, SLA

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENCRYPTED_MASK
static String	UNDEFINED_VALUE

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
String	GetHtmlFormattedDisplay(List<NameValuePair> params) returns a html encoded string contain usually the rule name plus the configured values.
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 interface org.miloss.fgsms.plugins.PluginCommon

GetAppliesTo, GetDisplayName, GetHtmlFormattedHelp, GetOptionalParameters, GetRequiredParameters

Field Detail

ENCRYPTED_MASK

static final String ENCRYPTED_MASK

See Also:

Constant Field Values

UNDEFINED_VALUE

static final String UNDEFINED_VALUE

See Also:

Constant Field Values

Method Detail

CheckTransactionalRule

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. This function should never throw an exception

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

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

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

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

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

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

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

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

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

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

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) {
 }
 }
 }
 

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

ValidateConfiguration

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

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.

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

Since:

6.3

GetType

AlertType GetType()

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

Returns:

GetHtmlFormattedDisplay

String GetHtmlFormattedDisplay(List<NameValuePair> params)

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)

Parameters:

params -

Returns:

See Also:

StringEscapeUtils, Utility