feat(engine): Micrometer metrics by punitdarira · Pull Request #5337 · camunda/camunda-bpm-platform

punitdarira · 2025-08-07T00:03:24Z

related to #2771

This reverts commit a3c5911.

HeleneW-dot · 2025-08-08T08:33:31Z

Hi @punitdarira ,
Thank you for your submission. I have taken over the ticket from Petros and assigned myself to the PR for review. I will update here once I have done the code review or questions

HeleneW-dot · 2025-08-12T03:57:08Z

Hi @punitdarira
I would like to test your changes locally. I am following the steps you described in the ticket:

Add a basic main class in starter-rest and adjust the h2Database scope to compile
Add application.yml properties in starter-rest described in the PR:

camunda.bpm.metrics.actuator.interval=1
management.endpoints.web.exposure.include=metrics

Build from spring-boot-starter with mvn clean install -Dmaven.test.skip=true
Run from starter-rest with mvn clean spring-boot:run

I also started some small example processes to create data.
When I then request from http://localhost:8080/actuator/metrics I get this response:

actuator/metrics response

{
    "names": [
        "application.ready.time",
        "application.started.time",
        "disk.free",
        "disk.total",
        "executor.active",
        "executor.completed",
        "executor.pool.core",
        "executor.pool.max",
        "executor.pool.size",
        "executor.queue.remaining",
        "executor.queued",
        "http.server.requests.active",
        "jvm.buffer.count",
        "jvm.buffer.memory.used",
        "jvm.buffer.total.capacity",
        "jvm.classes.loaded",
        "jvm.classes.unloaded",
        "jvm.compilation.time",
        "jvm.gc.concurrent.phase.time",
        "jvm.gc.live.data.size",
        "jvm.gc.max.data.size",
        "jvm.gc.memory.allocated",
        "jvm.gc.memory.promoted",
        "jvm.gc.overhead",
        "jvm.gc.pause",
        "jvm.info",
        "jvm.memory.committed",
        "jvm.memory.max",
        "jvm.memory.usage.after.gc",
        "jvm.memory.used",
        "jvm.threads.daemon",
        "jvm.threads.live",
        "jvm.threads.peak",
        "jvm.threads.started",
        "jvm.threads.states",
        "logback.events",
        "process.cpu.time",
        "process.cpu.usage",
        "process.files.max",
        "process.files.open",
        "process.start.time",
        "process.uptime",
        "system.cpu.count",
        "system.cpu.usage",
        "system.load.average.1m",
        "tomcat.sessions.active.current",
        "tomcat.sessions.active.max",
        "tomcat.sessions.alive.max",
        "tomcat.sessions.created",
        "tomcat.sessions.expired",
        "tomcat.sessions.rejected"
    ]
}

To me this looks like default actuator response. I was expecting to see some camunda specific metrics here as well, is that a correct expectation? Can you provide testing steps specifically to see the micrometer changes you've implemented?
Thank you,
Helene

punitdarira · 2025-08-12T12:31:05Z

Hi @HeleneW-dot,
The default time interval for reporting metrics to the db is 15 minutes. Unless we reduce the db reporting time, you would be able to see the metrics in actuator in 15 minutes .

HeleneW-dot · 2025-08-26T01:49:33Z

Hi @punitdarira , I assumed camunda.bpm.metrics.actuator.interval=1 would set this interval to 1 minute, is that not correct?

punitdarira · 2025-08-28T04:14:14Z

Hi @HeleneW-dot,
Yes this property doesn't set the interval of db reporting, just the actuator interval.
Maybe we should update the db reporting interval as well with this property. What are your views on it?

HeleneW-dot · 2025-08-31T10:46:55Z

Hi @punitdarira

The default time interval for reporting metrics to the db is 15 minutes. Unless we reduce the db reporting time, you would be able to see the metrics in actuator in 15 minutes .

I tried with the same steps, this time waiting 40 minutes just to be sure but got the same result. Are there any other changes I would need to make? Can you please provide a guide on how to use this feature that I can follow for local testing? Thank you.

Yes this property doesn't set the interval of db reporting, just the actuator interval. Maybe we should update the db reporting interval as well with this property. What are your views on it?

I would say lets not divert from the technical proposal discussed in the ticket for now because it looks like that has already been reviewed by the team. Once I can test and review the code and gained some more insight we can revisit

