appc-metric/appc-metric-bundle/src/main/java/org/openecomp/appc/metricservice/metric/Metric.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * Copyright (C) 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  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22
  23 package org.openecomp.appc.metricservice.metric;
  24
  25 import java.util.HashMap;
  26
  27 /**
  28  *
  29  * a measure of system parameter at the current moment. Each metric is identified by name.
  30  * In general case, a metric just reflects its (almost) real-time value and is not responsible for maintaining its historical data.
  31  * One that needs to build series of a metric values for statistical/analytic purposes should query the value and store it for further processing.
  32  * Metrics can be of different types - counters, timers etc.
  33  * The initial service implementation supports simple (flat) counters only.
  34  *
  35  */
  36 public interface Metric {
  37     String name();
  38     void reset();
  39     MetricType type();
  40     /**
  41      * This API will be used to get all the running Metrics Output.
  42      * @return HashMap <String,String> in which
  43      * the First String(Key) will be the name of the KPI property
  44      * and another String(Value of the Key) will be the Value of
  45      * that property for that KPI
  46      */
  47     HashMap<String,String> getMetricsOutput();
  48     /**
  49      * Return last modified date for  KPI in string format
  50      * @return - last modified date for KPI
  51      */
  52     String getLastModified();
  53 }