src/main/java/com/att/dmf/mr/backends/MetricsSet.java

   1 /*******************************************************************************
   2  *  ============LICENSE_START=======================================================
   3  *  org.onap.dmaap
   4  *  ================================================================================
   5  *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  *  ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11 *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *  ============LICENSE_END=========================================================
  18  *
  19  *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
  20  *
  21  *******************************************************************************/
  22 package com.att.dmf.mr.backends;
  23
  24 import com.att.nsa.metrics.CdmMetricsRegistry;
  25 /**
  26  * This interface will help to generate metrics
  27  * @author nilanjana.maity
  28  *
  29  */
  30 public interface MetricsSet extends CdmMetricsRegistry{
  31
  32         /**
  33          * This method will setup cambria sender code
  34          */
  35         public void setupCambriaSender ();
  36         /**
  37          * This method will define on route complete
  38          * @param name
  39          * @param durationMs
  40          */
  41         public void onRouteComplete ( String name, long durationMs );
  42         /**
  43          * This method will help the kafka publisher while publishing the messages
  44          * @param amount
  45          */
  46         public void publishTick ( int amount );
  47         /**
  48          * This method will help the kafka consumer while consuming the messages
  49          * @param amount
  50          */
  51         public void consumeTick ( int amount );
  52         /**
  53          * This method will call if the kafka consumer cache missed
  54          */
  55         public void onKafkaConsumerCacheMiss ();
  56         /**
  57          * This method will call if the kafka consumer cache will be hit while publishing/consuming the messages
  58          */
  59         public void onKafkaConsumerCacheHit ();
  60         /**
  61          * This method will call if the kafka consumer cache claimed
  62          */
  63         public void onKafkaConsumerClaimed ();
  64         /**
  65          * This method will call if Kafka consumer is timed out
  66          */
  67         public void onKafkaConsumerTimeout ();
  68
  69
  70
  71 }