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 filter interface
026 */
027@InterfaceAudience.Public
028@InterfaceStability.Evolving
029public abstract class MetricsFilter implements MetricsPlugin {
030
031  /**
032   * Whether to accept the name
033   * @param name  to filter on
034   * @return  true to accept; false otherwise.
035   */
036  public abstract boolean accepts(String name);
037
038  /**
039   * Whether to accept the tag
040   * @param tag to filter on
041   * @return  true to accept; false otherwise
042   */
043  public abstract boolean accepts(MetricsTag tag);
044
045  /**
046   * Whether to accept the tags
047   * @param tags to filter on
048   * @return  true to accept; false otherwise
049   */
050  public abstract boolean accepts(Iterable<MetricsTag> tags);
051
052  /**
053   * Whether to accept the record
054   * @param record  to filter on
055   * @return  true to accept; false otherwise.
056   */
057  public boolean accepts(MetricsRecord record) {
058    return accepts(record.name()) && accepts(record.tags());
059  }
060
061}