Merge pull request #134 from Cinimex-Informatica/feature/issue45_add_queue_fill

Add mqobject_queue_queue_fill_percentage metric

Author: echerniak

README.md

@@ -1400,6 +1400,11 @@ This section provides a description of metrics of queues, channels and listeners
 <td>Shows maximum number of messages that are allowed on the queue.</td>
 </tr>
 <tr>
+<td>mqobject_queue_queue_fill_percentage</td>
+<td>gauge</td>
+<td>Shows queue fill percentage.</td>
+</tr>
+<tr>
 <td>mqobject_channel_channel_status_hundredths</td>
 <td>gauge</td>
 <td>Shows current channel status. Mapping of channel statuses to prometheus metric values can be found <a href="#channel-status-mapping">here</a>.</td>

src/main/java/ru/cinimex/exporter/prometheus/metrics/MetricManagerUtils.java

@@ -32,6 +32,7 @@ public static List<String> getUpdatedMetricNames() {
         updatedMetricNames.add("mqobject_get_average_destructive_mqget_persistent_message_size_bytes");
         updatedMetricNames.add("mqobject_get_average_destructive_mqget_non_persistent_message_size_bytes");
         updatedMetricNames.add("mqobject_get_average_destructive_mqget_persistent_and_non_persistent_message_size_bytes");
+        updatedMetricNames.add("mqobject_queue_queue_fill_percentage");
         return updatedMetricNames;
     }
 
@@ -57,6 +58,10 @@ public static List<String> getMetricsNamesUsedToUpdate(String updatedMetricName)
                 listWithNames.add("mqobject_get_destructive_mqget_persistent_message_count_totalmessages");
                 listWithNames.add("mqobject_get_destructive_mqget_non_persistent_message_count_totalmessages");
                 break;
+            case "mqobject_queue_queue_fill_percentage":
+                listWithNames.add("mqobject_queue_queue_depth_messages");
+                listWithNames.add("mqobject_queue_queue_max_depth_messages");
+                break;
             default:
                 break;
         }
@@ -74,6 +79,8 @@ public static Function<List<Double>, Double> getConversionFunction(String update
                 return MetricManagerUtils::division;
             case "mqobject_get_average_destructive_mqget_persistent_and_non_persistent_message_size_bytes":
                 return MetricManagerUtils::averageSum;
+            case "mqobject_get_queue_queue_fill_percentage":
+                return MetricManagerUtils::divisionInPercentage;
             default:
                 return MetricManagerUtils::defaultConversion;
         }
@@ -91,6 +98,12 @@ private static Double division(List<Double> params) {
         return params.get(1) == 0.0 ? 0.0 : params.get(0) / params.get(1);
     }
 
+    private static Double divisionInPercentage(List<Double> params) {
+        Objects.requireNonNull(params);
+        if (params.size() != 2) throw new IllegalArgumentException();
+        return params.get(1) == 0.0 ? 0.0 : params.get(0) / (params.get(1) * 100);
+    }
+
     private static Double defaultConversion(List<Double> params) {
         return Objects.requireNonNull(params).get(0);
     }

src/main/java/ru/cinimex/exporter/prometheus/metrics/MetricsReference.java

@@ -174,6 +174,7 @@ public static Map<String, Metric> getAdditionalMqObjectMetricsReference() {
         metrics.put("destructive MQGET persistent average message byte count", new Metric("mqobject_get_average_destructive_mqget_persistent_message_size_bytes", Metric.Type.SIMPLE_GAUGE));
         metrics.put("destructive MQGET non-persistent average message byte count", new Metric("mqobject_get_average_destructive_mqget_non_persistent_message_size_bytes", Metric.Type.SIMPLE_GAUGE));
         metrics.put("destructive MQGET persistent and non-persistent average message byte count", new Metric("mqobject_get_average_destructive_mqget_persistent_and_non_persistent_message_size_bytes", Metric.Type.SIMPLE_GAUGE));
+        metrics.put("queue fill percentage", new Metric("mqobject_queue_queue_fill_percentage", Metric.Type.SIMPLE_GAUGE));
         return metrics;
     }
 

src/test/java/ru/cinimex/exporter/prometheus/metrics/MetricManagerUtilsTest.java

@@ -16,6 +16,7 @@ static void initMetrics() {
         updatedMetricNames.add("mqobject_get_average_destructive_mqget_persistent_message_size_bytes");
         updatedMetricNames.add("mqobject_get_average_destructive_mqget_non_persistent_message_size_bytes");
         updatedMetricNames.add("mqobject_get_average_destructive_mqget_persistent_and_non_persistent_message_size_bytes");
+        updatedMetricNames.add("mqobject_queue_queue_fill_percentage");
     }
 
     @Test
@@ -44,5 +45,11 @@ void getMetricsNamesUsedToUpdate() {
         listWithNames.add("mqobject_get_destructive_mqget_non_persistent_message_count_totalmessages");
 
         assertEquals(listWithNames, MetricManagerUtils.getMetricsNamesUsedToUpdate(updatedMetricNames.get(2)));
+
+        listWithNames = new ArrayList<>();
+        listWithNames.add("mqobject_queue_queue_depth_messages");
+        listWithNames.add("mqobject_queue_queue_max_depth_messages");
+
+        assertEquals(listWithNames, MetricManagerUtils.getMetricsNamesUsedToUpdate(updatedMetricNames.get(3)));
     }
 }