How To: Add Separators Between Log Entries

Version Affected: All

 

Overview

This article explains how to add a header and/or footer separator between log entries in a realm's Audit, Debug, and Warning log files, so individual entries are easier to tell apart when reviewing them. Out of the box, SecureAuth writes log entries with no separator between them:

Adding header and/or footer text produces logs like this instead:

The steps below apply the same header/footer setting to any of the three log files.

Add Separators Between Log Entries

1. In the realm's web admin interface, go to the System Info tab.
2. Click Click to edit Web Config file. at the bottom of the page.
3. In the Web Config Editor, find the XML node for the log you want to add a separator to:
   • Audit log: <add name="Audit Text File"
   • Debug log: <add name="Debug Text File"
   • Warning log: <add name="Error Text File"
4. On that node, find the header="" and footer="" attributes. Both are empty by default, meaning no separator is defined.
5. Enter the separator text between the quotes for whichever attribute(s) you want to use:
   • Text in header is written before each log entry.
   • Text in footer is written after each log entry.
6. Save the change. Repeat on the Audit, Debug, or Warning log node for each log file you want separators added to.

SecureAuth Knowledge Base Articles provide information based on specific use cases and may not apply to all appliances or configurations. Be advised that these instructions could cause harm to the environment if not followed correctly or if they do not apply to the current use case.

Customers are responsible for their own due diligence prior to utilizing this information and agree that SecureAuth is not liable for any issues caused by misconfiguration directly or indirectly related to SecureAuth products.