NOTE: Creating report subchapters from search queries is currently an experimental feature of One Identity Safeguard for Privileged Sessions (SPS), therefore One Identity recommends that only administrators use this feature and only at their own risk.
You can turn any search query or statistics into a subchapter to add to your reports. This is an easy and flexible way of creating reports to monitor traffic, track certain parameters, or get alerted about particular events.
To create a search-based report subchapter from search results
-
Navigate to Search, and perform a query of your choice.
-
Click Search. Search results are displayed.
- Click
Create report. The Create new subchapter page is displayed, with the Query field populated with your query. If the Query field is not populated, enter a valid search query.
Figure 298: Search > Create report - Example subchapter created from search results with Query field populated
-
In the Name field, add a name to your report.
- In Subchapter type, select the type that fits your query. You can choose from the following types:
- Sessions list: Displays a list of sessions.
Set the number of sessions to show in the report as required.
- Timeline: Visualizes the distribution of sessions within a day/week/month, depending on the time range chosen for the report under Reporting > Configuration > Generate this report every > Day/Week/Month.
- Statistics: Visualizes the distribution of sessions based on the selected metadata.
Select a Statistic presentation for your report, such as List, Pie chart, or Bar chart. Select the field (the metadata) to create your statistics on.
-
To add the subchapter to an existing report, click Add to a report and select from the list of available reports.
Alternatively, to configure a custom report from scratch, click Include in a new report. For more information, see Configuring custom reports.
NOTE: Creating report subchapters from search queries is currently an experimental feature of One Identity Safeguard for Privileged Sessions (SPS), therefore One Identity recommends that only administrators use this feature and only at their own risk.
The following describes how to create a search-based report subchapter from scratch.
To create a search-based report subchapter from scratch
-
If you have multiple SPS appliances and they are organized into a cluster where one of the nodes is the Search Master (or Central Search) node, log in to that node.
- Navigate to Reporting > View & edit subchapters > Search-based.
- Click Create new. The Create new subchapter page is displayed.
Figure 299: Reporting > View & edit subchapters > Search-based — Create new subchapter
- In the Name field, add a name to your report.
- In the Query field, type the query that you want to create a report from.
- In Subchapter type, select the type that fits your query. You can choose from the following types:
- Sessions list: Displays a list of sessions.
Set the number of sessions to show in the report as required.
- Timeline: Visualizes the distribution of sessions within a day/week/month, depending on the time range chosen for the report under Reporting > Configuration > Generate this report every > Day/Week/Month.
- Statistics: Visualizes the distribution of sessions based on the selected metadata.
Select a Statistic presentation for your report, such as List, Pie chart, or Bar chart. Select the field (the metadata) to create your statistics on.
- Click Save.
- Click
. Alternatively, navigate to Reporting > Create & Manage Reports.
- Configure a custom report from scratch, or add the subchapter to an existing report. For more information, see Configuring custom reports.
When adding the subchapter you created, look for it under Reporting > View & edit subchapters > Search-based.
Between versions 5 LTS (5.0) and 6.0 of One Identity Safeguard for Privileged Sessions (SPS), we have completely redesigned the Search page, and improved it with several new features. This section highlights the most important changes, and helps you find how to do the common search tasks on the new page. For the detailed documentation of the new Search page, see Using the Search interface.
Table view, card view
In addition to listing sessions and search results as a table, the new card view highlights the most important details of a session at a glance.
Figure 300: Search interface improvements
Note that in table view now the list of displayed columns is fixed and cannot be modified. However, if you search for specific values of fields that are not displayed, the values of these fields will be visible in card view.
Quick session analytics with the flow view
Display an interactive, visual overview of your search results to quickly visualize their distribution along multiple attributes, such as client and target IP addresses, protocol, or usernames. Helps to identify patterns in user behavior and to drill down fast to the most relevant sessions. For details, see Using the Search interface.
Figure 301: Search — Flow view
Timeline
The Search interface can now display a timeline showing the search results. Also, you can quickly sort and visualize the distribution of the sessions based on their various metadata, for example, username, server address, and so on.
Figure 302: Search — Displaying statistics and timeline
Set a custom or preset date range
Specify a time range to restrict or filter your search criteria by setting boundaries on your searches. Use one of the preset time ranges, or use a custom time range for a more specific search.
Figure 303: Search — Pick a date
Unified search field
Find everything from a single search box, filter search to a specific field, and combine searches in multiple fields using logical operators. You can also combine content search queries arbitrarily with other search queries. Flow view and quick statistics charts can handle content searches as well. For details, see Using search queries.
Figure 304: Search — Search filters
Further functions of the old search page (and where they are located on the new search page)
Some functions of the old search page are located somewhere else on the new page. Here is a list of the important ones.
Download the audit trail of a session: Click details or ... to open the details of the session, then click download trail. For details, see Viewing session details.
Display the timeline: Click the 
icon. To limit the date range of the search, click Pick a date or Shortcuts. For details, see Specifying time ranges.
Change the time interval of the search: To limit the date range of the search, click Pick a date or Shortcuts. For details, see Specifying time ranges. Alternatively, you can select a period on the timeline: click at the beginning of the interval, keep the button pressed, then move the pointer to the end of the interval. The timeline and the search results will be updated automatically.
Search in the screen content: To search in the content of the audited sessions, use the screen.content field in your search query. For example: screen.content="exit". To search in the contents of a specific session, download the audit trail, open it in the Safeguard Desktop Player application, and use the Search feature of the Safeguard Desktop Player. For details, see Searching in the contents of audit trails.
Search or filter in a specific field: To search in a specific data field, start typing the name of the field into the search field. The possible field names and their description is automatically displayed. For example, to search for a specific username, use the user.name:"my-username" search query. For details, see Viewing session details.
Alternatively, click 
and set the filters you need from the appropriate columns. For example, to search for a specific username, select it using the drop-down menu of the Username column. For a more generic search, you can enter any text in the Contains text column.
Figure 305: Search — Search filters - Basic view
Save a filter or a search query: SPS does not store filters anymore, but you can bookmark the page.
The central search functionality is available when your deployment consists of two or more instances of One Identity Safeguard for Privileged Sessions (SPS) organized into a cluster. When you have a cluster of nodes set up, you have the possibility to search all session data recorded by all nodes in the cluster on a single node. This is achieved by assigning roles to the individual nodes in your cluster: you can set up one of your Safeguard for Privileged Sessions nodes to be the Search Master and the rest of the nodes to be Search Minions. Search Minions send session data that they record to the Search Master, and the Search Master acts as a central search node.
To set up your environment for central searching, complete the following steps:
- Enable cluster management on the nodes that you want to be part of your cluster.
- Build a cluster.
-
Assign roles to nodes in your cluster.
Familiarize yourself with:
Once you have your cluster set up and the appropriate roles assigned, you can start searching session data using the Search interface.
NOTE: Central search is not available on the Search (classic) interface.
Limitations of the central search functionality
Currently, the central search functionality comes with the following limitations:
-
Session data recorded by a node before it was joined to the cluster will not be searchable centrally. Only session data recorded after the node has been joined to the cluster is available for central search.
-
You cannot to run the indexer process on unindexed sessions after assigning the Search Master role to a node. Make sure all important sessions are indexed before assigning the Search Master role to the node.
-
The Search Master node cannot run internal indexer processes, nor does it receive connections from external indexers. Indexers work only with Search Minion nodes.
-
It is not possible to replay audit trail files in your browser from the Search Master node.
-
When near real-time indexing is configured on a Search Minion node, while session data from active connections is visible on the Search interface of the Search Master node, it is not possible to:
-
export the audit trail of an active connection,
-
follow an active connection, and
-
terminate an active connection.
Note, however, that you can terminate the active, ongoing connection on the Search Minion node that is recording the connection in question.
-
A reliable, high-bandwidth connection is required between the nodes. Small loss of connection is handled well but if the connection between the Search Minions and the Search Master is lost for a longer period of time, the Search Minions will stop accepting new connections until the connection is repaired. Data is automatically pushed to the Search Master after the connection is restored.
NOTE: Search Minion nodes do not send the files storing the audit trails to the Search Master node. When a user clicks 
, the Search Master node streams the trail files to the user from the original Search Minion node that recorded the sessions. If a Search Minion node does not have a backup policy set up and an error occurs that causes data loss, then session data recorded by that node will not be available.
