Understanding Monitoring of Search Framework and OpenSearch
Beginning with PeopleTools 8.60.07, PeopleSoft Search Framework uses OpenSearch Dashboards, an open-source analytics and visualizations platform, to monitor and provide analysis on Search Framework and OpenSearch. Search Framework uses OpenSearch 2.3.0 and OpenSearch Dashboards 2.3.0 and enables application developers to monitor the PeopleSoft application data through the application indexes in OpenSearch.
OpenSearch Dashboards is a Web application and provides visual reports in the form of charts, tables, etc. based on queries that you set up on OpenSearch indexes.
In the PeopleSoft implementation, Search Framework uses OpenSearch Dashboards to provide data on system metrics and indexing metrics and PeopleSoft application data. It provides real-time data as well as historical data. In the context of search functionality, users need real-time data to understand how their system is performing and to track errors, if any, in indexing. Historical data provides an insight into the performance of the system over a period of time and in the context of indexing proves to be an useful tool to analyze indexing statistics.
This topic aims to provide you instructions and information on using OpenSearch Dashboards only with respect to its implementation in PeopleSoft Search Framework. Therefore, some of the capabilities of OpenSearch Dashboards may not be described in this topic. If you need more information on any of the capabilities of OpenSearch Dashboards, you should refer to the OpenSearch Dashboards documentation [2.3.0], which is available on www.opensearch.org.
OpenSearch Dashboards uses the following terminology:
|
OpenSearch Dashboards Terminology |
Description |
|---|---|
|
Dashboard |
A collection of visualizations. You can arrange the visualizations within a dashboard and share a dashboard. |
|
Visualization |
A visualization is based on search-engine queries on the indexed data. A visualization is in the form of charts, maps, tables, etc. |
|
Index pattern |
Index pattern tells OpenSearch Dashboards which search-engine indexes you want to explore. An index pattern can match the name of a single index, or include a wildcard (*) to match multiple indices. Refer to the OpenSearch Dashboards documentation [2.3.0], Managing Indexes, Index State Management. |
|
Attribute |
An attribute in PeopleSoft Search Framework corresponds to a search field in OpenSearch and OpenSearch Dashboards. |
A dashboard is a collection of visualizations and searches. A visualization is based on search-engine queries on the indexed data. These visualizations are in the forms of charts, maps, tables, etc. PeopleSoft Search Framework delivers three system-monitoring dashboards, and each of the dashboards display two or more visualizations. For a list of delivered dashboards and visualizations, see Delivered Dashboards and Visualizations.
Search Framework enables you to create your own visualizations for PeopleSoft application data. Search Framework does not deliver any dashboard or visualization on application data, but in future PeopleSoft applications will implement some. Based on your business requirements, you may build your own dashboards and create visualizations. Typically, an application developer creates the dashboards and visualizations in OpenSearch Dashboards and imports them into PeopleSoft. These dashboards can be configured as a tile or as related information in a PeopleSoft application component. An end-user needs to add this tile to a home page. A dashboard configured as related information appears based on the users access to the component.
For instructions on creating visualizations, refer to Creating a Visualization for Application Data.
This topic discusses some of the common elements on the visualization. For more information on the other elements on the OpenSearch Dashboards visualizations, refer to the OpenSearch Dashboards documentation [2.3.0], which is available on www.opensearch.org.
This example illustrates the common elements on Visualizations. You can find definitions for these common elements later on this page.
Term |
Definition |
|---|---|
Applied Filter |
Use the filter option to filter data on the visualization. |
Time Picker |
Use the Time Picker area to restrict the search results to a specific time period. The time picker enables you to set the filter to view real time data and historical data. |
Fullscreen/Minimize Option |
Use the Fullscreen/Minimize Option button to enlarge the selected visualization. |
Legend |
OpenSearch Dashboards randomly uses different colors in a legend. You can collapse the legend if you want more real estate on the selected visualization. |
Details on mouse over |
Hover the mouse over a chart to view details. |