gobblin.metrics.ContextAwareMetric Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gobblin-metrics Show documentation

Gobblin Ingestion Framework

There is a newer version: 0.8.0

/*
 * Copyright (C) 2014-2016 LinkedIn Corp. All rights reserved.
 *
 * Licensed 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.
 */

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();

}