Understanding Monitoring of Search Framework and Elasticsearch

Beginning with PeopleTools 8.57, PeopleSoft Search Framework uses Kibana, an open source analytics and visualizations platform, to monitor and provide analysis on Search Framework and Elasticsearch. In PeopleTools 8.57, Search Framework uses Elasticsearch 6.1.2 and Kibana 6.1.2.

Kibana is a Web application and works with Elasticsearch. Kibana provides visual reports in the form of charts, tables, etc. based on queries that you set up on Elasticsearch indexes.

In the PeopleSoft implementation, Search Framework uses Kibana to provide data on system metrics and indexing metrics. 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 Kibana with respect to its implementation in PeopleSoft Search Framework. Therefore, some of the capabilities of Kibana may not be described in this topic. If you need more information on any of the capabilities of Kibana, you should refer to the Kibana User Guide [6.1], which is available on www.elastic.co.

Kibana uses the following terminology:

Kibana Terminology



A collection of visualizations. You can arrange the visualizations within a dashboard and share a dashboard.


A visualization is based on Elasticsearch queries on the Elasticsearch data. A visualization is in the form of charts, maps, tables, etc.

Index pattern

“It tells Kibana which Elasticsearch indices you want to explore. An index pattern can match the name of a single index, or include a wildcard (*) to match multiple indices.”

Kibana User Guide [6.1], Getting Started, Defining Your Index Patterns.


An attribute in PeopleSoft Search Framework corresponds to a search field in Elasticsearch and Kibana.