IAP Event Logs
  • Dark
    Light
  • PDF

IAP Event Logs

  • Dark
    Light
  • PDF

Log Message Activity

IAP supports the following log severity levels.

Log Level Description
error The most severe level. Indicates a problem, such as a prematurely terminated program.
warn Used for warning conditions. Warn events may or may not indicate a problem.
info Used for informational messages.
debug Used only when debugging problems or transactions. Provides detailed information on messages between IAP adapters and external systems.
trace Trace events have a higher verbosity than debug. Trace events are uncommon.
spam The least severe level. Spam events have the highest verbosity and are rare.

Syslog Settings

IAP log settings specify where logs are stored, log rotation behavior, and event severity.

To view or change log settings in IAP:

  1. Navigate to the Admin Essentials application from the IAP homepage.
  2. Select Profiles from the left navbar to open the accordian menu, and select a profile. In the example below, profile1 was selected.
  3. Click the Configure tab to open the editor.
  4. Click loggerProps from the Edit Profile Properties list.
  5. Scroll to the Syslog property section to configure your log settings.
  6. Click Save to retain your changes.
  7. Restart IAP.

01-loggerPropsSyslog-21.1.png

Logging Settings

Default Logging settings are referenced below.

{
  "description": "Logging",
  "log_max_files": 100,
  "log_max_file_size": 10485760,
  "log_level": "debug",
  "log_directory": "/var/log/pronghorn",
  "log_filename": "pronghorn.log",
  "console_level": "warn"
}

Global Log Instance (Developers)

Adapter and application developers can log events using the IAP global log instance of the Logger class. The log methods specify the event severity. Each takes an argument, a string to be saved in the logs.

Logging Best Practices

For inside functions:

  • Log non-sensitive passed arguments at debug severity.
  • Log non-sensitive returned data at debug severity.

Examples

Event Method Message
Error Severity log.error() This message will be recorded as an error. It will be sent for all severity levels.
Warning Severity log.warn() This message will be recorded as a warning. It will be sent for severity levels warn, info, debug, trace, and spam.
Informational Severity log.info() This message will be recorded as informational. It will be sent for severity levels info, debug, trace, and spam.
Debug Severity log.debug() This message will be recorded as debug. It will be sent for severity levels debug, trace, and spam.
Trace Severity log.trace() This message will be recorded as a trace. It will be sent for severity levels trace and spam.
Spam Severity log.spam() This message will be recorded as spam. It will only be sent for severity level spam.

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.