Add support for JFinal #15216

pepeshore · 2025-11-04T13:18:44Z

resolved #11465

Change-Id: Ia3b5f6b74b40763c4df7fa0185223575a2c1b068

…rser

Change-Id: I39d2ce579c60d5afa2e792f3296eef5d0b495443

…r' into feature/additonal-jdbc-url-parser Change-Id: I5b6ee06da60fc32dc1edece63948d228c95f710b

Change-Id: Ic7a1bdab51668642fb2c3e4b775ce30f4e1a841c

…r' into feature/additonal-jdbc-url-parser Change-Id: I6205bbedb81199c2bded7b78112389ca0b935636

Change-Id: Ie9d2a16071e77ce12f386227faaff4a4927512be

otelbot-java-instrumentation · 2025-11-04T13:29:40Z

🔧 The result from spotlessApply was committed to the PR branch.

Copilot

Pull Request Overview

This PR adds OpenTelemetry Java agent instrumentation support for JFinal 3.6, a lightweight Java MVC framework. The instrumentation enables automatic tracing of HTTP requests handled by JFinal applications.

Key changes:

Implements instrumentation for JFinal's ActionHandler and ActionMapping components to create spans and capture HTTP routes
Adds comprehensive test coverage including various HTTP endpoints, error handling, and span relationship validation
Excludes OpenTelemetry attributes from JFinal's JsonRender to prevent serialization issues

Reviewed Changes

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

Show a summary per file

File	Description
settings.gradle.kts	Adds the new jfinal-3.6:javaagent module to the build
TestController.java	Test controller implementing various HTTP endpoints for instrumentation testing
TestConfig.java	JFinal configuration class for test setup
JFinalTest.java	Integration test suite validating instrumentation behavior
JFinalSingletons.java	Core instrumentation logic including instrumenter setup and route extraction
JFinalInstrumentationModule.java	Module definition for JFinal instrumentation
ActionMappingInstrumentation.java	Instrumentation for ActionMapping.getAction() to extract HTTP routes
ActionHandlerInstrumentation.java	Instrumentation for ActionHandler.handle() to create handler spans
build.gradle.kts	Build configuration with dependencies and test settings

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

settings.gradle.kts

...avaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jfinal/TestController.java

...ain/java/io/opentelemetry/javaagent/instrumentation/jfinal/ActionMappingInstrumentation.java

instrumentation/jfinal-3.6/javaagent/build.gradle.kts

settings.gradle.kts

...main/java/io/opentelemetry/javaagent/instrumentation/jfinal/JFinalInstrumentationModule.java

...ain/java/io/opentelemetry/javaagent/instrumentation/jfinal/ActionHandlerInstrumentation.java

...t/src/main/java/io/opentelemetry/javaagent/instrumentation/jfinal/v3_6/JFinalSingletons.java

...t/src/main/java/io/opentelemetry/javaagent/instrumentation/jfinal/v3_2/JFinalSingletons.java

SylvainJuge · 2025-11-05T07:34:56Z

...ain/java/io/opentelemetry/javaagent/instrumentation/jfinal/ActionHandlerInstrumentation.java

