Initial OpenECOMP APPC commit
[appc.git] / app-c / appc / appc-metric / appc-metric-bundle / src / main / java / org / openecomp / appc / metricservice / metric / Metric.java
1 /*-
2  * ============LICENSE_START=======================================================
3  * openECOMP : APP-C
4  * ================================================================================
5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
6  *                                              reserved.
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
22 package org.openecomp.appc.metricservice.metric;
23
24 /**
25  *
26  * a measure of system parameter at the current moment. Each metric is identified by name.
27  * In general case, a metric just reflects its (almost) real-time value and is not responsible for maintaining its historical data.
28  * One that needs to build series of a metric values for statistical/analytic purposes should query the value and store it for further processing.
29  * Metrics can be of different types - counters, timers etc.
30  * The initial service implementation supports simple (flat) counters only.
31  *
32  */
33 public interface Metric {
34     String name();
35     void reset();
36     MetricType type();
37 }