-
Title
How to automate Active Roles logging (debug) -
Description
When you turn on debug logging in Active Roles Server, the size of the debug log may increase very quickly. As a result, the log file may eventually fill up the entire hard disk.
-
Resolution
STATUS
There is currently no method to limit the log file growth within Active Roles Server natively. Once debug logging is enabled, it will remain enabled until you turn it back off.
WORKAROUND
WARNING: Using Registry Editor incorrectly can cause serious problems that can damage the operating system and the software installed. One Identity cannot guarantee that problems resulting from the incorrect use of Registry Editor can be solved. Use Registry Editor at your own risk.
Active Roles Server includes the debug logging feature for support and troubleshooting purposes. When debug logging is turned on, Active Roles Server creates the log file named ds.log.
The size of the ds.log file may increase very quickly so it is not recommended to keep debug logging enabled for a long period of time. Nevertheless, you may be asked by Support to keep debug logging enabled for several days in case of volatile or uncommon issues. As a result, your debug log may grow excessively large. To cope with this situation, you can use the attached script, ARS-Logging.ps1, to mitigate the effects of the large file growth.
The ARS-Logging.ps1 script is able to perform two separate functions. The main function is for monitoring of the debug log file (ds.log) size, then when a maximum size is reached, the log file is compressed and then shipped (moved) to a destination folder. This allows for enabling debug logging for longer periods of time without worrying about the hard drive running out of disk space. The second function of this script allows you to enable debug logging for a specified period of time, at which time it will disable the logging. This is useful for gathering logs over a specific period of time without having to be around to stop it at the end of the gather period.
SYNTAXARS-Logging.ps1 -Days <Int32>ARS-Logging.ps1 -Hours <Int32>ARS-Logging.ps1 -Minutes <Int32>ARS-Logging.ps1 -Destination <String> [-MaxMegabytes <Int32>]PARAMETERS-Days <Int32>This parameter is used to define the amount of time in DAYS for the logging to run. This parameter enables the timed logging functionality.-Hours <Int32>This parameter is used to define the amount of time in HOURS for the logging to run. This parameter enables the timed logging functionality.-Minutes <Int32>This parameter is used to define the amount of time in MINUTES for the logging to run. This parameter enables the timed logging functionality.-Destination <String>This parameter is used to set the destination folder where the compressed log file will be shipped to. This parameter enables the log shipping functionality.-MaxMegabytes <Int32>This parameter is used to set the maximum log file size which will trigger it to be compressed and shipped.EXAMPLES-------------------------- EXAMPLE 1 --------------------------PS C:\>ARS-Logging.ps1 -Days 2Enables debug logging for 2 days.-------------------------- EXAMPLE 2 --------------------------PS C:\>ARS-Logging.ps1 -Hours 3Enables debug logging for 3 hours.-------------------------- EXAMPLE 3 --------------------------PS C:\>ARS-Logging.ps1 -Minutes 5Enables debug logging for 5 minutes.-------------------------- EXAMPLE 4 --------------------------PS C:\>ARS-Logging.ps1 -Destination 'C:\Temp\DSLogs' -MaxMegabytes 500Monitors debug log until it reaches 500MB in size, at which time it gets compressed and shipped (moved) to the 'C:\Temp\DSLogs' folder.The ARS-Logging.ps1 script must be run on the computer running the Administration Service. The script can stay running and will monitor the ds.log file size and will action appropriately.
-
Attachments