View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  
20  package org.apache.hadoop.hbase.ipc;
21  
22  import org.apache.hadoop.hbase.metrics.ExceptionTrackingSource;
23  
24  public interface MetricsHBaseServerSource extends ExceptionTrackingSource {
25    String AUTHORIZATION_SUCCESSES_NAME = "authorizationSuccesses";
26    String AUTHORIZATION_SUCCESSES_DESC =
27        "Number of authorization successes.";
28    String AUTHORIZATION_FAILURES_NAME = "authorizationFailures";
29    String AUTHORIZATION_FAILURES_DESC =
30        "Number of authorization failures.";
31    String AUTHENTICATION_SUCCESSES_NAME = "authenticationSuccesses";
32    String AUTHENTICATION_SUCCESSES_DESC =
33        "Number of authentication successes.";
34    String AUTHENTICATION_FAILURES_NAME = "authenticationFailures";
35    String AUTHENTICATION_FAILURES_DESC =
36        "Number of authentication failures.";
37    String AUTHENTICATION_FALLBACKS_NAME = "authenticationFallbacks";
38    String AUTHENTICATION_FALLBACKS_DESC =
39        "Number of fallbacks to insecure authentication.";
40    String SENT_BYTES_NAME = "sentBytes";
41    String SENT_BYTES_DESC = "Number of bytes sent.";
42    String RECEIVED_BYTES_NAME = "receivedBytes";
43    String RECEIVED_BYTES_DESC = "Number of bytes received.";
44    String REQUEST_SIZE_NAME = "requestSize";
45    String REQUEST_SIZE_DESC = "Request size in bytes.";
46    String RESPONSE_SIZE_NAME = "responseSize";
47    String RESPONSE_SIZE_DESC = "Response size in bytes.";
48    String QUEUE_CALL_TIME_NAME = "queueCallTime";
49    String QUEUE_CALL_TIME_DESC = "Queue Call Time.";
50    String PROCESS_CALL_TIME_NAME = "processCallTime";
51    String PROCESS_CALL_TIME_DESC = "Processing call time.";
52    String TOTAL_CALL_TIME_NAME = "totalCallTime";
53    String TOTAL_CALL_TIME_DESC = "Total call time, including both queued and processing time.";
54    String QUEUE_SIZE_NAME = "queueSize";
55    String QUEUE_SIZE_DESC = "Number of bytes in the call queues.";
56    String GENERAL_QUEUE_NAME = "numCallsInGeneralQueue";
57    String GENERAL_QUEUE_DESC = "Number of calls in the general call queue.";
58    String PRIORITY_QUEUE_NAME = "numCallsInPriorityQueue";
59    String REPLICATION_QUEUE_NAME = "numCallsInReplicationQueue";
60    String REPLICATION_QUEUE_DESC =
61        "Number of calls in the replication call queue.";
62    String PRIORITY_QUEUE_DESC = "Number of calls in the priority call queue.";
63    String WRITE_QUEUE_NAME = "numCallsInWriteQueue";
64    String WRITE_QUEUE_DESC = "Number of calls in the write call queue; " +
65      "parsed requests waiting in scheduler to be executed";
66    String READ_QUEUE_NAME = "numCallsInReadQueue";
67    String READ_QUEUE_DESC = "Number of calls in the read call queue; " +
68      "parsed requests waiting in scheduler to be executed";
69    String SCAN_QUEUE_NAME = "numCallsInScanQueue";
70    String SCAN_QUEUE_DESC = "Number of calls in the scan call queue; " +
71      "parsed requests waiting in scheduler to be executed";
72    String NUM_OPEN_CONNECTIONS_NAME = "numOpenConnections";
73    String NUM_OPEN_CONNECTIONS_DESC = "Number of open connections.";
74    String NUM_ACTIVE_HANDLER_NAME = "numActiveHandler";
75    String NUM_ACTIVE_HANDLER_DESC = "Total number of active rpc handlers.";
76    String NUM_ACTIVE_GENERAL_HANDLER_NAME = "numActiveGeneralHandler";
77    String NUM_ACTIVE_GENERAL_HANDLER_DESC = "Number of active general rpc handlers.";
78    String NUM_ACTIVE_PRIORITY_HANDLER_NAME = "numActivePriorityHandler";
79    String NUM_ACTIVE_PRIORITY_HANDLER_DESC = "Number of active priority rpc handlers.";
80    String NUM_ACTIVE_REPLICATION_HANDLER_NAME = "numActiveReplicationHandler";
81    String NUM_ACTIVE_REPLICATION_HANDLER_DESC = "Number of active replication rpc handlers.";
82    String NUM_ACTIVE_WRITE_HANDLER_NAME = "numActiveWriteHandler";
83    String NUM_ACTIVE_WRITE_HANDLER_DESC = "Number of active write rpc handlers.";
84    String NUM_ACTIVE_READ_HANDLER_NAME = "numActiveReadHandler";
85    String NUM_ACTIVE_READ_HANDLER_DESC = "Number of active read rpc handlers.";
86    String NUM_ACTIVE_SCAN_HANDLER_NAME = "numActiveScanHandler";
87    String NUM_ACTIVE_SCAN_HANDLER_DESC = "Number of active scan rpc handlers.";
88    String NUM_GENERAL_CALLS_DROPPED_NAME = "numGeneralCallsDropped";
89    String NUM_GENERAL_CALLS_DROPPED_DESC = "Total number of calls in general queue which " +
90      "were dropped by CoDel RPC executor";
91    String NUM_LIFO_MODE_SWITCHES_NAME = "numLifoModeSwitches";
92    String NUM_LIFO_MODE_SWITCHES_DESC = "Total number of calls in general queue which " +
93      "were served from the tail of the queue";
94  
95    void authorizationSuccess();
96  
97    void authorizationFailure();
98  
99    void authenticationSuccess();
100 
101   void authenticationFailure();
102 
103   void authenticationFallback();
104 
105   void sentBytes(long count);
106 
107   void receivedBytes(int count);
108 
109   void sentResponse(long count);
110 
111   void receivedRequest(long count);
112 
113   void dequeuedCall(int qTime);
114 
115   void processedCall(int processingTime);
116 
117   void queuedAndProcessedCall(int totalTime);
118 }