001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.procedure2;
019
020import org.apache.hadoop.hbase.metrics.Counter;
021import org.apache.hadoop.hbase.metrics.Histogram;
022import org.apache.yetus.audience.InterfaceAudience;
023
024/**
025 * With this interface, the procedure framework provides means to collect following set of metrics
026 * per procedure type for all procedures:
027 * <ul>
028 * <li>Count of submitted procedure instances</li>
029 * <li>Time histogram for successfully completed procedure instances</li>
030 * <li>Count of failed procedure instances</li>
031 * </ul>
032 * Please implement this interface to return appropriate metrics.
033 */
034@InterfaceAudience.Private
035public interface ProcedureMetrics {
036  /**
037   * @return Total number of instances submitted for a type of a procedure
038   */
039  Counter getSubmittedCounter();
040
041  /**
042   * @return Histogram of runtimes for all successfully completed instances of a type of a procedure
043   */
044  Histogram getTimeHisto();
045
046  /**
047   * @return Total number of instances failed for a type of a procedure
048   */
049  Counter getFailedCounter();
050}