Elasticsearch monitoring is a Gateway configuration file that enables monitoring of Elasticsearch Cluster through the Toolkit plug-in.
Elasticsearch is a distributed, search and analytics engine that is capable of scaling horizontally, allowing to add more nodes to the cluster. This means that it can search and analyze large scale of data.
The elements that make Elasticsearch work are defined as follows:
- Node is a running instance of Elasticsearch that is capable of knowing the location of the document.
- Cluster consists of one or more nodes with the same cluster name that can share their data and load.
Track the following key areas when using Elasticsearch monitoring:
|Search performance||Determine how the search function perform over time by monitoring the query operations, load or latency, field data cache and evictions.|
|Indexing performance||Each shard in the index can be updated through flush and refresh process.
Shard is a container for data that can be either a primary or a replica shard. It is how the Elasticsearch distributes data in the clusters.
|Cluster health and node availability||Monitors the current state of all clusters and nodes.|
|Resource utilisation||Provides information on how the thread pool queues and rejection works in monitoring the bulk, index, merge, and operations.|
|System and network metrics||Shows information about every node in the cluster, resource and memory usage, and active connections opened over time.|
In this Elasticsearch monitoring template, you will see these metrics in your dataview:
- Cluster health
- Indexing performance
- Search performance
- Node and resource information
- Thread pool
This guide discusses the steps to set up the Elasticsearch integration on a Gateway. Once the integration is set up, the samplers providing the dataviews become available to that Gateway.
To view the sample metrics and dataviews, see Elasticsearch Monitoring Technical Reference.
This monitoring template is a Gateway configuration setup that can be included in the Gateway Setup Editor.
To use this template, your configuration must meet the following requirements:
- A machine running the Netprobe must have access to the HTTP address and port published by the Elasticsearch.
- An Active Console that is connected to the Gateway.
- Elasticsearch configuration files extracted to their Gateway set-up.
The following requirements must be met prior to the installation and setup of the template:
- Template package: geneos-integration-elasticsearch-<version>.zip.
- Managed entities utilising the samplers defined in the
- Python 2.7 or 3.6 installation on the machine where the Netprobe resides.
For more information on supported versions, see Application and plug-in specific information in Geneos 5.x Compatibility Matrix.
Note: This template is verified to be working with Elasticsearch version 6.1.2.
This document is a reference guide to introduce templates and scripts built using the Geneos development toolkit plug-ins.
The template allows you to integrate specific applications and services to collect metrics without having to create a new plug-in.
Ensure that you have read and can follow the system requirements prior to installation and setup of this integration template.
- Download the config file (geneos-integration-elasticsearch-<version>.zip) from the ITRS Downloads site.
- Open Gateway Setup Editor.
- In the Navigation panel, click Includes to create a new file.
- Enter the location of the file to include in the Location field. In this example, it is the
- Update the Priority field. This can be any value except
1. If you input a priority of
1, the Gateway Setup Editor returns an error.
- Expand the file location in the Include section.
- Select Click to load.
- Click Yes to load the new Elasticsearch include file.
- Click Managed entities in the Navigation panel.
- Add the Elasticsearch type to the Managed Entity section that you will use to monitor Elasticsearch.
- Click Validate current document to check your configuration.
- Click Save current document to apply the changes.
These are the pre-configured samplers available to use in
Configure the required fields by referring to the table below:
include/ElasticsearchMonitoring.xml template provides the following variables that are set in the Environments section:
|ELASTICSEARCHMON_GROUP||Sampler group name.
|ELASTICSEARCHMON_HOST||IP/Hostname of the Elasticsearch Node.
|ELASTICSEARCHMON_PORT||Port assigned to the Elasticsearch HTTP service .
|ELASTICSEARCHMON_PYTHON_EXE||Name of the executable script that calls the python code.|
ElasticsearchMonitoring-SampleRules.xml template also provides a separate sample rules that you can use to configure the Gateway Setup Editor.
Your configuration rules must be set in the Includes section. In the Navigation panel, click Rules.
The table below shows the included rule setup in the configuration file: