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 /**
51 * Increment the number of requests
52 *
53 * @param inc Ammount to increment by
54 */
55 void incrementRequests(int inc);
56
57 /**
58 * Increment the number of successful Get requests.
59 *
60 * @param inc Number of successful get requests.
61 */
62 void incrementSucessfulGetRequests(int inc);
63
64 /**
65 * Increment the number of successful Put requests.
66 *
67 * @param inc Number of successful put requests.
68 */
69 void incrementSucessfulPutRequests(int inc);
70
71 /**
72 * Increment the number of successful Delete requests.
73 *
74 * @param inc
75 */
76 void incrementSucessfulDeleteRequests(int inc);
77
78 /**
79 * Increment the number of failed Put Requests.
80 *
81 * @param inc Number of failed Put requests.
82 */
83 void incrementFailedPutRequests(int inc);
84
85 /**
86 * Increment the number of failed Get requests.
87 *
88 * @param inc The number of failed Get Requests.
89 */
90 void incrementFailedGetRequests(int inc);
91
92 /**
93 * Increment the number of failed Delete requests.
94 *
95 * @param inc The number of failed delete requests.
96 */
97 void incrementFailedDeleteRequests(int inc);
98 }