Elasticsearch:Install and remove a plug-in

Prerequisites

Before you begin, ensure that you have:

• A Logstash cluster. For setup instructions, see Step 1: Create a Logstash cluster.

Limitations

• logstash-input-file is not supported. To collect data from files on an on-premises machine, use the logstash-input-beats plug-in with Filebeat as the Logstash input. Use a port in the range 8000–9000.

• Installing or removing a plug-in triggers a cluster restart. Schedule plug-in changes during off-peak hours to minimize impact.

• After a plug-in is removed, it no longer appears on the Plug-ins page.

Install or remove a built-in plug-in

1. Log on to the Elasticsearch console.

2. Navigate to the target cluster.

   1. In the top navigation bar, select the region where the cluster resides.

   2. In the left-side navigation pane, click Logstash Clusters. On the Logstash Clusters page, find the cluster and click its ID.

3. In the left-side navigation pane, click Plug-ins.

4. On the Built-in Plug-ins tab, find the plug-in you want to manage, then click Install or Remove in the Actions column.

   Warning

   This action restarts the cluster. Perform it during off-peak hours.

5. Read the confirmation message, then click OK. The cluster restarts. Track progress in the Tasks dialog box. For details, see View the progress of a cluster task. After the restart completes, the plug-in is installed or removed.

API reference

Use the following API operations to manage Logstash plug-ins programmatically:

• ListLogstashPlugins — Get information about all plug-ins or a specific plug-in.

• InstallLogstashSystemPlugin — Install a plug-in.

• UninstallLogstashPlugin — Remove an installed plug-in.