From c72d817ad1affe16ec7cc61c3320af86245cdd75 Mon Sep 17 00:00:00 2001 From: Daniel Kelemen Date: Fri, 18 Mar 2022 15:07:47 +0100 Subject: [PATCH] feat(engine/admin): rename metrics to match sales wording - remove flow-node-instances-end - rename flow-node-instances-start - adapt code & tests related to CAM-13636 --- .../src/main/templates/paths/metrics/get.ftl | 7 +++---- .../templates/paths/metrics/{metrics-name}/sum/get.ftl | 3 +-- .../src/main/templates/paths/telemetry/data/get.ftl | 2 +- .../bpm/engine/rest/TelemetryRestServiceTest.java | 2 +- .../camunda/bpm/engine/rest/helper/MockProvider.java | 2 +- .../bpm/engine/impl/metrics/util/MetricsUtil.java | 8 ++++---- .../org/camunda/bpm/engine/management/Metrics.java | 3 +-- .../mgmt/ManagementServiceGetTelemetryDataTest.java | 10 +++++----- .../mgmt/metrics/ActivityInstanceCountMetricsTest.java | 2 +- .../test/api/mgmt/metrics/MetricsIntervalTest.java | 4 ++-- .../bpm/engine/test/api/mgmt/metrics/MetricsTest.java | 6 +++--- .../ui/admin/client/scripts/pages/execution-metrics.js | 2 +- 12 files changed, 24 insertions(+), 27 deletions(-) diff --git a/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/get.ftl b/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/get.ftl index 81b75ef6138..316c5172e77 100644 --- a/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/get.ftl +++ b/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/get.ftl @@ -15,8 +15,7 @@ enumValues = ["activity-instance-start", "activity-instance-end", "decision-instances", - "flow-node-instances-start", - "flow-node-instances-end", + "flow-node-instances", "job-acquisition-attempt", "job-acquired-success", "job-acquired-failure", @@ -83,11 +82,11 @@ array = true desc = "Request successful." examples = ['"example-1": { - "summary": "GET /metrics?name=flow-node-instances-end&startDate=1970-01-01T01:45:00.000%2b0200&endDate=1970-01-01T02:00:00.000%2b0200", + "summary": "GET /metrics?name=flow-node-instances&startDate=1970-01-01T01:45:00.000%2b0200&endDate=1970-01-01T02:00:00.000%2b0200", "value": [ { "timestamp":"1970-01-01T01:45:00.000+0200", - "name":"flow-node-instances-end", + "name":"flow-node-instances", "reporter":"REPORTER", "value":23 } diff --git a/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/{metrics-name}/sum/get.ftl b/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/{metrics-name}/sum/get.ftl index 08ea3947b57..22642eee190 100644 --- a/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/{metrics-name}/sum/get.ftl +++ b/engine-rest/engine-rest-openapi/src/main/templates/paths/metrics/{metrics-name}/sum/get.ftl @@ -16,8 +16,7 @@ enumValues = ["activity-instance-start", "activity-instance-end", "decision-instances", - "flow-node-instances-start", - "flow-node-instances-end", + "flow-node-instances", "job-acquisition-attempt", "job-acquired-success", "job-acquired-failure", diff --git a/engine-rest/engine-rest-openapi/src/main/templates/paths/telemetry/data/get.ftl b/engine-rest/engine-rest-openapi/src/main/templates/paths/telemetry/data/get.ftl index 8eede8c8a96..49c2bac10c6 100644 --- a/engine-rest/engine-rest-openapi/src/main/templates/paths/telemetry/data/get.ftl +++ b/engine-rest/engine-rest-openapi/src/main/templates/paths/telemetry/data/get.ftl @@ -44,7 +44,7 @@ }, "metrics": { "process-instances": { "count": 936 }, - "flow-node-instances-start": { "count": 6125 }, + "flow-node-instances": { "count": 6125 }, "decision-instances": { "count": 140 }, "executed-decision-elements": { "count": 732 } }, diff --git a/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/TelemetryRestServiceTest.java b/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/TelemetryRestServiceTest.java index 90be49539f9..67d29025eb8 100644 --- a/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/TelemetryRestServiceTest.java +++ b/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/TelemetryRestServiceTest.java @@ -205,7 +205,7 @@ public void shouldGetTelemetryData() throws JsonProcessingException { .body("product.internals.commands.FetchExternalTasksCmd.count", equalTo(100)) .body("product.internals.commands.StartProcessInstanceCmd.count", equalTo(40)) .body("product.internals.metrics.process-instances.count", equalTo(936)) - .body("product.internals.metrics.flow-node-instances-start.count", equalTo(6125)) + .body("product.internals.metrics.flow-node-instances.count", equalTo(6125)) .body("product.internals.metrics.executed-decision-elements.count", equalTo(732)) .body("product.internals.metrics.decision-instances.count", equalTo(140)) .body("product.internals.webapps[0]", equalTo("cockpit")) diff --git a/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/helper/MockProvider.java b/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/helper/MockProvider.java index e75100bb565..b0512b4f78e 100644 --- a/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/helper/MockProvider.java +++ b/engine-rest/engine-rest/src/test/java/org/camunda/bpm/engine/rest/helper/MockProvider.java @@ -1015,7 +1015,7 @@ public abstract class MockProvider { .setCommands(Stream.of(new Object[][] { { "StartProcessInstanceCmd", 40 }, { "FetchExternalTasksCmd", 100 } }) .collect(Collectors.toMap(data -> (String) data[0], data -> new CommandImpl((Integer) data[1])))); EXAMPLE_TELEMETRY_INTERNALS.setMetrics(Stream - .of(new Object[][] { { "process-instances", 936L }, { "flow-node-instances-start", 6125L }, + .of(new Object[][] { { "process-instances", 936L }, { "flow-node-instances", 6125L }, { "decision-instances", 140L }, { "executed-decision-elements", 732L } }) .collect(Collectors.toMap(data -> (String) data[0], data -> new MetricImpl((Long) data[1])))); EXAMPLE_TELEMETRY_INTERNALS.setCamundaIntegration(Collections.singleton("spring-boot")); diff --git a/engine/src/main/java/org/camunda/bpm/engine/impl/metrics/util/MetricsUtil.java b/engine/src/main/java/org/camunda/bpm/engine/impl/metrics/util/MetricsUtil.java index 730213522f5..5880328f5e7 100644 --- a/engine/src/main/java/org/camunda/bpm/engine/impl/metrics/util/MetricsUtil.java +++ b/engine/src/main/java/org/camunda/bpm/engine/impl/metrics/util/MetricsUtil.java @@ -27,12 +27,12 @@ public class MetricsUtil { * @return the internal name */ public static String resolveInternalName(final String publicName) { + if (publicName == null) return null; switch (publicName) { case Metrics.TASK_USERS: return Metrics.UNIQUE_TASK_WORKERS; case Metrics.PROCESS_INSTANCES: return Metrics.ROOT_PROCESS_INSTANCE_START; case Metrics.DECISION_INSTANCES: return Metrics.EXECUTED_DECISION_INSTANCES; - case Metrics.FLOW_NODE_INSTANCES_START: return Metrics.ACTIVTY_INSTANCE_START; - case Metrics.FLOW_NODE_INSTANCES_END: return Metrics.ACTIVTY_INSTANCE_END; + case Metrics.FLOW_NODE_INSTANCES: return Metrics.ACTIVTY_INSTANCE_START; default: return publicName; } } @@ -44,12 +44,12 @@ public static String resolveInternalName(final String publicName) { * @return the public name */ public static String resolvePublicName(final String internalName) { + if (internalName == null) return null; switch (internalName) { case Metrics.UNIQUE_TASK_WORKERS: return Metrics.TASK_USERS; case Metrics.ROOT_PROCESS_INSTANCE_START: return Metrics.PROCESS_INSTANCES; case Metrics.EXECUTED_DECISION_INSTANCES: return Metrics.DECISION_INSTANCES; - case Metrics.ACTIVTY_INSTANCE_START: return Metrics.FLOW_NODE_INSTANCES_START; - case Metrics.ACTIVTY_INSTANCE_END: return Metrics.FLOW_NODE_INSTANCES_END; + case Metrics.ACTIVTY_INSTANCE_START: return Metrics.FLOW_NODE_INSTANCES; default: return internalName; } } diff --git a/engine/src/main/java/org/camunda/bpm/engine/management/Metrics.java b/engine/src/main/java/org/camunda/bpm/engine/management/Metrics.java index 2d5f2341820..138962fb6d1 100644 --- a/engine/src/main/java/org/camunda/bpm/engine/management/Metrics.java +++ b/engine/src/main/java/org/camunda/bpm/engine/management/Metrics.java @@ -24,8 +24,7 @@ public class Metrics { public static final String ACTIVTY_INSTANCE_START = "activity-instance-start"; public static final String ACTIVTY_INSTANCE_END = "activity-instance-end"; - public static final String FLOW_NODE_INSTANCES_START = "flow-node-instances-start"; - public static final String FLOW_NODE_INSTANCES_END = "flow-node-instances-end"; + public static final String FLOW_NODE_INSTANCES = "flow-node-instances"; /** * Number of times job acquisition is performed diff --git a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/ManagementServiceGetTelemetryDataTest.java b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/ManagementServiceGetTelemetryDataTest.java index 691ebbc865c..8205c641d0a 100644 --- a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/ManagementServiceGetTelemetryDataTest.java +++ b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/ManagementServiceGetTelemetryDataTest.java @@ -20,7 +20,7 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.camunda.bpm.engine.management.Metrics.DECISION_INSTANCES; import static org.camunda.bpm.engine.management.Metrics.EXECUTED_DECISION_ELEMENTS; -import static org.camunda.bpm.engine.management.Metrics.FLOW_NODE_INSTANCES_START; +import static org.camunda.bpm.engine.management.Metrics.FLOW_NODE_INSTANCES; import static org.camunda.bpm.engine.management.Metrics.PROCESS_INSTANCES; import java.util.Map; import org.camunda.bpm.engine.ProcessEngineException; @@ -196,8 +196,8 @@ public void shouldStartWithMetricsCountZero() { // then Map metrics = telemetryData.getProduct().getInternals().getMetrics(); - assertThat(metrics).containsOnlyKeys(FLOW_NODE_INSTANCES_START, PROCESS_INSTANCES, EXECUTED_DECISION_ELEMENTS, DECISION_INSTANCES); - assertThat(metrics.get(FLOW_NODE_INSTANCES_START).getCount()).isZero(); + assertThat(metrics).containsOnlyKeys(FLOW_NODE_INSTANCES, PROCESS_INSTANCES, EXECUTED_DECISION_ELEMENTS, DECISION_INSTANCES); + assertThat(metrics.get(FLOW_NODE_INSTANCES).getCount()).isZero(); assertThat(metrics.get(PROCESS_INSTANCES).getCount()).isZero(); assertThat(metrics.get(EXECUTED_DECISION_ELEMENTS).getCount()).isZero(); assertThat(metrics.get(DECISION_INSTANCES).getCount()).isZero(); @@ -215,7 +215,7 @@ public void shouldNotResetMetricsCount() { TelemetryData telemetryData = managementService.getTelemetryData(); // then count should not reset - assertThat(telemetryData.getProduct().getInternals().getMetrics().get(FLOW_NODE_INSTANCES_START).getCount()).isEqualTo(2); + assertThat(telemetryData.getProduct().getInternals().getMetrics().get(FLOW_NODE_INSTANCES).getCount()).isEqualTo(2); assertThat(telemetryData.getProduct().getInternals().getMetrics().get(PROCESS_INSTANCES).getCount()).isEqualTo(1); } @@ -339,7 +339,7 @@ public void shouldResetCollectedMetricsDataWhenTelemetryEnabled() { // then metrics produced before telemetry was enabled should be deleted Map metrics = telemetryData.getProduct().getInternals().getMetrics(); assertThat(metrics.size()).isEqualTo(4); - assertThat(metrics.get(FLOW_NODE_INSTANCES_START).getCount()).isEqualTo(2); + assertThat(metrics.get(FLOW_NODE_INSTANCES).getCount()).isEqualTo(2); assertThat(metrics.get(PROCESS_INSTANCES).getCount()).isEqualTo(1); assertThat(metrics.get(DECISION_INSTANCES).getCount()).isEqualTo(0); assertThat(metrics.get(EXECUTED_DECISION_ELEMENTS).getCount()).isEqualTo(0); diff --git a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/ActivityInstanceCountMetricsTest.java b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/ActivityInstanceCountMetricsTest.java index 6c77f93dc71..3922ffea55d 100644 --- a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/ActivityInstanceCountMetricsTest.java +++ b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/ActivityInstanceCountMetricsTest.java @@ -68,7 +68,7 @@ public void testBpmnActivityInstances() { // still 3 with the new metric name assertEquals(3l, managementService.createMetricsQuery() - .name(Metrics.FLOW_NODE_INSTANCES_START) + .name(Metrics.FLOW_NODE_INSTANCES) .sum()); } diff --git a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsIntervalTest.java b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsIntervalTest.java index 15012c928ce..43141498b47 100644 --- a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsIntervalTest.java +++ b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsIntervalTest.java @@ -232,7 +232,7 @@ public void testMeterQueryDefaultIntervalWhereName() { metrics.remove(0); for (MetricIntervalValue metric : metrics) { assertEquals(name, metric.getName()); - assertEquals(Metrics.FLOW_NODE_INSTANCES_START, metric.getName()); + assertEquals(Metrics.FLOW_NODE_INSTANCES, metric.getName()); long nextTimestamp = metric.getTimestamp().getTime(); if (lastTimestamp != nextTimestamp) { assertEquals(lastTimestamp, nextTimestamp + DEFAULT_INTERVAL_MILLIS); @@ -268,7 +268,7 @@ public void testMeterQueryCustomIntervalWhereName() { metrics.remove(0); for (MetricIntervalValue metric : metrics) { assertEquals(name, metric.getName()); - assertEquals(Metrics.FLOW_NODE_INSTANCES_START, metric.getName()); + assertEquals(Metrics.FLOW_NODE_INSTANCES, metric.getName()); long nextTimestamp = metric.getTimestamp().getTime(); if (lastTimestamp != nextTimestamp) { assertEquals(lastTimestamp, nextTimestamp + interval); diff --git a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsTest.java b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsTest.java index dc5f37cab95..9c0242f24ec 100644 --- a/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsTest.java +++ b/engine/src/test/java/org/camunda/bpm/engine/test/api/mgmt/metrics/MetricsTest.java @@ -102,7 +102,7 @@ public void testStartAndEndMetricsAreEqual() { .name(Metrics.ACTIVTY_INSTANCE_END) .sum(); assertEquals(end, start); - assertEquals(end, managementService.createMetricsQuery().name(Metrics.FLOW_NODE_INSTANCES_END).sum()); + assertEquals(start, managementService.createMetricsQuery().name(Metrics.FLOW_NODE_INSTANCES).sum()); } @Test @@ -126,7 +126,7 @@ public void testEndMetricWithWaitState() { .name(Metrics.ACTIVTY_INSTANCE_END) .sum(); assertNotEquals(end, start); - assertEquals(end, managementService.createMetricsQuery().name(Metrics.FLOW_NODE_INSTANCES_END).sum()); + assertEquals(start, managementService.createMetricsQuery().name(Metrics.FLOW_NODE_INSTANCES).sum()); assertEquals(2, start); assertEquals(1, end); @@ -142,7 +142,7 @@ public void testEndMetricWithWaitState() { .name(Metrics.ACTIVTY_INSTANCE_END) .sum(); assertEquals(end, start); - assertEquals(end, managementService.createMetricsQuery().name(Metrics.FLOW_NODE_INSTANCES_END).sum()); + assertEquals(start, managementService.createMetricsQuery().name(Metrics.FLOW_NODE_INSTANCES).sum()); } @Test diff --git a/webapps/ui/admin/client/scripts/pages/execution-metrics.js b/webapps/ui/admin/client/scripts/pages/execution-metrics.js index 78875ae4f31..b8d8a805ca9 100644 --- a/webapps/ui/admin/client/scripts/pages/execution-metrics.js +++ b/webapps/ui/admin/client/scripts/pages/execution-metrics.js @@ -134,7 +134,7 @@ var Controller = [ flowNodes: function(cb) { MetricsResource.sum( { - name: 'flow-node-instances-start', + name: 'flow-node-instances', startDate: fixDate($scope.startDate), endDate: fixDate($scope.endDate) },