Logstash¶
Logstash on NetEye ships with an Elastic Stack template, which allows to manage its configuration within the NetEye environment.
Furthermore, please note how all pipelines configuration files, located in the /neteye/shared/logstash/conf/conf.*.d
folders, are set as config files, which prevents them from being silently overwritten
by future updates. As mentioned also in the .rpmsave and .rpmnew migration guide,
config files will instead lead to an rpmnew file if they were modified both on the system
and by the update, enabling so the user to control their migration.
Logstash Index Template¶
NetEye configures an index template logs-logstash dedicated to Logstash logs. Any log coming from the Logstash main pipeline, that will mainly manage rsyslog logs and user-customized input sources, will match the logs-logstash-* index template, which will create the dedicated data stream.
In order to modify the retention policy applied to such logs, you can set the desired retention period in the data stream control panel, by selecting
.Autoexpand Replicas¶
Configuration of Logstash replica that applies to both single instances and clusters is done by means of the “neteye-autoexpand-replicas” component template applied to the Logstash index template logs-logstash. The new indices matching the pattern logs-logstash-* will automatically configure the replica with the range 0-1 using the index.auto_expand_replicas setting.
Plugins¶
Logstash provides a variety of plugins, i.e. input, filter, codec, and output plugins, which serve to enhance its functionality in a custom manner.
Some plugins are shipped with Logstash by default, however, there is a possibility to add plugins on top of the ones that are available in your deployment.
All the plugins supported at various levels can be found in the Elastic Support Matrix.
You can list the plugins currently available in your deployment by running the following subcommand:
/usr/share/logstash/bin/logstash-plugin list
Check out the official Logstash guide for instructions on how to install and remove additional plugins.
On top of that, you can check the plugins that were installed additionally by running
python3 /usr/share/neteye/logstash/scripts/configurator/logstash_plugin_manager.py additional-plugins-installed
Check out more listing options in the Logstash official documentation.
Plugins have their own release cycles and are often released independently of Logstash’s core release cycle. With every NetEye update, Logstash is being updated together with the plugins available in your deployment.
For the plugins that were installed additionally, on top of the ones that were shipped with Logstash by default, you can use the update subcommand to get the latest version of the plugin:
/usr/share/logstash/bin/logstash-plugin update [PLUGIN]
Warning
It is not recommended to update or remove the plugins shipped by default manually, since every neteye update / neteye upgrade will overwrite those changes and reinstall or update the plugins to the latest version available. In some cases it may also lead to Logstash not operating properly.
More information about Logstash plugins can be found in Logstash official documentation.