How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I rotate AM (All versions) Fedlet debug logs?

Last updated Apr 13, 2021

The purpose of this article is to provide information on rotating AM Fedlet debug logs. Debug logs are located in the $HOME/fedlet/debug directory by default.


1 reader recommends this article

Rotating AM Fedlet debug logs

AM does not rotate Fedlet debug logs by default, but you can configure it to do so based on:

  • Time interval (in minutes) - for example, every 1440 minutes for once a day. The time interval specified starts when the first log message is logged to the log file.
  • Size (in MB) - for example, when the debug log reaches 2MB.
Note

It is recommended that you copy the debug logs prior to clearing the contents, rather than deleting the logs as this can cause issues if a process is still holding a filehandle. Additionally, you should keep debug logging to a minimum (level: error) and only increase it when troubleshooting an issue.

To configure Fedlet debug file rotation:

  1. Copy the debugconfig.properties file (located in the /path/to/tomcat/webapps/openam/WEB-INF/classes directory) to a temporary location.
  2. Edit the properties in the debugconfig.properties file as detailed in Rotating Debug Logs to configure debug log file rotation. For example, if you want your Fedlet debug logs to rotate every 1440 minutes with a suffix of the date and time, you would set the rotation and suffix properties in this file as follows: org.forgerock.openam.debug.rotation=1440 org.forgerock.openam.debug.suffix=-MM.dd.yyyy-HH.mm Alternatively, if you want your debug logs to rotate each time they reach 2MB with a suffix of the date and time, you would set the maxsize and suffix properties in this file as follows: org.forgerock.openam.debug.rotation.maxsize=2 org.forgerock.openam.debug.suffix=-MM.dd.yyyy-HH.mm_ss.SSS
  3. Copy the debugconfig.properties file to the /path/to/deployed/fedlet/WEB-INF/classes directory. Alternatively, you can package the debugconfig.properties file in the appropriate Fedlet WAR file (in the /WEB-INF/classes directory) and redeploy.
  4. Restart the web application container in which the Fedlet runs to apply these configuration changes.

See Also

How do I rotate AM 5.x and 6.x debug logs?

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

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

SAML v2.0 Guide › Implementing SAML v2.0 Service Providers by Using Fedlets

Related Training

N/A

Related Issue Tracker IDs

OPENAM-6450 (Log Number of History files count is ignored)


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