Add support for XXL-JOB #10421

steverao · 2024-02-06T12:42:53Z

Resolves #8084

docs/supported-libraries.md

instrumentation/xxl-job/xxl-job-1.9.2/javaagent/build.gradle.kts

.../io/opentelemetry/javaagent/instrumentation/xxljob/v1_9_2/GlueJobHandlerInstrumentation.java

...o/opentelemetry/javaagent/instrumentation/xxljob/v1_9_2/SimpleJobHandlerInstrumentation.java

...src/main/java/io/opentelemetry/javaagent/instrumentation/xxljob/v1_9_2/XxlJobSingletons.java

...t/java/io/opentelemetry/javaagent/instrumentation/xxljob/v1_9_2/SimpleCustomizedHandler.java

...agent/src/test/java/io/opentelemetry/javaagent/instrumentation/xxljob/v1_9_2/XxlJobTest.java

...ava/io/opentelemetry/javaagent/instrumentation/xxljob/common/XxlJobCodeAttributesGetter.java

...ntelemetry/javaagent/instrumentation/xxljob/common/XxlJobExperimentalAttributeExtractor.java

2. Found there is a bug in setting span status in 2.3.0+, so added a new module of xxl-job-2.3.0 to solve it.

laurit · 2024-02-26T10:11:31Z

closing and reopening to trigger checks

* Rework xxl job instrumentation * simplify

...n/java/io/opentelemetry/javaagent/instrumentation/xxljob/common/XxlJobSpanNameExtractor.java

laurit · 2024-03-04T17:37:27Z

...n/java/io/opentelemetry/javaagent/instrumentation/xxljob/common/XxlJobSpanNameExtractor.java

