Elasticsearch is a search server based on Lucene, which provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.
The Librato Agent allows you to easily monitor Elasticsearch’s health and performance. We use a custom collectd plugin to gather metrics from your running Elasticsearch instance(s).
Create the Integration¶
The Elasticsearch integration depends on the Librato Agent. If you haven’t already, you will first need to install the Librato Agent. Once this is complete, select the Elasticsearch icon in the integrations catalogue.
Toggle the Enabled switch to activate the Elasticsearch integration on your Librato account and create the preconfigured Elasticsearch spaces.
At this point any Elasticsearch metrics associated with this integration will be allowed through your Librato Agent service-side filters.
Librato Agent provides a default
/opt/collectd/etc/collectd.conf.d/elasticsearch.conf configuration file. Please
review and edit this configuration file to suit your environment.
<Plugin "python"> ModulePath "/opt/collectd/share/collectd/" Import "collectd-elasticsearch" <Module "collectd-elasticsearch"> #Url "http://127.0.0.1:9200" #Name "mycluster" #Verbose true </Module> </Plugin>
The plugin will attempt to connect to Elasticsearch over http://127.0.0.1:9200. If necessary, update
to match the
network.host setting in your Elasticsearch configuration file. By default, the cluster name
will serve as the plugin instance for the reported metrics. Use the
Name configuration parameter to override
Note: You must restart the agent after any changes to your Librato Agent configuration files.
$ sudo service collectd restart
At this point you should begin seeing
librato.elasticsearch.* metrics in your Librato account.
Visit your Elasticsearch preconfigured spaces to observe your new metrics as they stream in. The Elasticsearch Overview dashboard provides a summary view of Elasticsearch health and performance metrics, whereas Elasticsearch Details enables more in-depth diagnostics and troubleshooting.
Use our dynamic source field at the top to filter your view to a specific Elasticsearch
instance or subset of metric sources. For example, to isolate the view to all hosts
which are a part of an Elasticsearch cluster named
prod-1, use a dynamic source value