Thank you,
Helene

punitdarira · 2025-09-02T19:01:26Z

Hi @HeleneW-dot,
The last commit on this branch has all the local changes which I use to run this feature
https://github.com/punitdarira/camunda-bpm-platform/tree/micrometer-local-testing
The steps I did-
ran mvn clean install -DskipTests on camunda-bpm-spring-boot-starter and camunda-bpm-spring-boot-starter-rest
then ran mvn spring-boot:run on camunda-bpm-spring-boot-starter-rest
I've added some debug sysouts "Inside init" and "inside run"
We should be getting these debug messages when we run the project.

HeleneW-dot · 2025-09-17T10:20:51Z

Hi @punitdarira ,
Thanks, this worked for me I can now see the camunda metrics on the endpoint. I see in your repo you added these dependencies:

<dependency>
      <groupId>org.graalvm.js</groupId>
      <artifactId>js</artifactId>
      <version>22.0.0</version>
    </dependency>
    <dependency>
      <groupId>org.graalvm.js</groupId>
      <artifactId>js-scriptengine</artifactId>
      <version>22.0.0</version>
   </dependency>

Are these required to make the micrometer metrics work?

punitdarira · 2025-09-21T22:26:49Z

Hi @HeleneW-dot
No they are not required for micrometer metrics to work. They were used to run JavaScript code in the .bpmn files.

HeleneW-dot · 2025-09-22T08:18:41Z

PR to run CI: #5428

HeleneW-dot · 2025-09-22T08:20:34Z

Hi @punitdarira ,
thanks, I am running CI on the changes now and will do a proper review. Would you also be able to submit a PR to document this feature, especially the configuration options?

HeleneW-dot

Hi @punitdarira ,
thanks again for your contribution. I've reviewed the changes and the code looks good to me. Please add the missing license header. The branch should also be rebased on up to date master since its been a while.
I think it would make sense to add some documentation for this as well, see my previous comment.

I am running CI on these changes now and will update here once the tests have run.

HeleneW-dot · 2025-09-22T08:11:50Z

...c/main/java/org/camunda/bpm/spring/boot/starter/actuator/MicrometerMetricsReportingTask.java

+
+

Suggested change

HeleneW-dot · 2025-09-22T08:12:10Z

...c/main/java/org/camunda/bpm/spring/boot/starter/actuator/MicrometerMetricsReportingTask.java

