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 package org.apache.hadoop.hbase.coprocessor;
20
21 import org.apache.hadoop.hbase.CoprocessorEnvironment;
22 import org.apache.hadoop.hbase.metrics.MetricRegistry;
23 import org.apache.hadoop.hbase.regionserver.RegionServerServices;
24
25 public interface RegionServerCoprocessorEnvironment extends CoprocessorEnvironment {
26 /**
27 * Gets the region server services.
28 *
29 * @return the region server services
30 */
31 RegionServerServices getRegionServerServices();
32
33 /**
34 * Returns a MetricRegistry that can be used to track metrics at the region server level.
35 *
36 * <p>See ExampleMasterObserverWithMetrics class in the hbase-examples modules for examples
37 * of how metrics can be instantiated and used.</p>
38 * @return A MetricRegistry for the coprocessor class to track and export metrics.
39 */
40 MetricRegistry getMetricRegistryForRegionServer();
41 }