com.bigdata.counters.query.ICounterSelector Maven / Gradle / Ivy

Go to download
/*

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     [email protected]

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/
/*
 * Created on Apr 6, 2009
 */

package com.bigdata.counters.query;

import java.util.regex.Pattern;

import com.bigdata.counters.HistoryInstrument;
import com.bigdata.counters.ICounter;
import com.bigdata.counters.PeriodEnum;

/**
 * Interface for selecting counters.
 * 
 * @author Bryan Thompson
 */
public interface ICounterSelector {

    /**
     * Selects and returns a collection of performance counters with history.
     * 
     * @param depth
     *            When GT ZERO, this specifies a constraint on the maximum
     *            depth for a counter may can be selected.
     * @param pattern
     *            A regular expression which must be satisified (optional).
     * @param fromTime
     *            The inclusive lower bound in milliseconds of the performance
     *            counter timestamps which will be selected.
     * @param toTime
     *            The exclusive upper bound in milliseconds of the performance
     *            counter timestamps which will be selected.
     * @param period
     *            The unit of aggregation for the selected performance counters.
     * @param historyRequired
     *            When true the {@link ICounter} will be ignored
     *            unless it is associated with a {@link HistoryInstrument}.
     *            (This used to be the default behavior, but there are use cases
     *            where we do not need to have history.)
     *            
     * @return The selected performance counters.
     */
    @SuppressWarnings("rawtypes")
    ICounter[] selectCounters(int depth, Pattern pattern, long fromTime,
            long toTime, PeriodEnum period, boolean historyRequired);

}