One Identity Safeguard for Privileged Sessions 6.0.5 - Administration Guide

Plugin troubleshooting

On the default log level, One Identity Safeguard for Privileged Sessions (SPS) logs everything that the plugin writes to stdout and stderr. Log message lines are prefixed with the session ID of the proxy, which makes it easier to find correlating messages.

To transfer information between the methods of a plugin (for example, to include data in a log message when the session is closed), you can use a cookie.

If an error occurs while executing the plugin, SPS automatically terminates the session.

Reports

One Identity Safeguard for Privileged Sessions (SPS) periodically creates reports on the activity of the administrators, its system information, as well as the processed traffic. In addition, you can use the connection database for creating custom reports from connection statistics.

These reports are available in Portable Document (PDF) format by selecting Reporting > Reports from the Main Menu. The reports are displayed on a search interface. For more information on using and customizing this interface, see Using the internal search interface.

The reports are also sent to the e-mail address set at Basic Settings > Management > Mail settings > Send reports to, unless specified otherwise in the configuration of the report.

Figure 264: Reporting > Reports — Browsing reports

Reports can be generated for fixed periods:

• Daily reports are generated every day at 00:01.

• Weekly reports are generated every week on Monday at 00:01.

• Monthly reports are generated on the first day of every month at 00:01.

You can also generate a partial report if necessary, for details, see Generating partial reports.

To access the reports from the SPS web interface, the user must have the appropriate privileges (for custom reports, the default requirement is membership in the search group). In addition, individual reports might have different access requirements configured. For more information on configuring user rights, see Managing user rights and usergroups.

The following information is available about the reports:

• Download: A link to download the report.

• Name: Name of the report.

• Interval: The length of the reported period, for example week, month, and so on.

• Report from: The start of the reported interval.

• Report to: The end of the reported interval.

• Generate time: The date when the report was created.

Contents of the operational reports

The operational reports of One Identity Safeguard for Privileged Sessions (SPS) are available in Adobe Portable Document Format (PDF), and contain the following information:

• Configuration changes: Lists the number of SPS configuration changes per page and per user. The frequency of the configuration changes is also displayed on a chart.

• Main reports: Contains statistics about the total traffic that passed SPS, including the number of sessions that passed for every connection policy, the used usernames, clients, and servers, and so on.

  NOTE: Connections that are still in progress when the report is generated are excluded from the report. Sessions that are being indexed and reporting jobs are listed in the Sessions with in progress indexing or reporting jobs section of the report.

• Reports by connection: Contains separate statistics about every connection policy configured on SPS.

• System health information: Displays information about the filesystem and network use of SPS, as well as the average load.

Configuring custom reports

To configure a report, create a chapter and assign any of the existing subchapters to it. The following sources (statistics or other queries) are available as reporting subchapters:

• The indexed contents of audit trails, as described in Indexing audit trails.

• The statistics of an audit trail search, as described in Displaying statistics on search results.

• Custom queries of the connection database, as described in Creating statistics from custom database queries. The list of tables and fields you can query are described in Database tables available for custom queries.

To configure One Identity Safeguard for Privileged Sessions (SPS) to create custom reports, complete the following steps with a user that has read & write/perform access to the Reporting > Content subchapters privilege.

For more information on configuring user rights, see Managing user rights and usergroups.

To configure SPS to create custom reports

1. Login to the SPS web interface, and navigate to Reporting > Configuration.

   Figure 265: Reporting > Configuration — Configuring custom reports

   

2. Click and enter a name for the custom report.

3. Select Table of contents > Add Chapter, enter a name for the chapter, then click OK. Repeat this step to create further chapters if needed.

4. If you want to have the logo of your organization on the cover page of the report (instead of the One Identity logo), select Choose new logo > Browse, select your logo file, then click Upload. You can upload GIF, JPEG, and PNG images. SPS will automatically resize the image to fit on the cover page.

5. Select Add Subchapter to add various reports and statistics to the chapter. The available reports will be displayed in a pop-up window.

   • Subchapters created from indexed contents of audit trails are listed under Misc.

   • Subchapters created from custom statistics are listed under Search statistics.

   • Subchapters created from custom database queries are listed under Advanced statistics.

   • Subchapters created from search queries are listed under Search-based subchapters.

   Figure 266: Reporting > Configuration > Add Subchapter — Adding subchapters to reports

   

   NOTE: When creating a subchapter that searches for keywords in HTTP, only the timestamp of the results will be visible in the report, without data.

6. Use the arrows to change the order of the subchapters if needed.

7. Select how often shall SPS create the report from the Generate this report every field. Weekly reports are created on Mondays, while monthly reports on the first day of the month. If you want to generate the report only manually, leave this field empty.

8. By default, members of the report group can access the custom reports via the SPS web interface. To change this, enter the name of a different group into the Reports are accessible by the following groups field, or click to grant access to other groups.

   NOTE: Members of the listed groups will be able to access only these custom reports even if their groups does not have read access to the Reporting > Reports page. However, only those reports will be listed, to which their group has access to.

9. By default, SPS sends out the reports in e-mail to the address set in the Basic Settings > Management > Mail settings > Send reports to field.

   NOTE: If this address is not set, the report is sent to the SPS administrator's e-mail address.

   • To disable e-mail sending, unselect the Send reports in e-mail option.

   • To e-mail the reports to a different address, select Recipient > Custom address, and enter the e-mail address where the reports should be sent. Click to list multiple e-mail addresses if needed.

10. Click .