Example - Average Performance Rule Using a Rule Parameter Filter

/ This rule use the u_iStatus and dResponseTime sample fields.
def sampleFields = ["u_iStatus", "dResponseTime"];
public void calculateKPI(CI ci, KPI kpi, List<Sample> samples) {
    // Create a variable to count available samples.
    def availableSamples = 0;
    // Create a variable to sum response times of available samples.
    def totalResponseTime = 0;
    /**
     * Get the value of the rule parameter named "Response time limit"
     * from the KPI, as defined for the KPI in Service Health Admin.
     * This rule parameter is optional, so responseTimeLimit can be null.
     */
    Long responseTimeLimit = kpi.getRuleParameter("Response time limit")

    /**
     * Go over the given samples. If a sample's u_iStatus is equal to 0,
     * the sample is considered available.
     */
    samples.each {Sample currentSample ->
        if (currentSample.u_iStatus == 0) {
            /**
            * Check the value of the rule parameter.
            * If it is not null (meaning the user has set a value),
            * and the sample's dResponseTime is greater than the
            * rule parameter value, the value is not valid.
            */
            boolean isSampleValid = true;
            if (responseTimeLimit != null) {
                // Check if ResponseTime exceeds the rule parameter value.
                if (currentSample.dResponseTime > responseTimeLimit) {
                    // The sample is not valid.
                    isSampleValid = false;
                }
            }
            if (isSampleValid) {
                // Increase the count of available samples.
                availableSamples++;
                // Add the sample's dResponseTime value to totalResponseTime.
                totalResponseTime += currentSample.dResponseTime
            }
        }
    }
    if (availableSamples > 0) {
        // Set KPI value, converted to percentage.
        kpi.setValue((totalResponseTime / availableSamples))
    }
}