Installing Logstash on Linux Interactively

Use this procedure on physical or virtual Linux hosts. This procedure assumes:

You have downloaded the required OSK DPK for Linux, referred to as OSK_FILENAME.zip, and saved it in a newly created directory accessible to the Linux host, referred to as OSK_INSTALL.
You have installed OpenSearch and OpenSearch Dashboards.
You have the values for the ports, passwords, and host names for the OpenSearch installation.
You have fulfilled the Logstash prerequisites.

To install Logstash:

Open a terminal window.
Run the DPK setup script from OSK_INSTALL/setup as follows:
```
./psft-dpk-setup.sh –-install --install_base_dir BASE_DIR
```
- For the install_base_dir option, specify the full path where you want OpenSearch installed. The installation directory is referred to in this documentation as BASE_DIR. For example:
```
./psft-dpk-setup.sh –-install --install_base_dir /home/opensearch
```
- Use double-dashes when specifying the script options; for example, --install.
If you are using the PeopleTools Middleware DPK with the OSK DPK, verify that you see the progress message; for example:
```
Extracting PTMW DPK
[OK]
```

Answer n (no) to skip the OpenSearch installation.

You've chosen to do a fresh installation of Opensearch, Logstash 
and Opensearch-dashboards. 
Do you want to install Opensearch: (y/n): n

Answer y (yes) to install Logstash.

The script displays information about the current server.

Note:

Answer yes to install Logstash for external data integration. For use with PeopleSoft Health Center, answer yes both to this prompt, and to the later prompt asking if you want to configure PeopleSoft Health Center.
```
Do you want to install Logstash : (y/n): y
Logstash will be installed on server1.example.com
```
Enter the HTTP port for Logstash.

The default is 9800.
```
Enter the HTTP port for Logstash [ 9800 ] :
```
Enter the OpenSearch administrative user name that you specified when installing OpenSearch.
```
Enter the Opensearch username: 
```
Enter the password two times for the OpenSearch administrative user..
```
Enter the Opensearch password:
Re-enter the Opensearch password:
```

Review the status messages as the script installs Logstash.

Extracting the Logstash Binary ...........[OK]
Configuring the Logstash .................[OK]

Answer y (yes) to configure the installed Logstash for PeopleSoft Health Center, or n (no) to continue.
```
Do you want to configure PeopleSoft Health Centre: (y/n): y
```
Enter the URL for the Integration Broker REST service.
```
Enter the IB REST service URL: 
```
Enter the Integration Broker user name.

Note:

Be sure to fulfill the prerequisites for the Integration Broker user in the section Preparing for the Logstash Installation.
```
Enter the IB user: 
```

Enter the Integration Broker password twice.

Enter the IB password: 
Re-enter the IB password:

Enter the full path to the location to save the JSON files.

Enter the location where JSON files need to be created 
[/home/opensearch/pt/logstash-9.1.3/pt/jmxmonitor ]:

Enter the polling frequency, in seconds, for the JMX agents.

The polling frequency is mandatory input. There is no recommended or default value.

The value you enter sets the frequency with which the JMX metrics data are fetched from JMX servers. This means that every n seconds, data is pushed to OpenSearch.

It is a good idea to regularly purge the psft_hc_metrics index. The interval you select depends upon your usage. See the information on the Monitoring Server page in the Search Technology product documentation.

See PeopleTools: Search Technology, "Configuring the Monitoring Server."
```
Enter the polling frequency for JMX metrics:
```
Enter the number of threads that will be used to retrieve metrics and create events.

The number you select depends upon your usage. Increase or decrease it as needed.
```
Enter the number of threads:
```
Enter the host name and port that you used to set up the OpenSearch host.
```
Enter the Opensearch host name: 

Enter the Opensearch port: 
```
Enter y (yes) if you want to create JSON files, or n (no) to continue.

If your environment is set up to use SSL, or if you have not completed the necessary prerequisite steps, enter n (no). See the section Preparing for the Logstash Installation for information on creating the JSON files manually.
```
Do you want to create JSON files? (y/n): y
```
Answer y (yes) if you want to fetch alert configurations.

Before the script can fetch the alert configuration, you must have set up PeopleSoft Health Center for alerts. You see this prompt if you answered yes to the prompt to create JSON files and if the JSON files are created successfully.

See PeopleTools: Performance Monitor, "Configuring PeopleSoft Health Center."
```
To fetch the alert configuration, alerts must be configured in 
Peopletools>Health Centre>Alert Configuration. 
Do you want to fetch the alert configuration parameters? (y/n):
```
Enter n (no) to indicate you do not want to configure Logstash for the Process Scheduler metric.

Note:

The PeopleSoft Process Scheduler Metric is currently reserved for internal Oracle use.
```
Do you want to configure for PeopleSoft Process Scheduler Metric: (y/n): n
```

Wait until the installation is complete.

Configuring Logstash...................[OK]
Verifying if Logstash config files are present in place....
Logstash config files are present.

Creating Json files. This may take some time...

Logstash installation completed

Answer n (no) to skip the OpenSearch Dashboards installation and exit.
```
Do you want to install opensearch-dashboards: (y/n): n
```
To use Logstash for PeopleSoft Health Center, see the Performance Monitor product documentation.

Note:

The OSK DPK installation creates JSON files and starts Logstash if the required conditions are met.

See PeopleTools: Performance Monitor, "Configuring PeopleSoft Health Center."
To use OpenSearch, OpenSearch Dashboards, and Logstash for external data integration, see the Search Technology product documentation.

See PeopleTools: Search Technology, "Integrating External Data with PeopleSoft."

A successful deployment includes the following:

The LOGSTASH_HOME environment variable is set to BASE_DIR/pt/logstash-9.1.3 for the current terminal session.
Java is installed to BASE_DIR/pt/os_jdk21.0.yy, where yy is the JDK version.
The JAVA_HOME environment variable is set to BASE_DIR/pt/os_jdk21.0.yy for the current terminal session.

See Performing Post-Installation Steps on Linux.