[backend] feat: adding spring actuator to collect metrics (#4438)

[heditar]

Proposed changes

• Adding spring actuator to OpenAev, disabled by default but will be used in the test instances to collect metrics during performance tests

Testing Instructions

1. Uncomment the configuration and call localhost:8080/actuator

Related issues

• Closes [Performance tests] Add Latency/Cpu/Memory metrics to OpenAev #4438

Checklist

• I consider the submitted work as finished
• I tested the code for its functionality
• [NA] I wrote test cases for the relevant uses case
• [NA] I added/update the relevant documentation (either on github or on notion)
• [NA] Where necessary I refactored code to improve the overall quality
• [NA] For bug fix -> I implemented a test that covers the bug

[Dimfacion]

suggestion : I think we should add commented code in AppSecurityConfig.java that allows calls to /actuator/ so that it's easier for people to understand what they need to activate if they want the metrics working. Wdyt ?

[heditar]

suggestion : I think we should add commented code in AppSecurityConfig.java that allows calls to /actuator/ so that it's easier for people to understand what they need to activate if they want the metrics working. Wdyt ?

That is working for me as it is without any modification to AppSecurityConfig

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 52.78%. Comparing base (5772942) to head (516e631).

Additional details and impacted files

@@                  Coverage Diff                  @@
##             release/current    #4585      +/-   ##
=====================================================
+ Coverage              52.74%   52.78%   +0.04%     
- Complexity              4119     4122       +3     
=====================================================
  Files                    963      963              
  Lines                  28942    28944       +2     
  Branches                2152     2152              
=====================================================
+ Hits                   15265    15279      +14     
+ Misses                 12779    12769      -10     
+ Partials                 898      896       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[heditar]

suggestion : I think we should add commented code in AppSecurityConfig.java that allows calls to /actuator/ so that it's easier for people to understand what they need to activate if they want the metrics working. Wdyt ?

That is working for me as it is without any modification to AppSecurityConfig

I actually added the code in AppSecurityConfig to only allow metrics api to authenticated users

[Copilot]

Pull request overview

This PR adds Spring Boot Actuator integration to OpenAEV for collecting metrics during performance testing. The actuator endpoints are disabled by default for security but can be enabled via configuration for test instances.

Key Changes:

• Added Spring Boot Actuator and Micrometer Prometheus dependencies
• Configured actuator endpoints (disabled by default, with commented example for enabling metrics/prometheus)
• Secured actuator endpoints with authentication requirement

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
openaev-api/pom.xml	Added spring-boot-starter-actuator and micrometer-registry-prometheus dependencies
openaev-api/src/main/resources/application.properties	Added actuator configuration properties with endpoints disabled by default
openaev-api/src/main/java/io/openaev/config/AppSecurityConfig.java	Added authentication requirement for /actuator/** endpoints

[Copilot]

The management.server.port is set to 8080, which is likely the same port as the main application server. This will cause a port conflict when the actuator endpoints are enabled. Consider using a different port (e.g., 8081) for the management server or remove this property to use the same port as the main application without creating a separate management server.

Suggested change

	management.endpoint.health.show-details=always
	management.server.port=8080
	management.endpoint.health.show-details=always

[Copilot]

The empty value for management.endpoints.web.exposure.include could be unclear to users. Consider adding a comment explaining that an empty value disables all endpoints, or explicitly set it to 'none' for clarity.

Suggested change

	# Enable actuator -> disabled by default
	# Enable actuator -> disabled by default
	# Leaving this value empty disables exposure of all actuator endpoints.