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.io;
020
021import org.apache.hadoop.hbase.metrics.BaseSource;
022import org.apache.yetus.audience.InterfaceAudience;
023
024@InterfaceAudience.Private
025public interface MetricsIOSource extends BaseSource {
026
027  /**
028   * The name of the metrics
029   */
030  String METRICS_NAME = "IO";
031
032  /**
033   * The name of the metrics context that metrics will be under.
034   */
035  String METRICS_CONTEXT = "regionserver";
036
037  /**
038   * Description
039   */
040  String METRICS_DESCRIPTION = "Metrics about FileSystem IO";
041
042  /**
043   * The name of the metrics context that metrics will be under in jmx
044   */
045  String METRICS_JMX_CONTEXT = "RegionServer,sub=" + METRICS_NAME;
046
047
048  String FS_READ_TIME_HISTO_KEY = "fsReadTime";
049  String FS_PREAD_TIME_HISTO_KEY = "fsPReadTime";
050  String FS_WRITE_HISTO_KEY = "fsWriteTime";
051
052  String CHECKSUM_FAILURES_KEY = "fsChecksumFailureCount";
053
054  String FS_READ_TIME_HISTO_DESC
055    = "Latency of HFile's sequential reads on this region server in milliseconds";
056  String FS_PREAD_TIME_HISTO_DESC
057    = "Latency of HFile's positional reads on this region server in milliseconds";
058  String FS_WRITE_TIME_HISTO_DESC
059    = "Latency of HFile's writes on this region server in milliseconds";
060
061  String CHECKSUM_FAILURES_DESC = "Number of checksum failures for the HBase HFile checksums at the"
062      + " HBase level (separate from HDFS checksums)";
063
064
065  /**
066   * Update the fs sequential read time histogram
067   * @param t time it took, in milliseconds
068   */
069  void updateFsReadTime(long t);
070
071  /**
072   * Update the fs positional read time histogram
073   * @param t time it took, in milliseconds
074   */
075  void updateFsPReadTime(long t);
076
077  /**
078   * Update the fs write time histogram
079   * @param t time it took, in milliseconds
080   */
081  void updateFsWriteTime(long t);
082}