LogTransporter
Overview
LogTransporter is a specialized library designed to cater to the growing needs of applications built on the Mendix platform.
It bridges the gap between Mendix's logging mechanism and third-party systems with support for HTTP endpoints.
Send your Mendix logs to any HTTP endpoint to process and analyze them!
Documentation
Step-by-Step Implementation Guide
1. Implement AfterStartup Microflow
- Begin by including the AfterStartup_LogTransporter into your Mendix application's AfterStartup microflow. This step is essential for initiating LogTransporter's functionalities upon your application's startup
2. Implement Configuration Snippet
- Next, insert the provided 'SNIP_LogTransporterConfiguration' snippet into your application's configuration page or create a new page if it doesn't already exist. This Snippet centralizes the settings and controls for the LogTransporter
3. Deploy your application
- Commit the changes and deploy the application, no constants are used*
*Since version 5.3.0 there is a constant for the environment. Make sure to set this for every environment.
4. Configuring the LogTransporter
- After the deployment, login to the application and navigate to the Configuration page you added earlier
- Auto start - When enabled, the LogTransporter runs automatically every time the application restarts
- App sub domain name - This can be any app identifier. Preferably use the prefix of your application URL here. So if your default app URL is mendixapp.mendixcloud.com / mendixapp-accp.mendixcloud.com then your sub-domain is "mendixapp"
- Connection URL - Fill in the Endpoint of where you want the Logs to be transported to
- Username & Password - Fill in the usename and password that are needed for authentication at the Endpoint
- Environment* - Fill in the environment that the LogTranporter is running on. (test, acceptance, production etc.) *From version 5.3.0 you need to configure this in the environment constants
- License key - Please fill in the License key you have received here to fully use the LogTransporter. Without a valid License key the module will be in Demo-mode
- After configuration, click 'Save' and then on the 'Restart' button. If everything is configured correctly the LogTransporter will start sending Logs
5. Verify functionality
- Lastly, to ensure the successful implementation, monitor the target system. Verify if the logs from your Mendix application are being correctly routed and recorded
Additional Information
- DEMO Mode - This mode has a limit of 20 transports. For the full version, email logtransporter@cape.nl
- Advanced - When a set time period elapses or when the log buffer is full, a transport occurs. Adjust these settings in the 'Advanced' tab.A buffer might hold multiple log lines, so a single transport event can send several log lines at once
Releases
LogTransporter 5.3.0 (Mx11 release)
- Changed the Environment variable to a Constant (!)
- Changed the default TransportType to ECS
- Fixed warnings
- Updated ECS version and format
- Updated licenser functionality
- Updated dependencies
- Visual improvements
- Various bug fixes and performance improvements
After updating, please check if there are any old jar files that can be deleted.
Additionally, because the environment variable has been moved to a constant, it’s crucial to set this value when deploying to any environment. The default value will be “demo”
LogTransporter 5.2.1 (Mx10 release)
- Changed the Environment variable to a Constant (!)
- Changed the default TransportType to ECS
- Fixed warnings
- Updated ECS version and format
- Updated licenser functionality
- Updated dependencies
- Visual improvements
- Various bug fixes and performance improvements
After updating, please check if there are any old jar files that can be deleted.
The only files in the userlib folder related to the LogTransporter should be:
logtransporter-5.2.1.jar & logtransporter-5.2.1.logtransporter.RequiredLib
Additionally, because the environment variable has been moved to a constant, it’s crucial to set this value when deploying to any environment. The default value will be “demo”
- Make the implementation more robust.
- Add more tunables parameter. This can be used to set the minimum server timeout.
- Upgrade dependencies to latest version.
- Update dependencies to latest version.