Monitor infrastructure

Grafana integrations

Integrations reference

ElasticSearch

Grafana Cloud

ElasticSearch integration for Grafana Cloud

Elasticsearch is a search engine based on the Lucene library. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.

This integration enables the agent to send metrics to Grafana Cloud along with a useful pre-built dashboard for visualization.

This integration includes 1 pre-built dashboard to help monitor and visualize ElasticSearch metrics.

Before you begin

This integration relies on a dedicated Elastic Search cluster running alongside Grafana Alloy. See the following sections for details.

We strongly recommend that you configure a separate user for the Agent, and give it only the strictly mandatory security privileges necessary for monitoring your node, as per the official documentation.

Install ElasticSearch integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find ElasticSearch and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send ElasticSearch metrics to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your ElasticSearch setup.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a single ElasticSearch instance running locally with default ports.

First, manually copy and append the following snippets into your alloy configuration file.

Integrations snippets

prometheus.exporter.elasticsearch "integrations_elasticsearch_exporter" { }

discovery.relabel "integrations_elasticsearch_exporter" {
	targets = prometheus.exporter.elasticsearch.integrations_elasticsearch_exporter.targets

	rule {
		target_label = "job"
		replacement  = "integrations/elasticsearch_exporter"
	}

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "integrations_elasticsearch_exporter" {
	targets    = discovery.relabel.integrations_elasticsearch_exporter.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/elasticsearch_exporter"
}

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your ElasticSearch instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced integrations snippets

prometheus.exporter.elasticsearch "integrations_elasticsearch_exporter" { }

discovery.relabel "integrations_elasticsearch_exporter" {
	targets = prometheus.exporter.elasticsearch.integrations_elasticsearch_exporter.targets

	rule {
		target_label = "job"
		replacement  = "integrations/elasticsearch_exporter"
	}

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "integrations_elasticsearch_exporter" {
	targets    = discovery.relabel.integrations_elasticsearch_exporter.output
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/elasticsearch_exporter"
}

This integrations uses the prometheus.exporter.elasticsearch component to generate metrics from a ElasticSearch instance.

Set the address argument to the address of your ElasticSearch instance.

For the full array of configuration options, refer to the prometheus.exporter.elasticsearch component reference documentation.

This exporter must be linked with a discovery.relabel component to apply the necessary relabelings.

For each ElasticSearch instance to be monitored you must create a pair of these components.

Configure the following properties within each discovery.relabel component:

instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this ElasticSearch instance.

You can then scrape them by including each discovery.relabel under targets within the prometheus.scrape component.

Grafana Agent static configuration (deprecated)

The following section shows configuration for running Grafana Agent in static mode which is deprecated. You should use Grafana Alloy for all new deployments.

Before you begin

This integration relies on a dedicated Elastic Search cluster running alongside Grafana Agent. See the following sections for details.

Install ElasticSearch integration for Grafana Cloud

In your Grafana Cloud stack, click Connections in the left-hand menu.
Find ElasticSearch and click its tile to open the integration.
Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send ElasticSearch metrics to your Grafana Cloud instance.
Click Install to add this integration’s pre-built dashboard to your Grafana Cloud instance, and you can start monitoring your ElasticSearch setup.

Post-install configuration for the ElasticSearch integration

This integration is configured to work with the Elasticsearch exporter, which is embedded in Grafana Agent.

Enable the integration by adding the provided snippet to your agent configuration file.

Make sure to change the address key to point to the Elasticsearch node appropriate to your environment.

Some exporter metrics are disabled by default. For a full description of configuration options see how to configure the elasticsearch_exporter_config block in the agent documentation.

Configuration snippets for Grafana Agent

Below integrations, insert the following lines and change the URLs according to your environment:

  elasticsearch_exporter:
    enabled: true
    address: http://localhost:9200
    instance: '<your-instance-name>'
    relabel_configs:
    - action: replace
      replacement: integrations/elasticsearch_exporter
      target_label: job

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the ElasticSearch integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
  elasticsearch_exporter:
    enabled: true
    address: http://localhost:9200
    instance: '<your-instance-name>'
    relabel_configs:
    - action: replace
      replacement: integrations/elasticsearch_exporter
      target_label: job
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal

Dashboards

The ElasticSearch integration installs the following dashboards in your Grafana Cloud instance to help monitor your system.

ElasticSearch Overview

Metrics

The most important metrics provided by the ElasticSearch integration, which are used on the pre-built dashboard, are as follows:

elasticsearch_breakers_estimated_size_bytes
elasticsearch_breakers_limit_size_bytes
elasticsearch_breakers_tripped
elasticsearch_cluster_health_active_primary_shards
elasticsearch_cluster_health_active_shards
elasticsearch_cluster_health_delayed_unassigned_shards
elasticsearch_cluster_health_initializing_shards
elasticsearch_cluster_health_number_of_data_nodes
elasticsearch_cluster_health_number_of_nodes
elasticsearch_cluster_health_number_of_pending_tasks
elasticsearch_cluster_health_relocating_shards
elasticsearch_cluster_health_status
elasticsearch_cluster_health_unassigned_shards
elasticsearch_filesystem_data_available_bytes
elasticsearch_filesystem_data_size_bytes
elasticsearch_indices_docs
elasticsearch_indices_docs_deleted
elasticsearch_indices_docs_primary
elasticsearch_indices_fielddata_evictions
elasticsearch_indices_fielddata_memory_size_bytes
elasticsearch_indices_filter_cache_evictions
elasticsearch_indices_flush_time_seconds
elasticsearch_indices_flush_total
elasticsearch_indices_get_exists_time_seconds
elasticsearch_indices_get_exists_total
elasticsearch_indices_get_missing_time_seconds
elasticsearch_indices_get_missing_total
elasticsearch_indices_get_time_seconds
elasticsearch_indices_get_tota
elasticsearch_indices_indexing_delete_time_seconds_total
elasticsearch_indices_indexing_delete_total
elasticsearch_indices_indexing_index_time_seconds_total
elasticsearch_indices_indexing_index_total
elasticsearch_indices_merges_docs_total
elasticsearch_indices_merges_total
elasticsearch_indices_merges_total_size_bytes_total
elasticsearch_indices_merges_total_time_seconds_total
elasticsearch_indices_query_cache_evictions
elasticsearch_indices_query_cache_memory_size_bytes
elasticsearch_indices_refresh_time_seconds_total
elasticsearch_indices_refresh_total
elasticsearch_indices_search_fetch_time_seconds
elasticsearch_indices_search_fetch_total
elasticsearch_indices_search_query_time_seconds
elasticsearch_indices_search_query_total
elasticsearch_indices_segment_doc_values_memory_bytes_primary
elasticsearch_indices_segment_doc_values_memory_bytes_total
elasticsearch_indices_segment_fields_memory_bytes_primary
elasticsearch_indices_segment_fields_memory_bytes_total
elasticsearch_indices_segments_count
elasticsearch_indices_segments_memory_bytes
elasticsearch_indices_store_size_bytes_primary
elasticsearch_indices_store_size_bytes_total
elasticsearch_indices_store_throttle_time_seconds_total
elasticsearch_indices_translog_operations
elasticsearch_indices_translog_size_in_bytes
elasticsearch_jvm_gc_collection_seconds_count
elasticsearch_jvm_gc_collection_seconds_sum
elasticsearch_jvm_memory_committed_bytes
elasticsearch_jvm_memory_max_bytes
elasticsearch_jvm_memory_pool_peak_used_bytes
elasticsearch_jvm_memory_used_bytes
elasticsearch_os_load1
elasticsearch_os_load15
elasticsearch_os_load5
elasticsearch_process_cpu_percent
elasticsearch_process_open_files_count
elasticsearch_thread_pool_active_count
elasticsearch_thread_pool_completed_count
elasticsearch_thread_pool_rejected_count
elasticsearch_transport_rx_size_bytes_total
elasticsearch_transport_tx_size_bytes_total
up

Changelog

# 1.0.0 - February 2024

* Update mixin to replace all Angular panels with React based panels.

# 0.0.3 - August 2023

* New Filter Metrics option for configuring the Grafana Agent, which saves on metrics cost by dropping any metric not used by this integration. Beware that anything custom built using metrics that are not on the snippet will stop working.
* New hostname relabel option, which applies the instance name you write on the text box to the Grafana Agent configuration snippets, making it easier and less error prone to configure this mandatory label.

# 0.0.2 - September 2022

* Update mixin to latest version:
  - Update the datasource template variable label to 'Data Source'

# 0.0.1 - February 2021

* Initial release

Cost

By connecting your ElasticSearch instance to Grafana Cloud, you might incur charges. To view information on the number of active series that your Grafana Cloud account uses for metrics included in each Cloud tier, see Active series and dpm usage and Cloud tier pricing.