content: /*
   * 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 com.alibaba.metrics;
  
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  import java.util.SortedMap;
  
  public interface IMetricManager {
  
      /**
       * Create a {@link Meter} metric in given group, and name.
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @return an instance of meter
       */
      Meter getMeter(String group, MetricName name);
  
      /**
       * Create a {@link Counter} metric in given group, and name.
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @return an instance of counter
       */
      Counter getCounter(String group, MetricName name);
  
      /**
       * Create a {@link Histogram} metric in given group, and name.
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @return an instance of histogram
       */
      Histogram getHistogram(String group, MetricName name);
  
      /**
       * Create a {@link Histogram} metric in given group, name, and type
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @param type  the type of the reservoir
       * @return an instance of histogram
       */
      Histogram getHistogram(String group, MetricName name, ReservoirType type);
  
      /**
       * Create a {@link Timer} metric in given group, and name.
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @return an instance of timer
       */
      Timer getTimer(String group, MetricName name);
  
      /**
       * Create a {@link Timer} metric in given group, name, and type
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @param type  the type of the reservoir
       * @return an instance of timer
       */
      Timer getTimer(String group, MetricName name, ReservoirType type);
  
      /**
       * Create a {@link Compass} metric in given group, and name.
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @return an instance of compass
       */
      Compass getCompass(String group, MetricName name);
  
      /**
       * Create a {@link Compass} metric in given group, name, and type
       * if not exist, an instance will be created.
       *
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @param type  the type of the reservoir
       * @return an instance of compass
       */
      Compass getCompass(String group, MetricName name, ReservoirType type);
  
      /**
       * Create a {@link FastCompass} metric in give group, name, and type
       * if not exist, an instance will be created.
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @return an instance of {@link FastCompass}
       */
      FastCompass getFastCompass(String group, MetricName name);
  
  
      /**
       * Create a {@link ClusterHistogram} metric in give group, name, and type
       * if not exist, an instance will be created.
       * @param group the group of MetricRegistry
       * @param name the name of the metric
       * @param buckets if the buckets is null, a default bucket will be created.
       * @return an instance of {@link ClusterHistogram}
       */
      ClusterHistogram getClusterHistogram(String group, MetricName name, long[] buckets);
  
      /**
       * Register a customized metric to specified group.
       * @param group: the group name of MetricRegistry
       * @param metric the metric to register
       */
      void register(String group, MetricName name, Metric metric);
  
      /**
       * Get a list of group in current MetricManager
       * @return a list of group name
       */
      List<String> listMetricGroups();
  
      /**
       * A global flag to complete disable the metrics feature
       * @return true if it is enabled.
       */
      boolean isEnabled();
  
      /**
       * A global flag to complete disable the metrics feature
       */
      void setEnabled(boolean enabled);
  
      /**
       * list all metric names by group
       * @return a map of metric name set, keyed by group name
       */
      Map<String, Set<MetricName>> listMetricNamesByGroup();
  
      /**
       * Get metric registry by group name,
       * if not found, null will be returned
       * @param group the group name to query
       * @return the MetricRegistry that is correspondent to the group
       */
      MetricRegistry getMetricRegistryByGroup(String group);
  
      SortedMap<MetricName, Gauge> getGauges(String group, MetricFilter filter);
  
      SortedMap<MetricName, Counter> getCounters(String group, MetricFilter filter);
  
      SortedMap<MetricName, Histogram> getHistograms(String group, MetricFilter filter);
  
      SortedMap<MetricName, Meter> getMeters(String group, MetricFilter filter);
  
      SortedMap<MetricName, Timer> getTimers(String group, MetricFilter filter);
  
      SortedMap<MetricName, Compass> getCompasses(String group, MetricFilter filter);
  
      SortedMap<MetricName, FastCompass> getFastCompasses(String group, MetricFilter filter);
      
      SortedMap<MetricName, ClusterHistogram> getClusterHistogram(String group, MetricFilter filter);
      /**
       * A map of metric names to metrics.
       *
       * @return the metrics
       */
      Map<MetricName, Metric> getMetrics(String group);
  
      /**
       * 返回不同Metric分类，各自保存好的map
       *
       * @param group
       * @return
       */
      Map<Class<? extends Metric>, Map<MetricName, ? extends Metric>> getCategoryMetrics(String group);
  
      /**
       * 返回不同Metric分类，各自保存好的map
       *
       * @param group
       * @param filter
       * @return
       */
      Map<Class<? extends Metric>, Map<MetricName, ? extends Metric>> getCategoryMetrics(String group,
              MetricFilter filter);
  
      /**
       * return all metrics
       *
       * @param filter
       * @return
       */
      Map<Class<? extends Metric>, Map<MetricName, ? extends Metric>> getAllCategoryMetrics(MetricFilter filter);
  
      /**
       * 清空IMetricManager
       */
      void clear();
  }
  