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

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