Logging to the syslog

Edit online

When Copy Services Manager is running on a z/OS system, it can send messages to the z/OS syslog to help with diagnosing problems or externally automating actions based off of certain Copy Services Manager messages.

About this task

You can configure z/OS syslog message output by modifying properties in the rmserver.properties configuration file.
  • You can toggle the message output on and off.
    Note: By default, this logging is turned off, so you must enable it if you want to see these messages.
  • You can choose to log all messages, or a subset of messages to the syslog.
Prerequisite: You must have Administrator privileges to perform this action.

Procedure

  1. Open the rmserver.properties file. You can access this file from the Copy Services Manager GUI under Settings > Server Properties. You can manually enter and edit the file properties on that page.
    Note: See rmserver.properties file for more information on locating and using this file.
  2. Set the following properties in the rmserver.properties file to enable and control the messages that are logged to the z/OS syslog:
    com.ibm.csm.zconsole.logging=none (default) | all | error
    Specifies the standard out logging level to the syslog, where the possible values are none, all, or error.
    • When none is specified, Copy Services Manager does not log to the syslog at all (default).
    • When all is specified, Copy Services Manager logs all I, W, and E messages to the syslog.
    • When error is specified, Copy Services Manager logs all W and E messages to the syslog.
    Example: To log all messages: com.ibm.csm.zconsole.logging=all
    com.ibm.csm.zconsole.logging.includechildren=true | false (default)
    Specifies whether or not to log child messages to the syslog. By default, only high level messages are logged. Child messages are not logged. Use this property setting to override this behavior and enable child messages to be logged.
    Notes:
    • Be aware that setting the logging to all messages, including the child messages, can result in a very large amount of messages. Only set the includechildren property to true when it is important to see the child messages.
    • When you set the includechildren property to true, all child messages are printed to the syslog, including any in the excludedmsgs list, as discussed next.
    Example: To log all child messages: com.ibm.csm.zconsole.logging.includechildren=true
    com.ibm.csm.zconsole.logging.excludedmsgs=<messages to exclude in comma-separated list>
    Specifies which messages to exclude from writing to the syslog, where the values are a comma-separated list of message IDs. Any ID in the list will not appear in the syslog.
    Note: The excludedmsgs property is only for parent messages.
    Example: To exclude the IWNR1028I and IWNR6000I messages from being logged: com.ibm.csm.zconsole.logging.excludedmsgs=IWNR1028I,IWNR6000I