Connect a Spring Boot application to SchedulerX

1.1 Basic settings

1.2 Notification settings

1. Add the dependency to pom.xml

   Add the schedulerx2-spring-boot-starter dependency to your project's pom.xml file to use SchedulerX features.

   Note

   SchedulerX supports connections from Spring Boot 2.x and 3.x.

   <dependency>
     <groupId>com.aliyun.schedulerx</groupId>
     <artifactId>schedulerx2-spring-boot-starter</artifactId>
     <version>${schedulerx2.version}</version>
     <!-- If you use logback, exclude log4j and log4j2 -->
     <exclusions>
       <exclusion>
         <groupId>org.apache.logging.log4j</groupId>
         <artifactId>log4j-api</artifactId>
       </exclusion>
       <exclusion>
         <groupId>org.apache.logging.log4j</groupId>
         <artifactId>log4j-core</artifactId>
       </exclusion>
       <exclusion>
         <groupId>log4j</groupId>
         <artifactId>log4j</artifactId>
       </exclusion>
     </exclusions>
   </dependency>                   

   Important

   Replace <version>${schedulerx2.version}</version> with the latest client version. For example: <version>1.11.5</version>. For more information, see Client release notes.

2. Configure parameters

   In your Spring Boot application's application.properties file, add the required parameters to connect the SchedulerxWorker to your SchedulerX application.

   spring.schedulerx2.endpoint=${endpoint}
   spring.schedulerx2.namespace=${namespace}
   spring.schedulerx2.groupId=${groupId}
   # Only version 1.2.1 and later supports configuring appKey.
   spring.schedulerx2.appKey=${appKey}
   
   # If you do not use an appKey, you can use an Alibaba Cloud AccessKey ID and AccessKey secret, or an STS token.
   #spring.schedulerx2.aliyunAccessKey=${aliyunAccessKey}
   #spring.schedulerx2.aliyunSecretKey=${aliyunSecretKey} 
   #spring.schedulerx2.stsToken=${aliyunStsToken}                   

   Parameter source:

   In the MSE SchedulerX console, go to the Application Management page in the left-side navigation pane. In the Actions column for your target application, click Access Config and select Spring Boot as the service type. In the dialog box that appears, you can view example values for parameters like endpoint, namespace, groupId, and appKey. Copy these values into the corresponding locations in your configuration file.

   Important

   Ensure that the SchedulerX region matches the client region to avoid connection failures.

   If you are using a non-Alibaba Cloud server or a local environment, make sure you have enabled public network access and created your application in a public-facing region of the scheduling platform. For more details, see Connect to a public environment locally.

   Note

   If your client application includes multiple services or requires permission management to isolate scheduled jobs, you can create multiple applications in the console for fine-grained job management. For example, if a client application named animals has two applications, animals.dog and animals.cat, created in the console, you do not need to request separate instances for each. Instead, you can configure them in the application.properties file by specifying multiple application IDs in the spring.schedulerx2.groupId=${groupId} parameter, separated by commas, such as: spring.schedulerx2.groupId=animals.dog,animals.cat.

   Parameter description:

   • endpoint: When initializing the SchedulerxWorker, use the region and corresponding endpoint where your application is deployed. For more information, see Endpoints.

   • namespace: The ID of the namespace. You can find it on the Namespaces page in the console.

   • groupId and appKey: The groupId is the application ID, and the appKey is the application key. You can find them on the Application Management page in the console.

   • aliyunAccessKey and aliyunSecretKey: aliyunAccessKey is your Alibaba Cloud account's AccessKey ID, and aliyunSecretKey is the AccessKey secret. You can obtain them from the Security Management page in the User Information Management console.

   • For more parameters, see the following table:

     Key	Description	Value	Supported from version
     spring.schedulerx2.enabled	Enables the SchedulerX 2.0 starter. Default: true.	true false	0.1.7
     spring.schedulerx2.endpoint	Sets the endpoint for the region. For more information, see Endpoints.	None	0.1.7
     spring.schedulerx2.namespace	Sets the UID of the namespace. You can find it on the Namespaces page in the console.	None	0.1.7
     spring.schedulerx2.groupId	The groupId. You can find it on the Application Management page in the console.	None	0.1.7
     spring.schedulerx2.appKey	The appKey. You can find it on the Application Management page in the console.	None	1.2.1
     spring.schedulerx2.host	If you have multiple IP addresses (for example, from a VPN or multiple network cards), you can specify the IP address to use.	None	0.1.7
     spring.schedulerx2.port	A custom port for the client to listen on. If not set, a random available port is chosen.	None	0.1.7
     spring.schedulerx2.blockAppStart	If true, blocks application startup if SchedulerX fails to initialize. Default: true.	true false	1.1.0
     spring.schedulerx2.shareContainerPool	If true, all job executions on the client share a single thread pool. Default: false.	true false	1.2.1.2
     spring.schedulerx2.sharePoolSize	Sets the size of the shared thread pool when spring.schedulerx2.shareContainerPool is true. Default: 64.	None	1.2.1.2
     spring.schedulerx2.label	You can set labels on different clients and specify labels for job execution in job management. This is useful for scenarios like canary releases and stress testing.	None	1.2.2.2
     spring.schedulerx2.enableCgroupMetrics	Specifies whether to use cgroups to collect metrics for client instances. This must be enabled manually in container (K8s) environments. The default is false.	true false	1.2.2.2
     spring.schedulerx2.cgroupPathPrefix	The cgroup path inside the container.	The default path is /sys/fs/cgroup/cpu/. If this path exists, you do not need to set this parameter.	1.2.2.2
     spring.schedulerx2.enableHeartbeatLog	Specifies whether to print the heartbeat log to ${user.home}/logs/schedulerx/heartbeat.log. The default is true.	true false	1.2.4
     spring.schedulerx2.mapMasterStatusCheckInterval	The interval, in milliseconds, at which a Map job checks for sub-job completion. A lower value can accelerate scheduling for second-level jobs.	3000	1.2.5.2
     spring.schedulerx2.enableSecondDelayCycleIntervalMs	If true, the second_delay value from the console is treated as milliseconds instead of seconds, enabling faster scheduling. Default: false.	true false	1.2.5.2
     spring.schedulerx2.broadcastMasterExecEnable	Specifies whether the master node participates in the execution of a broadcast job. The default is true.	true false	1.8.13
     spring.schedulerx2.broadcastDispatchRetryTimes	The number of retry attempts for a failed broadcast dispatch. The retry interval is fixed at 2 seconds and is not configurable.	3	1.8.13
     spring.schedulerx2.enableSecondDelayStandaloneDispatch	Specifies whether to enable second-level dispatch and execution for standalone jobs. The default is false.	true false	1.8.13

3. Create a job processor class

   Create a JobProcessor class in your Spring Boot application to handle the job logic.

   The following example shows how to create a simple JobProcessor class that prints a message periodically (example package name: com.example.schedulerx.job).

   package com.example.schedulerx.job;
   
   import com.alibaba.schedulerx.worker.domain.JobContext;
   import com.alibaba.schedulerx.worker.processor.JavaProcessor;
   import com.alibaba.schedulerx.worker.processor.ProcessResult;
   import org.springframework.stereotype.Component;
   
   @Component
   public class MyHelloJob extends JavaProcessor {
   
       @Override
       public ProcessResult process(JobContext context) throws Exception {
           System.out.println("hello schedulerx2.0");
           return new ProcessResult(true);
       }
   }              

Log on to the MSE SchedulerX console. In the left navigation bar, click Application Management and view the Total Instances of the target application.