Start/notes.ini Parameters/Retain_Mirror_Logs

Retain_Mirror_Logs

Parameter: Retain_Mirror_Logs
Short description: Prevents existing mirror console logs from being deleted at server startup. Only with Retain_Mirror_Logs=1 do the console1.log…console999.log files generated by Console_Log_Mirror=1 survive server restarts.

Profile

Parameter
Retain_Mirror_Logs
Component
Server
Category
Logging / Debug
Available since
Domino 8.x; currently documented in HCL Domino 10.0.1–14.5.1
Value format
0 (default, delete) or 1 (retain)
Prerequisite
Only effective with Console_Log_Mirror=1

Description

When Console_Log_Mirror=1 is enabled on a Domino server, the console-log mirror task generates additional, numbered mirror files console1.log, console2.log, ... in the IBM_TECHNICAL_SUPPORT directory in addition to console.log. This produces a real log history instead of just circularly overwritten data in console.log.
According to HCL Domino 10.0.1 documentation ("Using console log mirroring"), by default at server startup:
  • The mirror task deletes all existing console<N>.log files.
  • It then starts again with console1.log.
With Retain_Mirror_Logs=1, this deletion is suppressed:
  • The previous console1.log, console2.log, ... remain unchanged.
  • The mirror task continues numbering and fills the lowest free number (e.g., if console1.log, console2.log, console4.log exist, the next file created is console3.log, then console5.log).
  • The maximum number stays at 999 files; after that, Domino starts overwriting existing files again.

When to set the parameter?

  • Forensics / postmortem after a crash or restart – so that the mirror history does not disappear due to a simple restart.
  • Operational servers where mirror files are picked up externally (e.g. via log shipping, SIEM, backup) before being allowed to be cleaned up.
  • Diagnostic phases with frequent restarts (e.g. JVM tuning, configuration changes) – without Retain_Mirror_Logs=1, logs from the previous run would be gone after each restart.

Example

Enable mirroring and keep backups across server restarts:
Console_Log_Enabled=1
Console_Log_Mirror=1
Console_Log_Max_Kbytes=100000
Retain_Mirror_Logs=1
In ongoing operation, console.log, console1.log, console2.log, ... grow to 100 MB each; after a server restart the old files remain, and the mirror task seamlessly fits into the next free number.

Notes

  • Cleanup required – with Retain_Mirror_Logs=1, Domino deletes nothing at all anymore. Up to 999 × Console_Log_Max_Kbytes bytes can accumulate – with 100 MB per file, theoretically ~100 GB. Therefore clean up the IBM_TECHNICAL_SUPPORT directory regularly via OS jobs (cron, scheduled task) or archive older console<N>.log files.
  • Only in combination with mirroring – without Console_Log_Mirror=1, Retain_Mirror_Logs has no effect.
  • Change effective only after restart – the parameter takes effect at the next server start.
  • Companion parameters – Console_Log_Enabled, Console_Log_Mirror, Console_Log_Max_Kbytes, debug_outfile.

Sources (HCL Product Documentation)