Skip to content

make xxl-job indy-ready #14571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 4, 2025
Merged

make xxl-job indy-ready #14571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 11 additions & 21 deletions .../opentelemetry/javaagent/instrumentation/xxljob/v1_9_2/GlueJobHandlerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,17 @@

package io.opentelemetry.javaagent.instrumentation.xxljob.v1_9_2;

import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
import static io.opentelemetry.javaagent.instrumentation.xxljob.v1_9_2.XxlJobSingletons.helper;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.named;
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;

import com.xxl.job.core.handler.IJobHandler;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobHelper;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobProcessRequest;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.implementation.bytecode.assign.Assigner;
Expand All @@ -39,29 +38,20 @@ public void transform(TypeTransformer transformer) {
@SuppressWarnings("unused")
public static class ScheduleAdvice {

@Nullable
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void onSchedule(
@Advice.FieldValue("jobHandler") IJobHandler handler,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
Context parentContext = currentContext();
request = XxlJobProcessRequest.createGlueJobRequest(handler);
context = helper().startSpan(parentContext, request);
if (context == null) {
return;
}
scope = context.makeCurrent();
public static XxlJobHelper.XxlJobScope onSchedule(
@Advice.FieldValue("jobHandler") IJobHandler handler) {
return helper().startSpan(XxlJobProcessRequest.createGlueJobRequest(handler));
}

@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void stopSpan(
@Advice.Return(typing = Assigner.Typing.DYNAMIC) Object result,
@Advice.Thrown Throwable throwable,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
helper().stopSpan(result, request, throwable, scope, context);
@Advice.Return(typing = Assigner.Typing.DYNAMIC) @Nullable Object result,
Copy link
Contributor

@laurit laurit Sep 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wondering whether Assigner.Typing.DYNAMIC is really needed when assigning to Object

Copy link
Contributor Author

@SylvainJuge SylvainJuge Sep 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder the same, I left it as-is for simplicity but it should be safe to remove it in the future.

@Advice.Thrown @Nullable Throwable throwable,
@Advice.Enter @Nullable XxlJobHelper.XxlJobScope scope) {

helper().endSpan(scope, result, throwable);
}
}
}
31 changes: 10 additions & 21 deletions ...pentelemetry/javaagent/instrumentation/xxljob/v1_9_2/ScriptJobHandlerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,18 @@

package io.opentelemetry.javaagent.instrumentation.xxljob.v1_9_2;

import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
import static io.opentelemetry.javaagent.instrumentation.xxljob.v1_9_2.XxlJobSingletons.helper;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.named;
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;

import com.xxl.job.core.glue.GlueTypeEnum;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobHelper;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobProcessRequest;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.implementation.bytecode.assign.Assigner;
Expand All @@ -40,30 +39,20 @@ public void transform(TypeTransformer transformer) {
@SuppressWarnings("unused")
public static class ScheduleAdvice {

@Nullable
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void onSchedule(
public static XxlJobHelper.XxlJobScope onSchedule(
@Advice.FieldValue("glueType") GlueTypeEnum glueType,
@Advice.FieldValue("jobId") int jobId,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
Context parentContext = currentContext();
request = XxlJobProcessRequest.createScriptJobRequest(glueType, jobId);
context = helper().startSpan(parentContext, request);
if (context == null) {
return;
}
scope = context.makeCurrent();
@Advice.FieldValue("jobId") int jobId) {
return helper().startSpan(XxlJobProcessRequest.createScriptJobRequest(glueType, jobId));
}

@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void stopSpan(
@Advice.Return(typing = Assigner.Typing.DYNAMIC) Object result,
@Advice.Thrown Throwable throwable,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
helper().stopSpan(result, request, throwable, scope, context);
@Advice.Return(typing = Assigner.Typing.DYNAMIC) @Nullable Object result,
@Advice.Thrown @Nullable Throwable throwable,
@Advice.Enter @Nullable XxlJobHelper.XxlJobScope scope) {
helper().endSpan(scope, result, throwable);
}
}
}
33 changes: 10 additions & 23 deletions ...pentelemetry/javaagent/instrumentation/xxljob/v1_9_2/SimpleJobHandlerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

package io.opentelemetry.javaagent.instrumentation.xxljob.v1_9_2;

import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasSuperType;
import static io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobConstants.XXL_GLUE_JOB_HANDLER;
import static io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobConstants.XXL_METHOD_JOB_HANDLER;
Expand All @@ -19,11 +18,11 @@
import static net.bytebuddy.matcher.ElementMatchers.takesArguments;

import com.xxl.job.core.handler.IJobHandler;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobHelper;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobProcessRequest;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.implementation.bytecode.assign.Assigner;
Expand All @@ -44,33 +43,21 @@ public void transform(TypeTransformer transformer) {
SimpleJobHandlerInstrumentation.class.getName() + "$ScheduleAdvice");
}

@SuppressWarnings("unused")
public static class ScheduleAdvice {

@SuppressWarnings("unused")
@Nullable
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void onSchedule(
@Advice.This IJobHandler handler,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
Context parentContext = currentContext();
request = XxlJobProcessRequest.createSimpleJobRequest(handler);
context = helper().startSpan(parentContext, request);
if (context == null) {
return;
}
scope = context.makeCurrent();
public static XxlJobHelper.XxlJobScope onSchedule(@Advice.This IJobHandler handler) {
return helper().startSpan(XxlJobProcessRequest.createSimpleJobRequest(handler));
}

@SuppressWarnings("unused")
@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void stopSpan(
@Advice.Return(typing = Assigner.Typing.DYNAMIC) Object result,
@Advice.Thrown Throwable throwable,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
helper().stopSpan(result, request, throwable, scope, context);
@Advice.Return(typing = Assigner.Typing.DYNAMIC) @Nullable Object result,
@Advice.Thrown @Nullable Throwable throwable,
@Advice.Enter @Nullable XxlJobHelper.XxlJobScope scope) {
helper().endSpan(scope, result, throwable);
}
}
}
9 changes: 8 additions & 1 deletion ...io/opentelemetry/javaagent/instrumentation/xxljob/v1_9_2/XxlJobInstrumentationModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
import com.google.auto.service.AutoService;
import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.internal.ExperimentalInstrumentationModule;
import java.util.List;
import net.bytebuddy.matcher.ElementMatcher;

@AutoService(InstrumentationModule.class)
public class XxlJobInstrumentationModule extends InstrumentationModule {
public class XxlJobInstrumentationModule extends InstrumentationModule
implements ExperimentalInstrumentationModule {

public XxlJobInstrumentationModule() {
super("xxl-job", "xxl-job-1.9.2");
Expand All @@ -35,4 +37,9 @@ public List<TypeInstrumentation> typeInstrumentations() {
new SimpleJobHandlerInstrumentation(),
new GlueJobHandlerInstrumentation());
}

@Override
public boolean isIndyReady() {
return true;
}
}
31 changes: 10 additions & 21 deletions .../opentelemetry/javaagent/instrumentation/xxljob/v2_1_2/GlueJobHandlerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@

package io.opentelemetry.javaagent.instrumentation.xxljob.v2_1_2;

import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
import static io.opentelemetry.javaagent.instrumentation.xxljob.v2_1_2.XxlJobSingletons.helper;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.named;

import com.xxl.job.core.handler.IJobHandler;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobHelper;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobProcessRequest;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.implementation.bytecode.assign.Assigner;
Expand All @@ -37,29 +36,19 @@ public void transform(TypeTransformer transformer) {

@SuppressWarnings("unused")
public static class ScheduleAdvice {
@Nullable
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void onSchedule(
@Advice.FieldValue("jobHandler") IJobHandler handler,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
Context parentContext = currentContext();
request = XxlJobProcessRequest.createGlueJobRequest(handler);
context = helper().startSpan(parentContext, request);
if (context == null) {
return;
}
scope = context.makeCurrent();
public static XxlJobHelper.XxlJobScope onSchedule(
@Advice.FieldValue("jobHandler") IJobHandler handler) {
return helper().startSpan(XxlJobProcessRequest.createGlueJobRequest(handler));
}

@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void stopSpan(
@Advice.Return(typing = Assigner.Typing.DYNAMIC) Object result,
@Advice.Thrown Throwable throwable,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
helper().stopSpan(result, request, throwable, scope, context);
@Advice.Return(typing = Assigner.Typing.DYNAMIC) @Nullable Object result,
@Advice.Thrown @Nullable Throwable throwable,
@Advice.Enter @Nullable XxlJobHelper.XxlJobScope scope) {
helper().endSpan(scope, result, throwable);
}
}
}
31 changes: 9 additions & 22 deletions ...pentelemetry/javaagent/instrumentation/xxljob/v2_1_2/MethodJobHandlerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@

package io.opentelemetry.javaagent.instrumentation.xxljob.v2_1_2;

import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
import static io.opentelemetry.javaagent.instrumentation.xxljob.v2_1_2.XxlJobSingletons.helper;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.named;

import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobHelper;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobProcessRequest;
import java.lang.reflect.Method;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.implementation.bytecode.assign.Assigner;
Expand All @@ -38,29 +37,17 @@ public void transform(TypeTransformer transformer) {
@SuppressWarnings("unused")
public static class ScheduleAdvice {
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void onSchedule(
@Advice.FieldValue("target") Object target,
@Advice.FieldValue("method") Method method,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
Context parentContext = currentContext();
request = XxlJobProcessRequest.createMethodJobRequest(target, method);
context = helper().startSpan(parentContext, request);
if (context == null) {
return;
}
scope = context.makeCurrent();
public static XxlJobHelper.XxlJobScope onSchedule(
@Advice.FieldValue("target") Object target, @Advice.FieldValue("method") Method method) {
return helper().startSpan(XxlJobProcessRequest.createMethodJobRequest(target, method));
}

@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void stopSpan(
@Advice.Return(typing = Assigner.Typing.DYNAMIC) Object result,
@Advice.Thrown Throwable throwable,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
helper().stopSpan(result, request, throwable, scope, context);
@Advice.Return(typing = Assigner.Typing.DYNAMIC) @Nullable Object result,
@Advice.Thrown @Nullable Throwable throwable,
@Advice.Enter @Nullable XxlJobHelper.XxlJobScope scope) {
helper().endSpan(scope, result, throwable);
}
}
}
32 changes: 11 additions & 21 deletions ...pentelemetry/javaagent/instrumentation/xxljob/v2_1_2/ScriptJobHandlerInstrumentation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@

package io.opentelemetry.javaagent.instrumentation.xxljob.v2_1_2;

import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
import static io.opentelemetry.javaagent.instrumentation.xxljob.v2_1_2.XxlJobSingletons.helper;
import static net.bytebuddy.matcher.ElementMatchers.isPublic;
import static net.bytebuddy.matcher.ElementMatchers.named;

import com.xxl.job.core.glue.GlueTypeEnum;
import io.opentelemetry.context.Context;
import io.opentelemetry.context.Scope;
import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobHelper;
import io.opentelemetry.javaagent.instrumentation.xxljob.common.XxlJobProcessRequest;
import javax.annotation.Nullable;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.implementation.bytecode.assign.Assigner;
Expand All @@ -37,30 +36,21 @@ public void transform(TypeTransformer transformer) {

@SuppressWarnings("unused")
public static class ScheduleAdvice {

@Nullable
@Advice.OnMethodEnter(suppress = Throwable.class)
public static void onSchedule(
public static XxlJobHelper.XxlJobScope onSchedule(
@Advice.FieldValue("glueType") GlueTypeEnum glueType,
@Advice.FieldValue("jobId") int jobId,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
Context parentContext = currentContext();
request = XxlJobProcessRequest.createScriptJobRequest(glueType, jobId);
context = helper().startSpan(parentContext, request);
if (context == null) {
return;
}
scope = context.makeCurrent();
@Advice.FieldValue("jobId") int jobId) {
return helper().startSpan(XxlJobProcessRequest.createScriptJobRequest(glueType, jobId));
}

@Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
public static void stopSpan(
@Advice.Return(typing = Assigner.Typing.DYNAMIC) Object result,
@Advice.Thrown Throwable throwable,
@Advice.Local("otelRequest") XxlJobProcessRequest request,
@Advice.Local("otelContext") Context context,
@Advice.Local("otelScope") Scope scope) {
helper().stopSpan(result, request, throwable, scope, context);
@Advice.Return(typing = Assigner.Typing.DYNAMIC) @Nullable Object result,
@Advice.Thrown @Nullable Throwable throwable,
@Advice.Enter @Nullable XxlJobHelper.XxlJobScope scope) {
helper().endSpan(scope, result, throwable);
}
}
}
Loading