samza-api/src/main/java/org/apache/samza/metrics/ReadableMetricsRegistry.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.samza.metrics;

import java.util.Map;
import java.util.Set;

/**
 * A ReadableMetricsRegistry is a {@link org.apache.samza.metrics.MetricsRegistry} that also
 * allows read access to the metrics for which it is responsible.
 */
public interface ReadableMetricsRegistry extends MetricsRegistry {
  Set<String> getGroups();

  Map<String, Metric> getGroup(String group);

  void listen(ReadableMetricsRegistryListener listener);

  void unlisten(ReadableMetricsRegistryListener listener);
}