Creating report subchapters from search queries
|
|
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. The Search interface allows you to:
- Create search-based report subchapters from search results.
- Create search-based report subchapters from scratch.
Creating search-based report subchapters from search results
|
|
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 search results.
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
. The Create reporting subchapter page is displayed, with the query field populated with your query.
- In the name field, add a name to your report.
- In Report 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.
- Statistics: Visualizes the distribution of sessions based on the selected metadata.
Select a Statistic presentation for your report, such as Pie chart, List, Bar chart. Select the field (the metadata) to create your statistics on.
- 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.
- Sessions list: Displays a list of sessions.
- Click Save.
- Click
. Alternatively, navigate to Reporting > Configuration.
- Configure a custom report from scratch, or add the subchapter to an existing report. For details, see Configuring custom reports.
When adding the subchapter you created, look for it under Search-based subchapters.
Creating search-based report subchapters from scratch
|
|
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 > Search subchapters.
- Click
. The Create reporting subchapter page is displayed.
Figure 240: Reporting > Search subchapters — Create reporting 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 Report 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.
- Statistics: Visualizes the distribution of sessions based on the selected metadata.
Select a Statistic presentation for your report, such as Pie chart, List, Bar chart. Select the field (the metadata) to create your statistics on.
- 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.
- Sessions list: Displays a list of sessions.
- Click Save.
- Click
- Configure a custom report from scratch, or add the subchapter to an existing report. For details, see Configuring custom reports.
When adding the subchapter you created, look for it under Search-based subchapters.
Search interface changes between version 5.0 and 6.0
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 241: 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 242: 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 243: 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 244: 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 filters.
Figure 245: 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 
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.
Save a filter or a search query: SPS does not store filters anymore, but you can bookmark the page.