src/main/java/org/onap/dmaap/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 org.onap.dmaap.dmf.mr.backends;
  23
  24 import com.att.nsa.metrics.CdmMetricsRegistry;
  25
  26 /**
  27  * This interface will help to generate metrics
  28  * @author nilanjana.maity
  29  *
  30  */
  31 public interface MetricsSet extends CdmMetricsRegistry{
  32
  33         /**
  34          * This method will setup cambria sender code
  35          */
  36         public void setupCambriaSender ();
  37         /**
  38          * This method will define on route complete
  39          * @param name
  40          * @param durationMs
  41          */
  42         public void onRouteComplete ( String name, long durationMs );
  43         /**
  44          * This method will help the kafka publisher while publishing the messages
  45          * @param amount
  46          */
  47         public void publishTick ( int amount );
  48         /**
  49          * This method will help the kafka consumer while consuming the messages
  50          * @param amount
  51          */
  52         public void consumeTick ( int amount );
  53         /**
  54          * This method will call if the kafka consumer cache missed
  55          */
  56         public void onKafkaConsumerCacheMiss ();
  57         /**
  58          * This method will call if the kafka consumer cache will be hit while publishing/consuming the messages
  59          */
  60         public void onKafkaConsumerCacheHit ();
  61         /**
  62          * This method will call if the kafka consumer cache claimed
  63          */
  64         public void onKafkaConsumerClaimed ();
  65         /**
  66          * This method will call if Kafka consumer is timed out
  67          */
  68         public void onKafkaConsumerTimeout ();
  69
  70
  71
  72 }