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