2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 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
13 * http://www.apache.org/licenses/LICENSE-2.0
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.
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 * ============LICENSE_END=========================================================
25 package org.onap.appc.metricservice.metric;
27 import java.util.HashMap;
31 * a measure of system parameter at the current moment. Each metric is identified by name.
32 * In general case, a metric just reflects its (almost) real-time value and is not responsible for maintaining its historical data.
33 * One that needs to build series of a metric values for statistical/analytic purposes should query the value and store it for further processing.
34 * Metrics can be of different types - counters, timers etc.
35 * The initial service implementation supports simple (flat) counters only.
38 public interface Metric {
43 * This API will be used to get all the running Metrics Output.
44 * @return HashMap <String,String> in which
45 * the First String(Key) will be the name of the KPI property
46 * and another String(Value of the Key) will be the Value of
47 * that property for that KPI
49 HashMap<String,String> getMetricsOutput();
51 * Return last modified date for KPI in string format
52 * @return - last modified date for KPI
54 String getLastModified();