kv-3.5.2.src.oracle.kv.stats.OperationMetrics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of oracle-nosql-client Show documentation

Oracle NoSQL Database Client - supplies build and runtime support for the client side of the Oracle NoSQL Database. Note that a running Oracle NoSQL Database Server (store) is required to do anything meaningful with this client.

There is a newer version: 4.4.6

Show newest version

/*-
 *
 *  This file is part of Oracle NoSQL Database
 *  Copyright (C) 2011, 2015 Oracle and/or its affiliates.  All rights reserved.
 *
 * If you have received this file as part of Oracle NoSQL Database the
 * following applies to the work as a whole:
 *
 *   Oracle NoSQL Database server software is free software: you can
 *   redistribute it and/or modify it under the terms of the GNU Affero
 *   General Public License as published by the Free Software Foundation,
 *   version 3.
 *
 *   Oracle NoSQL Database 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
 *   Affero General Public License for more details.
 *
 * If you have received this file as part of Oracle NoSQL Database Client or
 * distributed separately the following applies:
 *
 *   Oracle NoSQL Database client software is free software: you can
 *   redistribute it and/or modify it under the terms of the Apache License
 *   as published by the Apache Software Foundation, version 2.0.
 *
 * You should have received a copy of the GNU Affero General Public License
 * and/or the Apache License in the LICENSE file along with Oracle NoSQL
 * Database client or server distribution.  If not, see
 * 
 * or
 * .
 *
 * An active Oracle commercial licensing agreement for this product supersedes
 * these licenses and in such case the license notices, but not the copyright
 * notice, may be removed by you in connection with your distribution that is
 * in accordance with the commercial licensing terms.
 *
 * For more information please contact:
 *
 * [email protected]
 *
 */

package oracle.kv.stats;

/**
 * Aggregates the metrics associated with a KVS operation.
 */
public interface OperationMetrics {

    /**
     * Returns the name of the KVS operation associated with the metrics.
     */
    public String getOperationName();

    /**
     * Returns the number of operations that were executed.
     * 
     * For requests (API method calls) that involve a single operation (get,
     * put, etc.), one operation is counted per request.  For requests that
     * involve multiple operations (multiGet, multiDelete, execute), all
     * individual operations are counted.
     */
    public int getTotalOps();

    /**
     * Returns the number of requests that were executed.
     * 
     * Only one request per API method call is counted, whether the request
     * involves a single operation (get, put, etc.) or multiple operations
     * (multiGet, multiDelete, execute).  For requests that involve a single
     * operation, this method returns the same value as {@link #getTotalOps}.
     */
    public int getTotalRequests();

    /**
     * Returns the minimum request latency in milliseconds.
     */
    public int getMinLatencyMs();

    /**
     * Returns the maximum request latency in milliseconds.
     */
    public int getMaxLatencyMs();

    /**
     * Returns the average request latency in milliseconds.
     */
    public float getAverageLatencyMs();
}