Installing Logstash

Oracle supports the installation of Logstash on Windows and Linux platforms.

To install Logstash, you use the delivered OSK DPK. For instructions on installing Logstash, refer to the PeopleSoft Deployment Packages Installation for Search Components (PeopleSoft PeopleTools 8.60).

Oracle recommends that you should install Logstash on a different system than the systems on which PeopleSoft or OpenSearch or OpenSearch Dashboards is installed.

As a pre-requisite for PeopleSoft Health Center to work correctly, you must complete the installation of PeopleSoft, OpenSearch, OpenSearch Dashboards, and Logstash. You must also ensure that the PIA instance is up and running so that the Integration Broker REST service is available, which is required for the installation and configuration of Logstash.

After installing Logstash, you may need to complete the following tasks or verify that the correct values are inserted:

  • Create JSON files.

  • Review configuration files.

  • Secure psvault file.

Creating JSON Files

When you install Logstash using DPK, the installation program creates JSON files, which are needed for collecting metrics. The JSON files are stored in the jmxmonitor folder at this location: <LOGSTASH_HOME>\pt\jmxmonitor.

Verify that the JSON files are created by navigating to the jmxmonitor folder. For each application, the installation program creates JSON files for application server, Web server, and Process Scheduler. The file names follow this naming convention: <domain_name>_<SysID>_ApplicationName>_<AgentID>.json, for example, App_1_T58P999R_58.json.

If the installation program does not create the needed JSON files, you should navigate to <LOGSTASH_HOME>\bin\ and run the CreateJSON.bat to create JSON files manually.

Note:

Before running CreateJSON bat (Windows) or CreateJSON.sh (Linux), ensure that the environment variable LOGSTASH_HOME is set to the correct path. The PATH environment variable should point to the correct JRE bin location.

Reviewing Configuration Files

When you install Logstash using DPK, the installation program creates two configuration files, namely JsonLogstash.properties and LogstashPipeLine.CONF, in the config folder: <LOGSTASH_HOME>\pt\config.

These configuration files contain the values that you provided during the installation of Logstash, so you may want to review the values.

Securing psvault

During the installation of Logstash using the DPK, the psvault file is placed in the properties folder: <LOGSTASH_HOME>\pt\properties.

Note:

The psvault file in Logstash is not related to the psvault in PeopleTools. Therefore, any change to psvault in the Logstash machine does not affect the psvault in the PeopleTools machine. The psvault keys in Logstash and PeopleTools are different.

You can choose to generate a new key if needed.

To build a new key, navigate to <LOGSTASH_HOME>\pt\bin\ and execute the following command: or for Windows and Linux respectively.

  • PSLSCipher.bat -buildkey (for Windows platform).

  • PSLSCipher.sh -buildkey (for Linux platform).

When a new key is generated and updated in the psvault file, which is placed in the Logstash installation, the following values should be regenerated using the PSLSCipher utility that is available (as .bat for Windows and .sh for Linux) in <LOGSTASH_HOME>\pt\bin:

  • IB user name in <LOGSTASH_HOME>\pt\config\JsonLogstash.properties.

  • IB password in <LOGSTASH_HOME>\pt\config\JsonLogstash.properties.

  • OpenSearch password in <LOGSTASH_HOME>\pt\config\LogstashPipeLine.CONF.

To encrypt a password, navigate to <LOGSTASH_HOME>\pt\bin\ and execute PSLSCipher.bat <password> or PSLSCipher.sh <password>.

Important:

You must protect access to the psvault file, so exercise caution when you set access permissions to it.