Configure Logging

By default, the Keyfactor Cloud Gateway outputs logging information to both the Windows event log and the local file system, places file system log files in the c:\cms\logs directory, generates file system logs at the Info logging level, and stores file system logs for two days before deleting them.

If you wish to change these defaults:

1. On the Keyfactor Cloud Gateway server where you wish to adjust logging, open a text editor (for example, Notepad) using the Run as administrator option.

2. In the text editor, browse to open the NLog.config file in the directory in which you installed the Keyfactor Cloud Gateway. By default, this is the following directory:

   C:\Program Files\Keyfactor\Keyfactor Managed CA Gateway

3. Your NLog.config file may have a slightly different layout than shown here, but it will contain the fields highlighted in the below figure. The fields you may wish to edit are:

   • The path and file name of the active CA A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. gateway log file:

     fileName="C:\cms\logs\CA_Gateway_Log.txt"
     Important:  If you choose to change the path for storage of the log files, you will need to create the new directory (for example, D:\GatewayLogs) and grant the service accounts under which the CA gateway services run full control permissions on this directory.
     Tip:  If you're using clustering, you may want to set the path to a location on your shared storage disk accessible to all nodes so that all nodes in the cluster will write logs to the same location.

   • The path and file name of previous days' CA gateway log files:

     archiveFileName="c:\cms\logs\CA_Gateway_Log_Archive_{#}.txt"

     The CA gateway rotates log files daily and names the previous files using this naming convention.

     Tip:  If you're using clustering, you may want to set the path to a location on your shared storage disk accessible to all nodes so that all nodes in the cluster will archive logs to the same location.

   • The number of archive files to retain before deletion:

     maxArchiveFiles="2"

   • The level of log detail that should be generated:

     name="*" minlevel="Info"

     The default Info level logs error and some informational data but at a minimal level to avoid generating large log files. For troubleshooting, it may be desirable to set the logging level to Debug or Trace. Available log levels (in order of increasing verbosity) are:

     • OFF: Turns off logging.

     • FATAL: Logs severe errors that cause early termination.

     • ERROR: Logs severe errors and other runtime errors or unexpected conditions that do not cause early termination.

     • WARN: Logs warnings such as deprecated API An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. usage, poor API usage, and other undesirable or unexpected runtime conditions.

     • INFO: Logs all the above, plus general runtime events such as startup and shutdown.

     • DEBUG: Logs all the above, plus detailed information about system behavior and execution flow.

     • TRACE: Logs all available information. This level can result in significant log volume.