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.master;
019
020import org.apache.hadoop.hbase.metrics.BaseSource;
021import org.apache.yetus.audience.InterfaceAudience;
022
023@InterfaceAudience.Private
024public interface MetricsSnapshotSource extends BaseSource {
025  /**
026   * The name of the metrics
027   */
028  String METRICS_NAME = "Snapshots";
029
030  /**
031   * The context metrics will be under.
032   */
033  String METRICS_CONTEXT = "master";
034
035  /**
036   * The name of the metrics context that metrics will be under in jmx
037   */
038  String METRICS_JMX_CONTEXT = "Master,sub=" + METRICS_NAME;
039
040  /**
041   * Description
042   */
043  String METRICS_DESCRIPTION = "Metrics about HBase master server";
044
045  String SNAPSHOT_TIME_NAME = "snapshotTime";
046  String SNAPSHOT_RESTORE_TIME_NAME = "snapshotRestoreTime";
047  String SNAPSHOT_CLONE_TIME_NAME = "snapshotCloneTime";
048  String SNAPSHOT_TIME_DESC = "Time it takes to finish snapshot()";
049  String SNAPSHOT_RESTORE_TIME_DESC = "Time it takes to finish restoreSnapshot()";
050  String SNAPSHOT_CLONE_TIME_DESC = "Time it takes to finish cloneSnapshot()";
051
052  void updateSnapshotTime(long time);
053
054  void updateSnapshotCloneTime(long time);
055
056  void updateSnapshotRestoreTime(long time);
057}