000016679 - RKM Client: Where does log output go?

Document created by RSA Customer Support Employee on Jun 16, 2016Last modified by RSA Customer Support Employee on Apr 21, 2017
Version 2Show Document
  • View in full screen mode

Article Content

Article Number000016679
Applies ToRSA Key Manager Client
IssueRKM Client: Where does log output go?
Resolution

RKM C Client 1.5.2.3 and earlier:
- Set kms.debug=true in the config file
- Log output goes to stdout and stderr

RKM C Client 1.5.2.4:
- Additional configuration setting, kms.logFile=<name of log file>
- Log output goes to that file


RKM C Client 2.x and later:
- Set error, warning, and/or audit=true in the config file, e.g.:
    svcType=logSvc
    configName=log_cfg_1
    error=true
    warning=true
    audit=true

- Log output goes to operating system-specific log (Event Viewer on Windows, syslog on UNIX.  syslog can be set up to write to a file).

Windows Event Viewer > Application log
  Debug events are logged from the Source "KM DEBUG".
  Errors are logged from the Source "KM ERROR".
  Warnings are logged from the Source "KM WARNING".
  Audit events are logged from the Source "KM AUDIT" in RKM 2.0 and "RKMCClient" in RKM 2.1+.

This is documented in the RSA Key Manager C Client Developer's Guide (doc/dev_guide/index.html), Architectural Overview > Log Service Provider:

"The Key Manager Client Log Service Provider provides logging of run-time operations for audit, diagnostic and application management purposes. All log messages are written to the system log for the specific platform that the Key Manager Client is running on. That is, the Windows Event Logging System (ELS) for systems running a Windows? operating system and syslog for systems running a UNIX? or a Linux? operating system."


RKM Java Client 1.5.2.x:
- Set kms.debug=true in the config file
- Log output goes to stdout and stderr

RKM Java Client 2.x
and later:
- Modify testdata/log4j.properties by changing the commented lines to switch the debug from OFF to INFO:

Change

#------------------------------------------------------------------------------
# Application Logger (NOTE: kmc.debug is the Application Logger)
# Levels for the Application Logger are ERROR, WARN, and INFO
#------------------------------------------------------------------------------
log4j.logger.kmc.debug=OFF,file
#log4j.logger.kmc.debug=INFO,console,file

to

#------------------------------------------------------------------------------
# Application Logger (NOTE: kmc.debug is the Application Logger)
# Levels for the Application Logger are ERROR, WARN, and INFO
#------------------------------------------------------------------------------
#log4j.logger.kmc.debug=OFF,file
log4j.logger.kmc.debug=INFO,console,file


Most log messages go to the audit log.  The default location is gen/log/rkm_java_client_audit.log.

Legacy Article IDa42336

Attachments

    Outcomes