• EnglishEspañol日本語한국어Português
  • Log inStart now

Elasticsearch monitoring integration

Gain deep insights into Elasticsearch performance with seamless data integration into New Relic. Monitor key metrics at the cluster, node, and index level - all within our powerful platform. Create alerts to stay ahead of performance anomalies, build custom dashboards for tailored views, and proactively optimize your Elasticsearch monitoring.

To get the most out of this page, select the installation method that fits your environment. You need a New Relic account before starting the installation process.

Tip

Use guided install to quickly see your data in the UI

The guided install is a single CLI command you can run to monitor your Elasticsearch instance. It's a good option for small organizations, or for anyone who wants to test out New Relic.

Guided install

For a more permanent and scalable solution, we recommend the standard manual install of the agent: keep reading for how to do that.

Elasticsearch-config.yml sample files

Here are some example basic and advanced sample config files:

Elasticsearch config settings

You can use the env section of the elasticsearch-config.yml file, to define specific settings related to Elasticsearch. These settings control the connection to your Elasticsearch instance, as well as other security settings and features.

The Elasticsearch integration collects both Metrics and Inventory information. In the table, use the Applies to column for the settings available to each collection:

Setting

Description

Default

Applies to

HOSTNAME

Hostname or IP where Elasticsearch is running.

localhost

M/I

LOCAL_HOSTNAME

Hostname or IP of the Elasticsearch node from which to collect inventory data. Should only be set if you do not wish to collect inventory data against localhost.

localhost

M

PORT

Port on which Elasticsearch is listening.

9200

M/I

USERNAME

Username for accessing Elasticsearch Node.

N/A

M/I

PASSWORD

Password for the given user.

N/A

M/I

CLUSTER_ENVIRONMENT

A way to further specify which cluster we are gathering data, for example, 'staging'.

N/A

M/I

USE_SSL

Use SSL when communicating with the Elasticsearch node.

false

M/I

CA_BUNDLE_FILE

Location of SSL certificate on the host. Only required if USE_SSL is true.

N/A

M/I

CA_BUNDLE_DIR

Alternative Certificate Authority bundle directory.

N/A

M/I

SSL_ALTERNATIVE_HOSTNAME

Alternative server hostname that the integration will accept as valid for the purposes of SSL negotiation.

N/A

M/I

TLS_INSECURE_SKIP_VERIFY

Skip the verification of the server's certificate chain and hostname.

false

M/I

CONFIG_PATH

Path to the Elasticsearch configuration file.

/etc/elasticsearch/elasticsearch.yml

I

TIMEOUT

Timeout for API requests, in seconds.

30

M/I

COLLECT_INDICES

Signals whether to collect indices metrics or not.

true

M

COLLECT_PRIMARIES

Signals whether to collect primaries metrics or not.

true

M

INDICES_REGEX

Filter which indices are collected.

N/A

M

MASTER_ONLY

Collect cluster metrics on the elected master only.

false

M

METRICS

Set to true to enable metrics-only collection.

false

INVENTORY

Set to true to enable inventory-only collection.

false

Metric data

The Elasticsearch integration collects the following metrics. Each metric name is prefixed with a category indicator and a period, such as cluster. or shards..

Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.