+    public static HandleAdvice.AdviceScope onEnter() {
+      return HandleAdvice.AdviceScope.start(currentContext());


Suggested change

public static HandleAdvice.AdviceScope onEnter() {

return HandleAdvice.AdviceScope.start(currentContext());

public static AdviceScope onEnter() {

return AdviceScope.start(currentContext());

...ain/java/io/opentelemetry/javaagent/instrumentation/jfinal/ActionHandlerInstrumentation.java

...ain/java/io/opentelemetry/javaagent/instrumentation/jfinal/ActionMappingInstrumentation.java

....6/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jfinal/TestConfig.java

Change-Id: I61c0953cd1de4856ca7f143d0af20755399b9095

…upport-jfinal Change-Id: I89962394646e846de25e3a68dbc76e00f472e29a

otelbot-java-instrumentation · 2025-11-05T11:13:35Z

🔧 The result from spotlessApply was committed to the PR branch.

otelbot-java-instrumentation · 2025-11-05T11:13:43Z

❌ The result from generateLicenseReport could not be committed to the PR branch, see logs: https://github.com/open-telemetry/opentelemetry-java-instrumentation/actions/runs/19100120039.

Change-Id: I1c1b28366523e7c7a57665d0c312dc40480b9ef7

…upport-jfinal Change-Id: I49595e0b48a44439e05262aaccd9b340ae4f414a

...ava/io/opentelemetry/javaagent/instrumentation/jfinal/v3_2/ActionHandlerInstrumentation.java

laurit

could you also update https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md#libraries--frameworks

...ava/io/opentelemetry/javaagent/instrumentation/jfinal/v3_6/ActionHandlerInstrumentation.java

...ava/io/opentelemetry/javaagent/instrumentation/jfinal/v3_6/ActionMappingInstrumentation.java

...java/io/opentelemetry/javaagent/instrumentation/jfinal/v3_2/JFinalInstrumentationModule.java

...java/io/opentelemetry/javaagent/instrumentation/jfinal/v3_6/JFinalInstrumentationModule.java

...t/src/main/java/io/opentelemetry/javaagent/instrumentation/jfinal/v3_6/JFinalSingletons.java

laurit · 2025-11-11T14:18:12Z

....2/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jfinal/JFinalTest.java

+    // GET /redirect                      GET /redirect
+    // |---jfinal.handle                  |---jfinal.handle
+    //      |---controller                     |---controller
+    //      |---Response.sendRedirect                |---Response.sendRedirect


in assertResponseSpan you can choose the correct parent span and assert that, or is there something else that needs to be done?

As shown below, In assertRespaonseSpan, I can only get span named 'controller' and 'Get /redirect'，But span named 'jfinal.handle' is what I needed，I can‘t get this span only if I update the logic in io.opentelemetry.instrumentation.testing.junit.http.AbstractHttpServerTest#assertTheTraces

@laurit l will resolve this conversation if you don't have any more comment?

....6/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jfinal/JFinalTest.java

...avaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/jfinal/TestController.java

instrumentation/jfinal-3.2/javaagent/build.gradle.kts

pepeshore · 2025-11-12T02:11:53Z

could you also update https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/supported-libraries.md#libraries--frameworks

added

otelbot-java-instrumentation · 2025-11-12T03:26:40Z

🔧 The result from spotlessApply was committed to the PR branch.

- Remove unused code in ActionHandlerInstrumentation and ActionMappingInstrumentation - Refactor JFinalSingletons to improve code organization - Update JFinalInstrumentationModule configuration - Enhance test coverage in JFinalTest - Update TestController implementation - Add JFinal support to documentation

otelbot-java-instrumentation · 2025-11-12T03:36:50Z

🔧 The result from spotlessApply was committed to the PR branch.

- Remove unused currentContext import - Change HandleAdvice class to private for better encapsulation - Refactor AdviceScope.start() to call Context.current() internally Change-Id: I69e0de219e8cc80bde3bedbd641a211b45ddd6f2

- Changed minimum supported version from 3.6 to 3.2 to extend compatibility - Renamed instrumentation module from jfinal-3.6 to jfinal-3.2 - Updated all package names from v3_6 to v3_2 - Added classLoader matcher to distinguish between JFinal 3.2 and 3.6+ - Changed HandleAdvice class visibility from private to public - Updated documentation to reflect new version support Change-Id: If3a9bc00c0e0ee59328971f3e9cc0152d7defe67

otelbot-java-instrumentation · 2025-11-12T06:01:40Z

🔧 The result from spotlessApply was committed to the PR branch.

- Simplified classLoader matcher to only exclude JFinal 3.6+ (TypeConverter class) - Updated instrumenter name from jfinal-3.6 to jfinal-3.2 - Adjusted Java version constraint for tests to only apply when not testing latest deps - Updated comment to clarify JFinal 3.6 Java 9+ compatibility issue Change-Id: Ia4a73a9d5767e048c0dfe3897acd394cf641c6b6

otelbot-java-instrumentation · 2025-11-12T06:27:53Z

🔧 The result from spotlessApply was committed to the PR branch.

pepeshore and others added 14 commits September 18, 2025 15:27

feat: support parse oceanbase、lindorm、polardb、opentracing connection url

8282947

Change-Id: Ia3b5f6b74b40763c4df7fa0185223575a2c1b068

Merge branch 'open-telemetry:main' into feature/additonal-jdbc-url-pa…

d0acc07

…rser

delete test main method

4251ef4

./gradlew spotlessApply

8d79717

fix：fix some code comments

a4a325f

Change-Id: I39d2ce579c60d5afa2e792f3296eef5d0b495443

Merge remote-tracking branch 'origin/feature/additonal-jdbc-url-parse…

28c2324

…r' into feature/additonal-jdbc-url-parser Change-Id: I5b6ee06da60fc32dc1edece63948d228c95f710b

Optimized the comments for OceanBase url parser

e5d0f3c

./gradlew spotlessApply

ae6a467

delete url parameter

660f26b

Change-Id: Ic7a1bdab51668642fb2c3e4b775ce30f4e1a841c

Merge remote-tracking branch 'origin/feature/additonal-jdbc-url-parse…

548e0df

…r' into feature/additonal-jdbc-url-parser Change-Id: I6205bbedb81199c2bded7b78112389ca0b935636

./gradlew spotlessApply

73286f8

Merge branch 'main' into feature/additonal-jdbc-url-parser

87105b6

review

92a0e4c

feat：support JFinal framework

3bd593a

Change-Id: Ie9d2a16071e77ce12f386227faaff4a4927512be

pepeshore requested a review from a team as a code owner November 4, 2025 13:18

github-actions bot added the test native This label can be applied to PRs to trigger them to run native tests label Nov 4, 2025

pepeshore changed the title ~~Feat/support jfinal~~ Feat/support jfinal and Fix #11465 Nov 4, 2025

pepeshore changed the title ~~Feat/support jfinal and Fix #11465~~ Add support for JFinal Nov 4, 2025

./gradlew spotlessApply

7ab2d87

Merge branch 'main' into feat/support-jfinal

eebb74c

steverao requested a review from Copilot November 5, 2025 02:24

Copilot AI reviewed Nov 5, 2025

View reviewed changes

steverao reviewed Nov 5, 2025

View reviewed changes

instrumentation/jfinal-3.6/javaagent/build.gradle.kts Outdated Show resolved Hide resolved

steverao reviewed Nov 5, 2025

View reviewed changes

instrumentation/jfinal-3.6/javaagent/build.gradle.kts Outdated Show resolved Hide resolved

settings.gradle.kts Outdated Show resolved Hide resolved

steverao reviewed Nov 5, 2025

View reviewed changes

...t/src/main/java/io/opentelemetry/javaagent/instrumentation/jfinal/v3_2/JFinalSingletons.java Show resolved Hide resolved

SylvainJuge reviewed Nov 5, 2025

View reviewed changes

pepeshore added 2 commits November 5, 2025 17:36

fix：fix failing check

de238a4

Change-Id: I61c0953cd1de4856ca7f143d0af20755399b9095

Merge remote-tracking branch 'origin/feat/support-jfinal' into feat/s…

fed5680

…upport-jfinal Change-Id: I89962394646e846de25e3a68dbc76e00f472e29a

pepeshore and others added 2 commits November 5, 2025 19:07

refactor：update package name & remove useless dependency and code

63b2d8f

./gradlew spotlessApply

85cc395

pepeshore added 2 commits November 5, 2025 19:35

refactor：delete useless code

5f55199

Change-Id: I1c1b28366523e7c7a57665d0c312dc40480b9ef7

Merge remote-tracking branch 'origin/feat/support-jfinal' into feat/s…

f61ac70

…upport-jfinal Change-Id: I49595e0b48a44439e05262aaccd9b340ae4f414a

SylvainJuge reviewed Nov 5, 2025

View reviewed changes

...ava/io/opentelemetry/javaagent/instrumentation/jfinal/v3_2/ActionHandlerInstrumentation.java Show resolved Hide resolved

...ava/io/opentelemetry/javaagent/instrumentation/jfinal/v3_2/ActionHandlerInstrumentation.java Show resolved Hide resolved