+ public String extract(XxlJobProcessRequest request) {
+ GlueTypeEnum glueType = request.getGlueType();
+ if (SCRIPT_JOB_TYPE.contains(glueType.getDesc())) {
+ return glueType.getDesc() + ".ID-" + request.getJobId();


span names like GLUE(Shell).ID-2 don't follow general span naming guidelines outlined in https://github.com/open-telemetry/opentelemetry-specification/blob/v1.26.0/specification/trace/api.md#span the id portion should be removed from the span name.
GLUE(Shell) feels a bit weird to me, but looking at the xxl-job doc I get the feeling that this is what the xxl-job ui displays. If that is the case then I think it is fine to keep it.

span names like GLUE(Shell).ID-2 don't follow general span naming guidelines outlined in https://github.com/open-telemetry/opentelemetry-specification/blob/v1.26.0/specification/trace/api.md#span the id portion should be removed from the span name. GLUE(Shell) feels a bit weird to me, but looking at the xxl-job doc I get the feeling that this is what the xxl-job ui displays. If that is the case then I think it is fine to keep it.

It backs to discussion above. If we remove the id portion from spanName, it will cause no way to distinguish specific GLUE(Shell) job in system. Such as there are three Shell jobs, their jobIds are 1,2,3. Without jobId in spanName, they are same spanName in APM. it's hard for user to troubleshooting.

@trask could you provide guidance on this. Should the job id be added to the span name (I guess it doesn't have a particularly high cardinality so perhaps a bit similar to http.route) or added as an attribute to to the span?

@steverao can you help us understand the Job ID a bit better?

a couple of questions in particular,

how does a user correspond a Job ID back to their workflow?

is the Job ID stable, meaning a given workflow will always have the same job ID? or can a given workflow's job ID sometimes change over time?

@steverao can you help us understand the Job ID a bit better?

a couple of questions in particular,

how does a user correspond a Job ID back to their workflow?

is the Job ID stable, meaning a given workflow will always have the same job ID? or can a given workflow's job ID sometimes change over time?

Sure, answers to related questions are as follows:

The job ID is generated by job system, when users create a job in xxl-job console, it will have a unique ID. Users can find their job by job ID in console, just like picture below:

Yes, the Job ID is unique, it's a unique key to store job content in the system database. it can't be changed.

is it possible to use the "Job description" instead of the "Job ID"? that looks more similar to existing span names for other instrumentations

I think the "Job description" is not good choose, because it has no restrictions on the input values, so jobs of the same type may have the same description.

jobs of the same type may have the same description

is this common?

we could still capture job id as a span attribute (just doesn't seem to be the best span name, since span name is ideally more human readable)

is this common?

yes

we could still capture job id as a span attribute (just doesn't seem to be the best span name, since span name is ideally more human readable)

ok, I understand it, but I have an alternative span name GLUE(Shell).{jobId}, then we can add the relevant jobId to a non ExperimentalAttributeExtractor for script job. It's will be more friendly to users to find jobId in attribute. What do you think of this? @trask @laurit

(sorry I haven't read the code) is the Job ID only included in span name for "GLUE" type jobs? what does the span name look like for other jobs? thanks

(sorry I haven't read the code) is the Job ID only included in span name for "GLUE" type jobs? what does the span name look like for other jobs? thanks

In fact, the Job Id just be used in script job, such as Shell or Python script, they may not have method name. you can refer to #10421 (comment). Other jobs type are designed for java, so I can get their className and methodName, I use className.methodName as span name. They look like CustomizedGroovyHandler.execute. You can see more cases in relevant test code：） https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/10421/files#diff-46bda3c71cf5f790cba801eca4373fa35faebeebace4431b64c82695277a96a9
I communicated with @laurit today, considering the community release plan, we first use GLUE(Shell) as span name and set a jobId in experimental attribute for script job in 2.2.0, I will restart a subsequent PR to discuss a better span name later.

steverao requested a review from a team as a code owner February 6, 2024 12:42

github-actions bot requested a review from theletterf February 6, 2024 12:43

steverao changed the title ~~Added support for XXL-JOB.~~ Added support for XXL-JOB Feb 6, 2024

steverao added 5 commits February 16, 2024 20:22

Added support for XXL-JOB.

7493706

Optimized code

8a24bd2

Optimized the codes

c071c87

Fixed testLatestDeps job run failed

265e9f5

Fixed spotless job run failed

53119af

steverao force-pushed the main-xxljob branch from 7d3e9cb to 53119af Compare February 16, 2024 12:23

laurit reviewed Feb 22, 2024

View reviewed changes

1. Solved some comment problems.

7be3bee

2. Found there is a bug in setting span status in 2.3.0+, so added a new module of xxl-job-2.3.0 to solve it.

github-actions bot added the test native This label can be applied to PRs to trigger them to run native tests label Feb 24, 2024

steverao added 3 commits February 24, 2024 19:08

Fixed CI failure.

3623514

Fixed CI failure.

77503c3

Fixed CI failure.

bda251b

steverao mentioned this pull request Feb 25, 2024

Wrong labeling rules #10661

Closed

laurit removed the test native This label can be applied to PRs to trigger them to run native tests label Feb 26, 2024

laurit closed this Feb 26, 2024

laurit reopened this Feb 26, 2024

steverao requested a review from laurit February 29, 2024 10:01

laurit and others added 2 commits March 1, 2024 22:29

Rework xxl job instrumentation (#6)

dbb7c76

* Rework xxl job instrumentation * simplify

Optimize the code

34837f2

steverao changed the title ~~Added support for XXL-JOB~~ Add support for XXL-JOB Mar 1, 2024

laurit reviewed Mar 4, 2024

View reviewed changes

...n/java/io/opentelemetry/javaagent/instrumentation/xxljob/common/XxlJobSpanNameExtractor.java Outdated Show resolved Hide resolved

laurit reviewed Mar 4, 2024

View reviewed changes

Optimize the code

ba4cbcf

laurit added this to the v2.2.0 milestone Mar 6, 2024

steverao requested review from laurit and trask March 11, 2024 12:25

steverao added 4 commits March 12, 2024 18:14

Adjust span name of script job

df9614a

Fix spotless problem

a5c7510

Fix unit test failure

1ae4279

Merge branch 'main' into main-xxljob

38b2923

laurit approved these changes Mar 12, 2024

View reviewed changes

trask merged commit 86c3263 into open-telemetry:main Mar 12, 2024
49 checks passed

steverao deleted the main-xxljob branch March 13, 2024 11:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for XXL-JOB #10421

Add support for XXL-JOB #10421

steverao commented Feb 6, 2024 •

edited

Loading

laurit commented Feb 26, 2024

laurit Mar 4, 2024

steverao Mar 5, 2024

laurit Mar 5, 2024

trask Mar 7, 2024

steverao Mar 8, 2024 •

edited

Loading

steverao Mar 12, 2024

trask Mar 12, 2024

steverao Mar 12, 2024

trask Mar 12, 2024

steverao Mar 12, 2024 •

edited

Loading

Add support for XXL-JOB #10421

Add support for XXL-JOB #10421

Conversation

steverao commented Feb 6, 2024 • edited Loading

laurit commented Feb 26, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steverao Mar 8, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

steverao Mar 12, 2024 • edited Loading

Choose a reason for hiding this comment

steverao commented Feb 6, 2024 •

edited

Loading

steverao Mar 8, 2024 •

edited

Loading

steverao Mar 12, 2024 •

edited

Loading