org.apache.phoenix.monitoring.ConnectionQueryServicesMetric Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phoenix-mapreduce-byo-shaded-hbase-hbase-2.5.0

Phoenix Mapreduce JAR for use with the "hbase mapredcp" classpath

The newest version!

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.phoenix.monitoring;

/**
 * Class that exposes the various phoenix metrics collected at the Phoenix Query Service level.
 * Because metrics are dynamic in nature, it is not guaranteed that the state exposed will always
 * be in sync with each other. One should use these metrics primarily for monitoring and debugging
 * purposes.
 */
public interface ConnectionQueryServicesMetric extends Metric {

    /**
     * @return Number of samples collected since the last {@link #reset()} call.
     */
    long getNumberOfSamples();

    /**
     * @return Sum of the values of the metric sampled since the last {@link #reset()} call.
     */
    long getTotalSum();

}