ContextAwareMetric.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package gobblin.metrics;

import com.codahale.metrics.Metric;

import gobblin.metrics.metric.ProxyMetric;


/**
 * An interface for a type of {@link com.codahale.metrics.Metric}s that are aware of their
 * {@link MetricContext} and can have associated {@link Tag}s.
 *
 * @author Yinan Li
 */
public interface ContextAwareMetric extends Metric, ProxyMetric {

  /**
   * Get the name of the metric.
   *
   * @return the name of the metric
   */
  public String getName();

  /**
   * Get the {@link MetricContext} the metric is registered in.
   */
  public MetricContext getContext();

}