org.kie.api.management.GenericKieSessionMonitoringMXBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kogito-api
The Kogito public API which is backwards compatible between releases.
There is a newer version: 10.0.0
/*
 * Copyright 2010 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.kie.api.management;

import java.util.Date;
import java.util.Map;

import javax.management.ObjectName;

/**
 * An MBean interface for {@link org.kie.api.runtime.KieSession} monitoring
 */
public interface GenericKieSessionMonitoringMXBean {

    /**
     * Resets all stats
     */
    void reset();

    /**
     * Returns this MBean name
     */
    ObjectName getName();

    /**
     * @return the associated Kie Base ID
     */
    String getKieBaseId();

    /**
     * @return the total number of matches fired in this session since last
     * reset.
     */
    long getTotalMatchesFired();

    /**
     * @return the total number of matches cancelled in this session since
     * last reset.
     */
    long getTotalMatchesCancelled();

    /**
     * @return the total number of matches created in this session since
     * last reset.
     */
    long getTotalMatchesCreated();

    /**
     * @return the total milliseconds spent firing rules in this session since last reset.
     */
    long getTotalFiringTime();

    /**
     * @return the average firing time in milliseconds for rules in this session
     * since last reset.
     */
    double getAverageFiringTime();

    /**
     * @return the timestamp of the last stats reset
     */
    Date getLastReset();


    public static interface IAgendaStatsData {
        long getMatchesFired();
        long getMatchesCreated();
        long getMatchesCancelled();
        long getFiringTime();
        Date getLastReset();
    }
    /**
     * Returns the statistics for a single rule in this session,
     * like number of matches created, cancelled and fired as well as firing time.
     *
     * @param ruleName the name of the rule for which statistics are requested.
     *
     * @return the statistics for a single rule in this session
     */
    IAgendaStatsData getStatsForRule(String ruleName);
    Map getStatsByRule();


    long getTotalProcessInstancesStarted();

    long getTotalProcessInstancesCompleted();


    public static interface IGlobalProcessStatsData {
        long getProcessInstancesStarted();
        long getProcessInstancesCompleted();
        Date getLastReset();
    }
    public static interface IProcessStatsData extends IGlobalProcessStatsData {
        long getProcessNodesTriggered();
    }
    IProcessStatsData getStatsForProcess(String processId);
    Map getStatsByProcess();


    String getKieSessionName();

    /**
     * Return the total number of KieSession monitored by name by this MBean.
     * If the type of KieSession monitored is Stateful, this is the total count of Stateful KieSession(s) currently live under the specified KieSession name.
     * If the type of KieSession monitored is Stateless, this is the total amount of Working Memory created.
     */
    long getTotalSessions();
}