dcae-analytics-cdap-common/src/main/java/org/onap/dcae/apod/analytics/cdap/common/CDAPMetricsConstants.java

   1 /*
   2  * ===============================LICENSE_START======================================
   3  *  dcae-analytics
   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  *
  11  *          http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *  ============================LICENSE_END===========================================
  19  */
  20
  21 package org.onap.dcae.apod.analytics.cdap.common;
  22
  23 /**
  24  * Contains all metrics names used for DCAE CDAP modules
  25  *
  26  * <p>
  27  *     Format should be (ModuleName)_(Description of metrics)_METRIC e.g. TCA_WORKER_FAILED_ATTEMPTS_METRIC
  28  * </p>
  29  *
  30  * @author Rajiv Singla . Creation Date: 10/25/2016.
  31  */
  32 public abstract class CDAPMetricsConstants {
  33
  34     /**
  35      * Metric captures count of all responses received from DMaaP MR Subscriber Topic
  36      */
  37     public static final String DMAAP_MR_SUBSCRIBER_ALL_RESPONSES_COUNT_METRIC =
  38             "dmaap.subscriber.fetch.all_responses";
  39
  40     /**
  41      * Metric captures count of responses from DMaaP MR Subscriber Topic which does not have 200 HTTP Response code.
  42      * This can be due to DMaaP topic being down or any internal server errors etc.
  43      */
  44     public static final String DMAAP_MR_SUBSCRIBER_UNSUCCESSFUL_RESPONSES_METRIC =
  45             "dmaap.subscriber.fetch.unsuccessful";
  46
  47     /**
  48      * Metric that counts the number of successful (200 HTTP Response Code) calls to DMaaP which did not had empty
  49      * messages
  50      */
  51     public static final String DMAAP_MR_SUBSCRIBER_RESPONSES_WITH_NO_MESSAGES_METRIC =
  52             "dmaap.subscriber.fetch.no_message";
  53
  54     /**
  55      * Metric to count total number of message processed by DMaaP MR subscriber
  56      */
  57     public static final String DMAAP_MR_SUBSCRIBER_TOTAL_MESSAGES_PROCESSED_METRIC = "dmaap.subscriber.message.count";
  58
  59
  60     /**
  61      * Metric to record time taken in ms by subscriber in its most recent call to fetch DMaaP MR messages
  62      */
  63     public static final String DMAAP_MR_SUBSCRIBER_RESPONSE_TIME_MS_METRIC = "dmaap.subscriber.fetch.response_time";
  64
  65     /**
  66      * Metric captures the count of number of times DMaaP MR Subscriber was unable to write to DMaaP Stream due
  67      * some CDAP error while writing to stream. This should ideally never happen assuming we have enough space
  68      * on CDAP machine and CDAP process is functioning normally
  69      */
  70     public static final String TCA_SUBSCRIBER_FAILURE_TO_WRITE_TO_STREAM_METRIC = "tca.subscriber.stream.writing.error";
  71
  72
  73     /**
  74      * Metric captures number of VES messages that are not applicable as per TCA Policy
  75      */
  76     public static final String TCA_VES_INAPPLICABLE_MESSAGES_METRIC = "tca.ves.calculator.inapplicable";
  77
  78     /**
  79      * Metric captures number of VES messages that are applicable as per TCA Policy but don't violate any thresholds
  80      */
  81     public static final String TCA_VES_COMPLIANT_MESSAGES_METRIC = "tca.ves.calculator.compliant";
  82
  83     /**
  84      * Metrics captures number of VES messages that are applicable as per TCA Policy and does violate thresholds and
  85      * will likely cause an alert
  86      */
  87     public static final String TCA_VES_NON_COMPLIANT_MESSAGES_METRIC = "tca.ves.calculator.non_compliant";
  88
  89
  90     /**
  91      * Metric that counts the number of publisher look ups in alerts table which resulted in 0 new alerts
  92      */
  93     public static final String TCA_PUBLISHER_NO_NEW_ALERTS_LOOKUP_METRIC = "tca.publisher.lookup.no_message";
  94
  95     /**
  96      * Metric that counts the number of new alerts found by the publisher in alerts table
  97      */
  98     public static final String TCA_PUBLISHER_NEW_ALERTS_METRIC = "tca.publisher.lookup.new_messages";
  99
 100     /**
 101      * Metric that counts the number of alerts deleted by publisher in alerts table
 102      */
 103     public static final String TCA_PUBLISHER_DELETED_ALERTS_METRIC = "tca.publisher.deleted.alerts";
 104
 105     /**
 106      * Metric that counts the number of publisher calls to DMaaP which resulted in successful response code
 107      */
 108     public static final String TCA_PUBLISHER_SUCCESSFUL_DMAAP_RESPONSE_METRIC = "tca.publisher.publish.successful";
 109
 110     /**
 111      * Metric that counts the number of publisher calls to DMaaP which resulted in unsuccessful response code
 112      */
 113     public static final String TCA_PUBLISHER_UNSUCCESSFUL_DMAAP_RESPONSE_METRIC = "tca.publisher.publish.unsuccessful";
 114
 115     private CDAPMetricsConstants() {
 116
 117     }
 118
 119 }