How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I enable Message level debugging in AM (All versions) debug files?

Last updated Mar 16, 2022

The purpose of this article is to provide information on enabling Message level debugging in AM debug files. Message level debug files are frequently used for troubleshooting issues but are not recommended generally due to their size.


2 readers recommend this article

AM 7 and later

AM 7 and later uses Logback for configuring debug logging.

To configure debug logging in AM 7, either navigate to Logback.jsp to make temporary changes or create a logback.xml configuration file in the AM classpath to make persistent changes to debug logging.

See Debug Logging for further information.

Pre-AM 7

Note

You can use the Recording facility to capture debug logs. See How do I record troubleshooting information in AM (All versions)? for further information.

You can enable Message level debugging for all debug files or for individual debug files using Debug.jsp. You must have top level admin privileges to do this and be logged in to AM as the admin user (called amadmin by default).

There are four different debug levels available:

  • Off - disables debug logging.
  • Error - only logs error messages (default).
  • Warning - logs both warning and error messages.
  • Message - logs detailed diagnostic messages and debugging information.

Debug location

Debug files are located in the /path/to/openam/debug directory by default. You can check which directory is being used or change it using either the console or ssoadm:

  • Console: navigate to Deployment > Servers > [Server Name] > General > Debugging > Debug Directory.
  • ssoadm: enter the following command to view current settings and look for the com.iplanet.services.debug.directory property: $ ./ssoadm list-server-cfg -s [servername] -u [adminID] -f [passwordfile]replacing [servername], [adminID] and [passwordfile] with appropriate values.
  • ssoadm: enter the following command to update the directory: $ ./ssoadm update-server-cfg -s [servername] -u [adminID] -f [passwordfile] -a com.iplanet.services.debug.directory=[directory]replacing [servername], [adminID], [passwordfile] and [directory] with appropriate values.
Note

In Kubernetes deployments, AM writes its debug logs to stdout. See Pod Descriptions and Container Logs for further information on collecting debug logs in Kubernetes.

Enabling Message level debugging for all debug files

You can enable Message level debugging for all debug files using either the console or ssoadm:

  • Console: navigate to Deployment > Servers > [Server Name] > General > Debugging > Debug Level and select Message.
  • ssoadm: enter the following command: $ ./ssoadm update-server-cfg -s [servername] -u [adminID] -f [passwordfile] -a com.iplanet.services.debug.level=messagereplacing [servername], [adminID] and [passwordfile] with appropriate values.

Once you have reproduced the problem and captured the debug logs, you should revert the debug level to Error to avoid filling up the disks where the debug logs are stored.

Caution

Please be aware of the following:

Enabling Message level debugging for individual files

You can enable Message level debugging for individual debug files providing you are logged in as follows:

  1. Navigate to: <protocol>://host.fqdn:port/openam/Debug.jsp, for example: http://host1.example.com:8080/openam/Debug.jsp. An example Debug.jsp page looks like this:
  1. Select the required debug file from the Category field, select Message from the Level field and then click Submit to change the debug level.

Once you have reproduced the problem and captured the debug logs, you should revert the debug level to Error to avoid filling up the disks where the debug logs are stored.

Note

The Debug.jsp page always shows the debug level as Error, regardless of its actual setting.

See Also

How do I collect all the data required for troubleshooting AM and Agents (All versions)?

How do I enable debug logging for troubleshooting Agents (All versions)?

How do I clear debug logs in AM (All versions)?

Where can I find useful logs for troubleshooting ForgeRock products?

Troubleshooting AM and Agents

Debug Logging

Related Training

N/A

Related Issue Tracker IDs

N/A


Copyright and Trademarks Copyright © 2022 ForgeRock, all rights reserved.