Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 5.9.0 - Administration Guide

Preface Introduction The concepts of SPS The Welcome Wizard and the first login Basic settings User management and access control Managing SPS
Controlling SPS: reboot, shutdown Managing Safeguard for Privileged Sessions clusters Managing a high availability SPS cluster Upgrading SPS Managing the SPS license Accessing the SPS console Sealed mode Out-of-band management of SPS Managing the certificates used on SPS
General connection settings HTTP-specific settings ICA-specific settings RDP-specific settings SSH-specific settings Telnet-specific settings VMware Horizon View connections VNC-specific settings Indexing audit trails Using the Search (classic) interface Using the Search interface Searching session data on a central node in a cluster Advanced authentication and authorization techniques Reports The SPS RPC API The SPS REST API SPS scenarios Troubleshooting SPS Configuring external devices Using SCP with agent-forwarding Security checklist for configuring SPS Jumplists for in-product help Third-party contributions About us

Customize system logging in SPS

SPS uses the syslog-ng Open Source Edition application (version 3.9) for system logging. Starting with SPS 5 LTS, you can customize its configuration to better integrate SPS into your logging infrastructure. If you are not familiar with syslog-ng Open Source Edition, read how syslog-ng OSE works. Customizing the configuration of syslog-ng Open Source Edition allows you to better integrate the log messages of SPS into your environment, for example, to:

  • change the message format or rename message fields,

  • send the messages to multiple logservers or SIEMs, or to

  • select (filter) which messages to send to your logserver.


Note that not every feature described in the syslog-ng Open Source Edition documentation is available on SPS. Typically, features that are only rarely used on logging clients are not available, for example, Java-based destinations like HDFS and Elasticsearch. For a detailed list of available modules, execute the syslog-ng --module-registry command.

Customize the syslog-ng configuration

Do not change the syslog configuration of SPS unless you know exactly what you are doing. Incorrect changes can decrease the performance of SPS, disable system logging, or cause message loss. In particular, note the following points:

  1. Create a SPS configuration snippet in a file. Make sure that the filename ends with .conf. Note that syslog-ng OSE uses the configuration objects defined in these files only if they are used in a log path as well, so make sure to include a log path.

    Do not loop messages. That is, make sure that the a destination does not send a message back to the original source of the message (doing so would cause an infinite loop).

  2. Copy it to the /etc/syslog-ng/conf.d/ directory of the core firmware. (If you are using a high-availability SPS cluster, SPS automatically copies the file to the secondary node as well.)

    Files located in this directory do not cause the SPS configuration to be tainted. SPS automatically includes these files in the configuration of syslog-ng Open Source Edition.

    Do not modify the original configuration files (for example, /etc/syslog-ng/syslog-ng.conf or /etc/syslog-ng/conf.d/message-queue-client.conf).

  3. Verify that the resulting syslog-ng OSE configuration file is syntactically valid. The configuration is valid if executing the following command does not show any syntax errors: syslog-ng --syntax-only --no-caps

  4. Your changes will take effect only after you reload the configuration of syslog-ng Open Source Edition using the following command: syslog-ng-ctl reload

    If there are any errors in the configuration, SPS keeps on using the earlier configuration. In this case, correct the configuration, because if SPS reboots while the syslog-ng OSE configuration is invalid, SPS will not be able to log messages.

Available sources

You can use the following sources in your custom configuration. These sources are defined in the stock configuration file of syslog-ng OSE, and are in regular syslog message format (except for s_message_queue_client).

  • s_core_journal: Logs of the SPS host, including log messages about the audited sessions.

  • s_message_queue_client: Logs about the audited sessions in JSON format.

  • s_slave_boot: Logs from the boot firmware of the secondary node in a high-availability SPS cluster.

  • src: Log messages of local SPS services.

  • src-internal: The internal logs of syslog-ng OSE running on SPS.

Certificates and encrypted connections

If you are using a custom destination that requires a certificate (either to authenticate SPS, or to verify the identity of the logserver). In this case, copy the certificates to SPS into the /etc/syslog-ng/conf.d/ directory. In the custom syslog configuration you cannot use the certificates uploaded to SPS using the web interface.

SIEM integration

Customizing the syslog configuration of SPS allows you to send log messages directly to your SIEM (for example, Splunk), in a format that your SIEM can understand.

One Identity can provide you the configuration files needed to send the log messages of SPS to Splunk in the Splunk Common Information Model (CIM) format. If you are interested, contact our Support Team.

If you need assistance to use another SIEM format, contact


The following configuration snippet reads the messages from the built-in s_message_queue_client source, parses the JSON message, and sends the messages to a remote destination using the RFC5424 message format (the body of the message remains in JSON).

parser json {

destination d_custom_remote {
        template("$(format-json --key .scb.*)\n")

log {

A sample log message using the above configuration is the following (line-breaks added for clarity):


To use this configuration snippet on your SPS, copy it to a file (make sure that the filename ends with .conf), change the IP address and port number to match your environment, copy it to the core firmware of your SPS into the /etc/syslog-ng/conf.d directory, then reload the syslog-ng configuration using syslog-ng-ctl reload.

Configuring system monitoring on SPS

SPS supports the SNMPv2c and SNMPv3 protocols. The SNMP server set on the Management tab can query status information from SPS.


In order to have your central monitoring system to recognize the SNMP alerts sent by SPS, import the SPS-specific Management Information Base (MIB) into your monitoring system. Download all MIBs by navigating to Basic Settings > Alerting & Monitoring and clicking Download MIBs and import them into your monitoring system. For details, see the documentation of your monitoring system.

Configuring monitoring


To configure monitoring, complete the following steps:

  1. Navigate to Basic Settings > Alerting & Monitoring.

  2. The default threshold values of the parameters are suitable for most situations. Adjust the thresholds only if needed.

  3. Click Commit.

  4. Navigate to Basic Settings > Management and verify that the SNMP settings and Mail settings of SPS are correct. SPS sends alerts only to the alert e-mail address and to the SNMP server.


    Sending alerts fails if these settings are incorrect.

The following sections describe the parameters you can receive alerts on.

Health monitoring

SPS continuously monitors a number of parameters of the SPS hardware and its environment. If a parameter reaches a critical level (set in its respective Maximum field), SPS sends e-mail or SNMP messages to alert the administrator.

Figure 51: Basic Settings > Alerting & Monitoring — health monitoring

  • Disk utilization maximum: Ratio of free space available on the hard disk. SPS sends an alert if the audit trails use more space than the set value. Archive the audit trails to a backup server to free disk space. For details, see Archiving and cleanup.


    The alert message includes the actual disk usage, not the limit set on the web interface. For example, you set SPS to alert if the disk usage increases above 10 percent. If the disk usage of SPS increases above this limit (for example to 17 percent), you receive the following alert message: less than 90% free (= 17%). This means that the amount of used disk space increased above 10% (what you set as a limit, so it is less than 90%), namely to 17%.

  • Load average: The average load of SPS during the last one, five, or 15 minutes.

  • Swap utilization maximum: Ratio of the swap space used by SPS. SPS sends an alert if it uses more swap space than the set value.

Related Documents