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