Suite Codex

Modules

SuiteScript N/log Module

Using N/log Module

SuiteScript N/log module logs script execution details.

Introduction to N/log Module

The N/log module in SuiteScript is a crucial tool for developers working with NetSuite. It provides a simple and effective way to log messages and details during script execution, aiding in debugging and monitoring your scripts. This module offers methods to log different levels of messages, including audit, debug, error, and emergency.

Importing the N/log Module

To use the N/log module in your SuiteScript, you must first import it using the require function. Here's how you can do it:

Logging Methods

The N/log module provides several methods to log different types of messages. Understanding these methods will help you choose the appropriate one for various scenarios:

  • log.audit(title, details): Use this method to log informational messages that are noteworthy.
  • log.debug(title, details): This method is used for logging detailed information, typically for development and debugging purposes.
  • log.error(title, details): Use this method to log error messages when something goes wrong.
  • log.emergency(title, details): This method is for logging critical issues that require immediate attention.

Using log.audit()

The log.audit() method is ideal for capturing general information about the script's execution, such as start and end times or key checkpoints. Here's an example:

Using log.debug()

Use the log.debug() method to log detailed information that can help you diagnose issues during development. For example:

Using log.error()

The log.error() method is crucial for capturing errors that occur during script execution. Here's how you might use it:

Using log.emergency()

The log.emergency() method is reserved for critical issues that need immediate attention, such as system failures. An example usage is:

Best Practices for Logging

When using the N/log module, keep the following best practices in mind:

  • Use clear and descriptive titles for your log messages to make them easy to understand.
  • Log only the necessary information to avoid cluttering the log files.
  • Use appropriate log levels based on the severity of the message.
  • Avoid logging sensitive information such as passwords.

Conclusion

The N/log module is an essential tool for tracking and debugging your scripts in NetSuite. By effectively using its various logging methods, you can gain insights into your script's execution and quickly identify and resolve issues.

Modules

Next
N/task Module