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.coprocessor;
21
22 import org.apache.hadoop.hbase.classification.InterfaceAudience;
23 import org.apache.hadoop.hbase.classification.InterfaceStability;
24 import org.apache.hadoop.hbase.CoprocessorEnvironment;
25 import org.apache.hadoop.hbase.HBaseInterfaceAudience;
26 import org.apache.hadoop.hbase.master.MasterServices;
27 import org.apache.hadoop.hbase.metrics.MetricRegistry;
28
29 @InterfaceAudience.LimitedPrivate(HBaseInterfaceAudience.COPROC)
30 @InterfaceStability.Evolving
31 public interface MasterCoprocessorEnvironment extends CoprocessorEnvironment {
32 /** @return reference to the HMaster services */
33 MasterServices getMasterServices();
34
35 /**
36 * Returns a MetricRegistry that can be used to track metrics at the master level.
37 *
38 * <p>See ExampleMasterObserverWithMetrics class in the hbase-examples modules for examples
39 * of how metrics can be instantiated and used.</p>
40 * @return A MetricRegistry for the coprocessor class to track and export metrics.
41 */
42 MetricRegistry getMetricRegistryForMaster();
43 }