Microservices Engine:Debug XXL-JOB jobs in on-premises environments by using the on-premises and cloud interconnection feature

Prerequisites

Before you use Alibaba Cloud Toolkit to interconnect on-premises applications with applications on MSE XXL-JOB, make sure that the following requirements are met:

• An MSE XXL-JOB instance is created.

• The version of IntelliJ IDEA is 2018.3 or later.

• An ECS instance that you can log on to over SSH is available. The instance is used to establish a connection between on-premises applications and applications on MSE XXL-JOB. For more information about how to create an ECS instance, see Create an instance on the Custom Launch tab in the ECS console and manage the instance.

  Important

  • Make sure that the ECS instance and the applications to be interconnected are deployed in the same virtual private cloud (VPC).

  • Make sure that the ECS instance has a public IP address.

  • If you use SSH tunnels, password authentication is required for logons. Key pair-based logons are not supported.

Step 1: Install Alibaba Cloud Toolkit

1. Start IntelliJ IDEA.

2. Install the plug-in in IntelliJ IDEA.

   • macOS: In the main menu bar, choose IntelliJ IDEA > Preference.... On the Preferences page, click Plugins in the left-side navigation pane, search for Alibaba Cloud Toolkit, and then click Install.

   • Windows: In the main menu bar, choose File > Settings. In the Settings dialog box, click Plugins in the left-side navigation pane, search for Alibaba Cloud Toolkit, and then click Install.

3. After the plug-in is installed in IntelliJ IDEA, restart IntelliJ IDEA. The Alibaba Cloud Toolkit icon () appears in the toolbar.

Step 2: Configure an Alibaba Cloud account and a proxy

Step 3: Configure the on-premises and cloud interconnection feature

1. Start IntelliJ IDEA.

2. In the main menu bar, choose Tools > Alibaba Cloud > Preferences....

3. In the Settings dialog box, choose Alibaba Cloud Toolkit > Microservice > Microservice from the left-side navigation pane.

4. In the Microservice dialog box, configure the parameters related to the on-premises and cloud interconnection feature.

   Parameter	Description
   Configuration Granularity	Select the granularity at which the on-premises and cloud interconnection feature is used by on-premises projects. The granularity can be project or module. (Recommended) Project: The current project uses a unified on-premises and cloud interconnection configuration. The configuration granularity is suitable for single-module projects or multi-module projects in which no configuration difference exists among modules. Module: The current project contains multiple modules. Among the modules, only one module needs to use the on-premises and cloud interconnection feature, or modules require different configurations for the on-premises and cloud interconnection feature. If you want to configure the on-premises and cloud interconnection feature for different modules, select specific modules and configure different settings of the on-premises and cloud interconnection feature for each module.
   On-premises and Cloud Interconnection	Select On-premises and Cloud Interconnection to enable the on-premises and cloud interconnection feature. After you enable the on-premises and cloud interconnection feature, on-premises applications automatically register with a cloud registry and subscribe to services in the cloud registry. The services in the on-premises applications and cloud services can be mutually called. If you only need to call cloud services and do not want cloud services to call on-premises services, select Only Subscribe To Cloud Services, Do Not Register On-premises Services.
   Product	Select Microservices Engine (MSE).
   Region	Select the region where the MSE instance resides.
   Instance	Select the MSE instance.
   Local Spring Cloud Service Port	If you use a Spring Cloud application, you need to enter the service port of the application in the Spring Cloud Service Port field. This field is not required for other types of applications.
   Proxy	Select a proxy server.
   Initialize Proxy...	Configure SSH rules to enable the on-premises and cloud interconnection feature. Note If the top-layer SSH proxy in the proxy list is not configured by using a root account, you are prompted to obtain root permissions to configure the proxy. After the proxy is configured, you can use it. If you do not want to configure a proxy by using the plug-in, you can manually configure a proxy.
   Advanced Configuration	Select Automatically Disable Startup Prompt to specify the duration for which the application startup prompt is displayed. Unit: milliseconds.
   One-click Diagnostics	If you encounter issues during the interconnection between on-premises and cloud applications, you can click One-click Diagnostics to troubleshoot issues such as etrans channel startup exceptions and service connection failures.

5. Click Apply and click OK.

Step 4: Perform joint debugging

1. Download alibabacloud-edas-demo to your project.

2. Create an XXL-JOB application.

   1. Log on to the MSE console, go to the XXL-JOBVersion page, and then select a region from the top navigation bar.

   2. Click the ID of the desired XXL-JOB instance. In the left-side navigation pane, click Application Management. On the page that appears, click CreateApplication.

   3. After the application is created, click Access Configuration in the Operation column. Then, click One-click Copy in Access Method 1: Modify the Spring Boot Configuration File to copy configuration parameters to the application.properties configuration file of your project. You can also use Access Method 2: Restart the Application By Using the -D Parameter (No Modifications of Code and Configuration Files).

      

      Important

      • Keep the application parameters the same as those in the application.properties configuration file of your project.

      • If you configure the on-premises and cloud interconnection feature by using the new version of Alibaba Cloud Toolkit, the instance is already specified. You do not need to configure the xxl.job.admin.addresses parameter.

      • If you configure the on-premises and cloud interconnection feature by using the old version of Alibaba Cloud Toolkit, the instance is not specified. You need to set xxl.job.admin.addresses to the server address.

   4. After the project is started, confirm that the number of executors for the created application is 1.

      

3. Create an XXL-JOB job.

   Create a JobHandler job and click Run once in the Operation column of the job.

4. Click Execution List in the left-side navigation pane, and check the tasks whose status is success.

FAQ

• How do I use the old version of Alibaba Cloud Toolkit to enable the on-premises and cloud interconnection feature in IntelliJ IDEA?

  When you configure the on-premises and cloud interconnection feature, select Serverless App Engine (SAE) as the product, click Advanced Configuration in the upper right corner, and then select Enable XXL-JOB Interconnection in the Advanced Configuration dialog box.

References

• Push hot news and analyze financial data based on XXL-JOB and DeepSeek