OutSystems Dev Tip: Logging Information on Server Side

Logging information is a crucial part of debugging and monitoring your applications. While outputting information to the console works well for client actions, it’s not as effective for server actions. That's where the OutSystems Log Message server action comes in handy.

Why Use Log Message Server Action?

Logging helps track the flow of your application and pinpoint issues quickly. When dealing with server actions, logging becomes essential to monitor processes that aren't visible on the client side. The Log Message server action in OutSystems allows you to log specific messages and data points, helping you keep an eye on your server-side operations.

Step-by-Step Guide to Using Log Message Server Action

Let's walk through how to use the Log Message server action with a practical example.

Setting Up the Data Action:

• • We have a screen that uses a data action to retrieve some data. Inside this data action, there is an SQL query.

Adding Logging in Data Action:

1. • To add logging, we start by grabbing the Run Server Action. Search for the Log Message action.
   • Insert your log message, for instance, "Get data started". Use the Get Entry ESpace Name for the module name.

Logging Completion and Results:

1. • Copy the log message action and paste it at the end of your data action.
   • Modify the message to indicate completion, like "Get data finished", and include a count or any other relevant data.

Publishing and Monitoring:

• • Publish your changes and open the screen to execute the data action.
  • Go back to Service Studio, click the gear button to open Service Center.
  • In Service Center, navigate to Monitoring > General.
  • Select your module, for example, "Dev Tips", and filter by it. You should see your log messages such as "Get data started" and "Get data finished", along with the count.

Benefits of Using Log Message Server Action

Using the Log Message server action provides several benefits:

• Visibility: It gives you visibility into server-side processes, making debugging easier.
• Efficiency: Quickly identify where issues occur within server actions.
• Data Tracking: Monitor specific data points and operational steps in your applications. 

Logging is an indispensable part of application development and maintenance. By effectively using the Log Message server action in OutSystems, you can enhance your debugging process, making it more efficient and thorough.

Want to learn more valuable Dev Tips?  Sign up for our newsletter and stay updated with the latest insights! Also, don't forget to check out our upcoming OutSystems courses to scale your career.