- This plugin collects metrics from the Elasticsearch API. The plugin handles internally calls to the following endpoints:
The oldest supported Elasticsearch version is 2.4 (last released in late 2016).
This plugin is currently available for x86_64 Linux and Windows platforms.
elasticsearch plugin is included with the AppOptics host agent by default, please follow the directions below to enable it for a host agent instance.
This plugin requires that Elasticsearch server is running and its API is available from the host where the plugin runs.
You might want to customize values in the ‘Network’ section in elasticsearch configuration file (typically
... # ---------------------------------- Network ----------------------------------- # # Set the bind address to a specific IP (IPv4 or IPv6): # network.host: 192.168.0.100 # # Set a custom port for HTTP: # http.port: 9200 # # For more information, consult the network module documentation. ...
The host agent provides an example configuration file to help you get started quickly. It defines the plugin and task file to be loaded by the agent, but requires you to provide the correct settings for your Elasticsearch server. o enable the plugin:
1. Make a copy of the elasticsearch example configuration file
renaming it to
$ sudo cp /opt/appoptics/etc/plugins.d/elasticsearch.yaml.example /opt/appoptics/etc/plugins.d/elasticsearch.yaml
/opt/appoptics/etc/plugins.d/elasticsearch.yamlconfiguration file with settings specific to your Elasticsearch server for example:
collector: elasticsearch: all: server: "127.0.0.1" port: 9200 timeout: 5s load: plugin: snap-plugin-collector-aoelasticsearch task: task-aoelasticsearch.yaml
serveris optional and defaults to
localhost, it should be set to the valid Elasticsearch API server IP or FQDN.
portis optional and defaults to
9200, it should match with the port Elasticsearch API is listening on.
timeoutis optional and defaults to
5s, it is a timeout for connecting Elasticsearch API.
- Restart the host agent:
$ sudo service appoptics-snapteld restart
- Enable the Elasticsearch plugin in the AppOptics UI
Select the Elasticsearch plugin to open the configuration menu in the UI, and enable the plugin.
You should soon see the
elasticsearchmetrics reported to your dashboard.