1 /** 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 package org.apache.hadoop.hbase.rest; 20 21 import org.apache.hadoop.hbase.metrics.BaseSource; 22 23 /** 24 * Interface of the Metrics Source that will export data to Hadoop's Metrics2 system. 25 */ 26 public interface MetricsRESTSource extends BaseSource { 27 28 String METRICS_NAME = "REST"; 29 30 String CONTEXT = "rest"; 31 32 String JMX_CONTEXT = "REST"; 33 34 String METRICS_DESCRIPTION = "Metrics about the HBase REST server"; 35 36 String REQUEST_KEY = "requests"; 37 38 String SUCCESSFUL_GET_KEY = "successfulGet"; 39 40 String SUCCESSFUL_PUT_KEY = "successfulPut"; 41 42 String SUCCESSFUL_DELETE_KEY = "successfulDelete"; 43 44 String FAILED_GET_KEY = "failedGet"; 45 46 String FAILED_PUT_KEY = "failedPut"; 47 48 String FAILED_DELETE_KEY = "failedDelete"; 49 50 String SUCCESSFUL_SCAN_KEY = "successfulScanCount"; 51 52 String FAILED_SCAN_KEY = "failedScanCount"; 53 54 /** 55 * Increment the number of requests 56 * 57 * @param inc Ammount to increment by 58 */ 59 void incrementRequests(int inc); 60 61 /** 62 * Increment the number of successful Get requests. 63 * 64 * @param inc Number of successful get requests. 65 */ 66 void incrementSucessfulGetRequests(int inc); 67 68 /** 69 * Increment the number of successful Put requests. 70 * 71 * @param inc Number of successful put requests. 72 */ 73 void incrementSucessfulPutRequests(int inc); 74 75 /** 76 * Increment the number of successful Delete requests. 77 * 78 * @param inc 79 */ 80 void incrementSucessfulDeleteRequests(int inc); 81 82 /** 83 * Increment the number of failed Put Requests. 84 * 85 * @param inc Number of failed Put requests. 86 */ 87 void incrementFailedPutRequests(int inc); 88 89 /** 90 * Increment the number of failed Get requests. 91 * 92 * @param inc The number of failed Get Requests. 93 */ 94 void incrementFailedGetRequests(int inc); 95 96 /** 97 * Increment the number of failed Delete requests. 98 * 99 * @param inc The number of failed delete requests. 100 */ 101 void incrementFailedDeleteRequests(int inc); 102 103 /** 104 * Increment the number of successful scan requests. 105 * 106 * @param inc Number of successful scan requests. 107 */ 108 void incrementSucessfulScanRequests(final int inc); 109 110 /** 111 * Increment the number failed scan requests. 112 * 113 * @param inc the inc 114 */ 115 void incrementFailedScanRequests(final int inc); 116 }