View Javadoc

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.metrics;
20  
21  /**
22   * Interface for sources that will export JvmPauseMonitor metrics
23   */
24  public interface JvmPauseMonitorSource  {
25  
26    String INFO_THRESHOLD_COUNT_KEY = "pauseInfoThresholdExceeded";
27    String INFO_THRESHOLD_COUNT_DESC = "Count of INFO level pause threshold alerts";
28    String WARN_THRESHOLD_COUNT_KEY = "pauseWarnThresholdExceeded";
29    String WARN_THRESHOLD_COUNT_DESC = "Count of WARN level pause threshold alerts";
30  
31    String PAUSE_TIME_WITH_GC_KEY = "pauseTimeWithGc";
32    String PAUSE_TIME_WITH_GC_DESC = "Histogram for excessive pause times with GC activity detected";
33  
34    String PAUSE_TIME_WITHOUT_GC_KEY = "pauseTimeWithoutGc";
35    String PAUSE_TIME_WITHOUT_GC_DESC =
36        "Histogram for excessive pause times without GC activity detected";
37  
38    /**
39     * Increment the INFO level threshold exceeded count
40     * @param count the count
41     */
42    void incInfoThresholdExceeded(int count);
43  
44    /**
45     * Increment the WARN level threshold exceeded count
46     * @param count the count
47     */
48    void incWarnThresholdExceeded(int count);
49  
50    /**
51     * Update the pause time histogram where GC activity was detected.
52     *
53     * @param t time it took
54     */
55    void updatePauseTimeWithGc(long t);
56  
57    /**
58     * Update the pause time histogram where GC activity was not detected.
59     *
60     * @param t time it took
61     */
62    void updatePauseTimeWithoutGc(long t);
63  }