PTSFMonitorConfiguration

Application Class: PTEM_CONFIG:PTSFMonitorConfiguration

The PTSFMonitorConfiguration plug-in configures the monitoring server, deploys the PeopleSoft Health Center dashboards, and deploys the system monitoring and search index metrics dashboards to PeopleSoft Insights.

The configuration parameters are similar to the Monitoring Server page in PIA (PeopleTools, and then Search Framework, and then Administration, and then Monitoring Server).

Property Default Value Description

env.monitor_es_host

 

Sets the host name of the monitoring search server.

env.monitor_es_port

 

Sets the port of the search monitoring server.

env.monitor_es_ssl

False

Flag to determine whether the monitoring search server configuration is secure or non secure.

Valid values:

  • False - indicates non-secure (http) configuration.

  • True - indicates secure (https) configuration.

env.monitor_es_user

osadmin

Search engine administrator user name.

env.monitor_es_password

 

Search engine administrator password.

The password should be encrypted.

env.monitor_kibana_host

 

Sets the host name of the monitoring PeopleSoft Insights server.

env.monitor_kibana_port

 

Sets the port of the PeopleSoft Insights server.

env.monitor_kibana_ssl

 

Flag to determine whether the PeopleSoft Insights server configuration is secure or non secure.

env.scan_interval

5

Sets the time interval (in seconds) to retrieve system metrics from search server.

env.purge_retention

1

Sets the number of days to store the system and indexing metrics.

env.enable_index_metrics

No

Flag to determine whether index metrics should be collected or not.

env.enable_system_metrics

No

Flag to determine whether system metrics should be collected or not.

env.dashboard_selection

ALL

Specifies the dashboards to be deployed. The valid values are:

  • ALL

  • LIST

env.dashboard_list

 

Comma separated list of PeopleSoft Health Center dashboards to be deployed to PeopleSoft Insights.