Redis Connector call counters

Author: simonredfern

obp-api/src/main/scala/code/api/cache/Redis.scala

@@ -177,6 +177,9 @@ object Redis extends MdcLoggable {
           jedisConnection.head.del(key).toString
         }else if (method ==JedisMethod.GET) {
           jedisConnection.head.get(key)
+        } else if (method == JedisMethod.SCAN) {
+          import scala.collection.JavaConverters._
+          jedisConnection.head.keys(key).asScala.mkString(",")
         } else if(method ==JedisMethod.SET && value.isDefined){
           if (ttlSeconds.isDefined) {//if set ttl, call `setex` method to set the expired seconds.
             jedisConnection.head.setex(key, ttlSeconds.get, value.get).toString

obp-api/src/main/scala/code/api/v6_0_0/APIMethods600.scala

@@ -8187,13 +8187,22 @@ trait APIMethods600 {
          |Counters automatically reset every hour (rolling window).
          |The ttl_seconds field shows when the current hour window resets.
          |
-         |Requires the props: write_connector_metrics_redis=true
+         |Requires the prop: write_connector_metrics_redis=true
+         |
+         |Redis key format:
+         |
+         |- Outbound (before connector call): {instance}_{env}_connector_outbound_{version}_{connectorName}_{methodName}_PER_HOUR
+         |- Inbound success (after connector call): {instance}_{env}_connector_inbound_{version}_{connectorName}_{methodName}_success_PER_HOUR
+         |- Inbound failure (after connector call): {instance}_{env}_connector_inbound_{version}_{connectorName}_{methodName}_failure_PER_HOUR
+         |
+         |For example: obp_dev_connector_outbound_1_star_getBanks_PER_HOUR
          |
          |Authentication is Required
          |
          |""".stripMargin,
       EmptyBody,
       ConnectorCountsJsonV600(
+        enabled = true,
         connector_counts = List(
           ConnectorCountJsonV600(
             connector_name = "mapped",
@@ -8221,6 +8230,7 @@ trait APIMethods600 {
           } yield {
             val counts = ConnectorCountsRedis.getAllCounts()
             val json = ConnectorCountsJsonV600(
+              enabled = ConnectorCountsRedis.isEnabled,
               connector_counts = counts.map(c => ConnectorCountJsonV600(
                 connector_name = c.connector_name,
                 method_name = c.method_name,

obp-api/src/main/scala/code/api/v6_0_0/JSONFactory6.0.0.scala

@@ -753,6 +753,7 @@ case class ConnectorCountJsonV600(
 )
 
 case class ConnectorCountsJsonV600(
+  enabled: Boolean,
   connector_counts: List[ConnectorCountJsonV600]
 )
 

obp-api/src/main/scala/code/metrics/ConnectorMetricsRedis.scala

@@ -92,7 +92,7 @@ object ConnectorCountsRedis extends MdcLoggable {
 
       // Scan for outbound keys
       val outboundPattern = s"${outboundPrefix}*_PER_HOUR"
-      val outboundKeys = Redis.use(JedisMethod.SCAN, outboundPattern).map(_.split(",").toList.filter(_.nonEmpty)).getOrElse(List.empty)
+      val outboundKeys = Redis.scanKeys(outboundPattern)
 
       // Build a map of connectorName_methodName -> outbound count
       val outboundMap: Map[String, Long] = outboundKeys.flatMap { key =>
@@ -104,7 +104,7 @@ object ConnectorCountsRedis extends MdcLoggable {
 
       // Scan for inbound keys
       val inboundPattern = s"${inboundPrefix}*_PER_HOUR"
-      val inboundKeys = Redis.use(JedisMethod.SCAN, inboundPattern).map(_.split(",").toList.filter(_.nonEmpty)).getOrElse(List.empty)
+      val inboundKeys = Redis.scanKeys(inboundPattern)
 
       // Build maps for success and failure inbound counts
       val inboundSuccessMap = scala.collection.mutable.Map[String, Long]()