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;
023
024/**
025 * The metrics collector interface
026 */
027@InterfaceAudience.Public
028@InterfaceStability.Evolving
029public interface MetricsCollector {
030  /**
031   * Add a metrics record
032   * @param name  of the record
033   * @return  a {@link MetricsRecordBuilder} for the record {@code name}
034   */
035  public MetricsRecordBuilder addRecord(String name);
036
037  /**
038   * Add a metrics record
039   * @param info  of the record
040   * @return  a {@link MetricsRecordBuilder} for metrics {@code info}
041   */
042  public MetricsRecordBuilder addRecord(MetricsInfo info);
043}