Renaming openecomp to onap
[aai/sparky-be.git] / src / main / java / org / onap / aai / sparky / analytics / ComponentStatistics.java
1 /**
2  * ============LICENSE_START=======================================================
3  * org.onap.aai
4  * ================================================================================
5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6  * Copyright © 2017 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22  */
23 package org.onap.aai.sparky.analytics;
24
25
26 /**
27  * The Interface ComponentStatistics.
28  */
29 public interface ComponentStatistics {
30
31   /**
32    * Adds the counter.
33    *
34    * @param key the key
35    */
36   public void addCounter(String key);
37
38   /**
39    * Peg counter.
40    *
41    * @param key the key
42    */
43   public void pegCounter(String key);
44
45   /**
46    * Increment counter.
47    *
48    * @param key the key
49    * @param value the value
50    */
51   public void incrementCounter(String key, int value);
52
53   /**
54    * Adds the histogram.
55    *
56    * @param key the key
57    * @param name the name
58    * @param maxYValue the max Y value
59    * @param numBins the num bins
60    * @param numDecimalPoints the num decimal points
61    */
62   public void addHistogram(String key, String name, long maxYValue, int numBins,
63       int numDecimalPoints);
64
65   /**
66    * Update histogram.
67    *
68    * @param key the key
69    * @param value the value
70    */
71   public void updateHistogram(String key, long value);
72
73   /**
74    * Reset.
75    */
76   public void reset();
77
78 }