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