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  package org.apache.hadoop.hbase.metrics;
19  
20  import org.apache.commons.logging.Log;
21  import org.apache.commons.logging.LogFactory;
22  import org.apache.hadoop.metrics.MetricsRecord;
23  import org.apache.hadoop.metrics.util.MetricsBase;
24  import org.apache.hadoop.metrics.util.MetricsRegistry;
25  
26  /**
27   * Publishes a string to the metrics collector
28   */
29  public class MetricsString extends MetricsBase {
30    private static final Log LOG = LogFactory.getLog("org.apache.hadoop.hbase.metrics");
31  
32    private String value;
33  
34    public MetricsString(final String name, final MetricsRegistry registry, 
35        final String value) {
36      super(name, NO_DESCRIPTION);
37      this.value = value;
38      registry.add(name, this);
39    }
40    public MetricsString(final String name, final String description, 
41        final MetricsRegistry registry, final String value) {
42      super(name, description);
43      this.value = value;
44      registry.add(name, this);
45    }
46    
47    public String getValue() {
48      return this.value;
49    }
50  
51    @Override
52    public synchronized void pushMetric(final MetricsRecord mr) {
53      // NOOP
54      // MetricsMBeanBase.getAttribute is where we actually fill the data
55    }
56  }