Elasticsearch

Supported Platforms

PlatformMetricsLogsTraces
Linux
Windows
macOS

Prerequisites

This receiver supports Elasticsearch versions 7.9+

If Elasticsearch security features are enabled, you must have either the monitor or manage cluster privilege. See the Elasticsearch docs for more information on authorization and Security privileges.

Configuration Table

ParameterTypeDefaultDescription
enable_metricsbooltrueEnable to collect metrics.
hostname*string"localhost"The hostname or IP address of the Elasticsearch API.
portint9200The TCP port of the Elasticsearch API.
usernamestringUsername used to authenticate.
passwordstringPassword used to authenticate.
collection_intervalint60How often (seconds) to scrape for metrics.
nodesstrings_nodeFilters that define which nodes are scraped for node-level metrics.
Should be set to '_node' if collector is installed on all nodes.
'_all' if single collector is scraping the entire collector.
https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster.html#cluster-nodes.
skip_cluster_metricsboolfalseEnable to disable the collection of cluster level metrics.
enable_logsbooltrueEnable to collect logs.
json_log_pathsstrings- "/var/log/elasticsearch/*_server.json"
- "/var/log/elasticsearch/*_deprecation.json"
- "/var/log/elasticsearch/*_index_search_slowlog.json"
- "/var/log/elasticsearch/*_index_indexing_slowlog.json"
- "/var/log/elasticsearch/*_audit.json"
File paths for the JSON formatted logs.
gc_log_pathsstrings- "/var/log/elasticsearch/gc.log*"File paths for the garbage collection logs.
start_atenumendStart reading file from 'beginning' or 'end'.

*required field


Did this page help you?