+    public void run() {
+        List<MetricIntervalValue> metricsList = processEngine.getManagementService()
+                .createMetricsQuery().interval(1);
+        if(metricsList.isEmpty()){


Suggested change

if(metricsList.isEmpty()){

if(metricsList.isEmpty()) {

HeleneW-dot · 2025-09-22T08:12:48Z

...c/main/java/org/camunda/bpm/spring/boot/starter/actuator/MicrometerMetricsReportingTask.java

+        if(metricsList.isEmpty()){
+            return;
+        }
+        metricsList.forEach(metric ->{


Suggested change

metricsList.forEach(metric ->{

metricsList.forEach(metric -> {

HeleneW-dot · 2025-09-22T09:59:03Z

...er/src/main/java/org/camunda/bpm/spring/boot/starter/actuator/MicrometerMetricsReporter.java

@@ -0,0 +1,42 @@
+package org.camunda.bpm.spring.boot.starter.actuator;


Missing license header

HeleneW-dot · 2025-09-22T09:59:12Z

...c/main/java/org/camunda/bpm/spring/boot/starter/actuator/MicrometerMetricsReportingTask.java

@@ -0,0 +1,41 @@
+package org.camunda.bpm.spring.boot.starter.actuator;


Missing license header

HeleneW-dot · 2025-09-22T09:59:29Z

...ter/starter/src/main/java/org/camunda/bpm/spring/boot/starter/property/ActuatorProperty.java

@@ -0,0 +1,25 @@
+package org.camunda.bpm.spring.boot.starter.property;


Missing license header

HeleneW-dot · 2025-09-22T09:59:35Z

...nda/bpm/spring/boot/starter/actuator/micrometer/metrics/ActuatorMetricsPropertyAbsentIT.java

@@ -0,0 +1,27 @@
+package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;


Missing license header

HeleneW-dot · 2025-09-22T09:59:39Z

...da/bpm/spring/boot/starter/actuator/micrometer/metrics/ActuatorMetricsPropertyDefaultIT.java

@@ -0,0 +1,28 @@
+package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;


Missing license header

HeleneW-dot · 2025-09-22T09:59:45Z

...da/bpm/spring/boot/starter/actuator/micrometer/metrics/ActuatorMetricsPropertyInvalidIT.java

@@ -0,0 +1,37 @@
+package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;


Missing license header

HeleneW-dot · 2025-09-22T09:59:49Z

...unda/bpm/spring/boot/starter/actuator/micrometer/metrics/ActuatorMetricsPropertyValidIT.java

@@ -0,0 +1,63 @@
+package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;


Missing license header

HeleneW-dot · 2025-09-24T07:31:22Z

Hi @punitdarira ,
After rebasing on master and adding the missing license headers, CI has passed on the changes. Please implement the suggestions I left above, then I can approve the PR 🚀
Also it would be great if you could open a documentation PR for review as well.

Thank you,
Helene

tasso94 · 2025-10-29T13:05:24Z

Hi @punitdarira,

Camunda 7 CE is end-of-life.

Have you checked out our next-generation automation platform, C8, already?
https://github.com/camunda/camunda

Feel free to contribute to this repository in the future.

We will soon archive this repository.

Best,
Tassilo

punitdarira added 9 commits August 4, 2024 22:14

feat(engine): Micrometer metrics

ed4d581

related to camunda#2771

feat(engine): Metrics interval

94a58c3

related to camunda#2771

Merge branch 'camunda:master' into master

ea6dad2

Merge branch 'camunda:master' into master

4612b6b

feat(rest): Adding actuator metrics interval

dad0fde

related to camunda#2771

Formatting PC. Pushing everything

a3c5911

feat(rest): Test cases for Camunda Actuator metrics

65a4900

Revert "Formatting PC. Pushing everything"

e0135e3

This reverts commit a3c5911.

feat(rest): Fixing typo

0811997

HeleneW-dot self-assigned this Aug 7, 2025

HeleneW-dot assigned punitdarira and unassigned HeleneW-dot Sep 17, 2025

HeleneW-dot self-requested a review September 17, 2025 08:39

HeleneW-dot suggested changes Sep 22, 2025

View reviewed changes

Survival26 approved these changes Sep 25, 2025

View reviewed changes

tasso94 closed this Oct 29, 2025

HeleneW-dot mentioned this pull request Oct 30, 2025

Integrate Camunda metrics into Spring Boot Actuator registry #2771

Closed

1 task

	metricsList.forEach(metric ->{
	metricsList.forEach(metric -> {

		@@ -0,0 +1,42 @@
		package org.camunda.bpm.spring.boot.starter.actuator;

		@@ -0,0 +1,41 @@
		package org.camunda.bpm.spring.boot.starter.actuator;

		@@ -0,0 +1,25 @@
		package org.camunda.bpm.spring.boot.starter.property;

		@@ -0,0 +1,27 @@
		package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;

		@@ -0,0 +1,28 @@
		package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;

		@@ -0,0 +1,37 @@
		package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;

		@@ -0,0 +1,63 @@
		package org.camunda.bpm.spring.boot.starter.actuator.micrometer.metrics;

Conversation

punitdarira commented Aug 7, 2025

Uh oh!

HeleneW-dot commented Aug 8, 2025

Uh oh!

HeleneW-dot commented Aug 12, 2025

Uh oh!

punitdarira commented Aug 12, 2025

Uh oh!

HeleneW-dot commented Aug 26, 2025

Uh oh!

punitdarira commented Aug 28, 2025

Uh oh!

HeleneW-dot commented Aug 31, 2025

Uh oh!

punitdarira commented Sep 2, 2025

Uh oh!

HeleneW-dot commented Sep 17, 2025

Uh oh!

punitdarira commented Sep 21, 2025

Uh oh!

HeleneW-dot commented Sep 22, 2025

Uh oh!

HeleneW-dot commented Sep 22, 2025

Uh oh!

HeleneW-dot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

HeleneW-dot commented Sep 24, 2025

Uh oh!

tasso94 commented Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

HeleneW-dot left a comment •

edited

Loading