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

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