sparkybe-onap-service/src/main/java/org/onap/aai/sparky/analytics/ComponentStatistics.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * Copyright © 2017-2018 Amdocs
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *       http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21 package org.onap.aai.sparky.analytics;
  22
  23
  24 /**
  25  * The Interface ComponentStatistics.
  26  */
  27 public interface ComponentStatistics {
  28
  29   /**
  30    * Adds the counter.
  31    *
  32    * @param key the key
  33    */
  34   public void addCounter(String key);
  35
  36   /**
  37    * Peg counter.
  38    *
  39    * @param key the key
  40    */
  41   public void pegCounter(String key);
  42
  43   /**
  44    * Increment counter.
  45    *
  46    * @param key the key
  47    * @param value the value
  48    */
  49   public void incrementCounter(String key, int value);
  50
  51   /**
  52    * Adds the histogram.
  53    *
  54    * @param key the key
  55    * @param name the name
  56    * @param maxYValue the max Y value
  57    * @param numBins the num bins
  58    * @param numDecimalPoints the num decimal points
  59    */
  60   public void addHistogram(String key, String name, long maxYValue, int numBins,
  61       int numDecimalPoints);
  62
  63   /**
  64    * Update histogram.
  65    *
  66    * @param key the key
  67    * @param value the value
  68    */
  69   public void updateHistogram(String key, long value);
  70
  71   /**
  72    * Reset.
  73    */
  74   public void reset();
  75
  76 }