In addition to debugging a local deployment of your app, it is also possible to debug applications that are already in a cloud environment.
These instructions are for apps running in Mendix Cloud v4. If you are running an older version of Mendix which is deployed to Mendix Cloud v3 you need the previous version of this document here: Debug Microflows Remotely.
Debugging in a production environment is not recommended.
If you are debugging in the cloud, be aware of other app end-users. Breakpoints in the debugger will pause processes for all users of the app in this environment.
This how-to will teach you how to do the following:
- Connect the debugger in Studio Pro to your Mendix Cloud v4 environment
Before starting this how-to, make sure you have completed the following prerequisites:
- Have access as a team member to a Mendix app deployed to a licensed Mendix Cloud v4 environment
- Have TRANSPORT RIGHTS to the app environment you want to debug in the app’s node permissions
3 The Basics
In Mendix Cloud v4, the debugger is always listening for connections so you cannot turn it on or off. To debug your app in the cloud, you need to get a URL and a password from the app environment and provide that information to Studio Pro. The steps below explain how to do this.
The debugger supports only debugging of single-instance environments. Multi-instance environments need to be scaled down to one instance before the debugger can be used. See Scaling Your Environment in Mendix Cloud v4 for more information.
3.1 Obtain Debugging Credentials
3.1.1 Obtain Debugging Credentials from Mendix cloud
When your application is in the Mendix cloud:
Open your app in the Developer Portal.
Click Environments in the left sidebar.
In the Deploy tab, click Details for the environment which you want to debug:
In the General tab, click Show Debugger Information:
This invokes the Debugger settings pop-up window which provides a URL (such as
http://yourapp.mendixcloud.com/debugger/) and a password:
You will need to provide these credentials to Studio Pro to connect the debugger to the app running in the cloud.
3.1.2 Obtain Debugging Credentials from SAP S/4 HANA Cloud
If your application is on the SAP S/4 HANA cloud, you will need to set the password in the SAP Cockpit:
Log in to the SAP Cockpit and go to your application’s settings page.
Go to your application > User-Provided Variables.
Click on the button ‘Add variable’ and add ‘DEBUGGER_PASSWORD’ and the password. Both are case-sensitive.
Restart your application.
3.2 How to Enable Cloud Debugging in Studio Pro
Once you have the unique URL and password, there are two methods for connecting Studio Pro to the cloud environment.
If you do cannot connect the debugger, then you do not have sufficient permissions to your app. Ask the technical contact or the project SCRUM Master to provide the correct permissions.
Open the Connect Debugger dialog box – you can do this in two ways within Studio Pro:
Go to the Run menu and select Connect Debugger…:
Click Connect… in the Debugger pane:
In the Connect Debugger dialog box set the following:
- Connect to – select the option An app running in the Mendix Cloud or on another remote server.
- URL – the URL from the Debugger Settings for your app environment
Password – the Password from the Debugger Settings for your app environment
The debugger is now connected to your app running in the cloud.