Configuring IBM Spectrum Symphony with R

To enable IBM® Spectrum Symphony to use your R scripts, you must configure IBM Spectrum Symphony.

Before you begin

To use IBM Spectrum Symphony to with your R scripts, you must have R installed and configured on your system.

Procedure

  1. Configure R with IBM Spectrum Symphony on the client side by setting IBM Spectrum Symphony environment variables:
    1. Specify how to handle log messages in the RClient agent process using the SYMPHONY_R_LOG_STDIO environment variable.
      • Specify YES or yes if you want log messages in the RClient agent process to be printed to stdio. Use this syntax: SYMPHONY_R_LOG_STDIO=YES|yes
      • Specify No or no, or do not set a value, if you want the log file to be printed to the RClientAgent.host_name.log file in the current directory on the local host. Use this syntax: SYMPHONY_R_LOG_STDIO=NO|no.

      By default, this environment variables is not set.

      Note: If the log messages in the RClient agent process are printed to stdio, which are duplicated with the RClient process, there is a possibility of messages overlapping between the RClient agent process and the RClient process.
    2. Specify the level of details for R log files. Specify either DIABLE, ERROR, WARN, INFO, DEBUG, or ALL. The default is INFO. Use the syntax SYMPHONY_R_LOG_LEVEL=DISABLE|ERROR|WARN|INFO|DEBUG|ALL

      For example, if you set the SYMPHONY_R_LOG_LEVEL environment variable to a value of INFO, the level of logs on the client side will be set to informational logs.

  2. Configure R with IBM Spectrum Symphony on the service side:
    1. Set the SYMPHONY_R_LOG_LEVEL environment variable under the Service > OsTypes > osType > env > name section of the application profile.
      For example, if you specify <env name="SYMPHONY_R_LOG_LEVEL">INFO</env> in the application profile, the level of logs on the service side will be set to informational logs.
      Note: You cannot set SYMPHONY_R_LOG_STDIO on the service side.
    2. If R is not installed in the /usr/local/bin directory, change the R path in the Service > OsTypes > osType > env > name=PATH section of the application profile.

      Currently, the <env name="PATH">/usr/local/bin:/bin</env>. Change the value to where you have installed R. For example, if you have installed R to /opt/R/bin, then change the application profile section to <env name="PATH">/opt/R/bin:/bin</env>.

    3. If R sh command (used to spawn R processes in the service side) is not installed in the /bin directory, change the sh path in the Service > OsTypes > osType > env > name=PATH section of the application profile.

      Currently, the <env name="PATH">/usr/local/bin:/bin</env>. Change the value to where you have installed the sh command. For example, if you have installed the sh command to /usr/bin, then change the application profile section to <env name="PATH">/opt/R/bin:/usr/bin</env>.