001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018
019package org.apache.hadoop.metrics2;
020
021import org.apache.hadoop.classification.InterfaceAudience;
022import org.apache.hadoop.classification.InterfaceStability;
023import org.apache.hadoop.metrics2.annotation.Metric;
024
025/**
026 * Interface to provide immutable metainfo for metrics.
027 */
028@InterfaceAudience.Public
029@InterfaceStability.Evolving
030public interface MetricsInfo {
031  /**
032   * Typically name corresponds to annotation {@link Metric#value()} or
033   * the name of the class.
034   * @return the name of the metric/tag
035   */
036  String name();
037
038  /**
039   * Typically the description corresponds to annotation {@link Metric#about()}
040   * or the name of the class.
041   * @return the description of the metric/tag
042   */
043  String description();
044}