Elasticsearch
Supported Platforms
| Platform | Metrics | Logs | Traces |
|---|---|---|---|
| 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
| Parameter | Type | Default | Description |
|---|---|---|---|
| telemetry_types | telemetrySelector | ["Logs", "Metrics"] | Choose Telemetry Type. |
| hostname* | string | "localhost" | The hostname or IP address of the Elasticsearch API. |
| port | int | 9200 | The TCP port of the Elasticsearch API. |
| username | string | Username used to authenticate. | |
| password | string | Password used to authenticate. | |
| collection_interval | int | 60 | Sets how often (seconds) to scrape for metrics. |
| nodes | strings | _node | Filters that define which nodes are scraped for node-level metrics. It should be set to '_node' if the collector is installed on all nodes. '_all' if a single collector is scraping the entire cluster. https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cluster.html#cluster-nodes. |
| skip_cluster_metrics | bool | false | Enable to disable the collection of cluster-level metrics. |
| json_log_paths | strings | - \"/var/log/elasticsearch/__server.json\" \n- \"/var/log/elasticsearch/__deprecation.json\" \n- \"/var/log/elasticsearch/__index_search_slowlog.json\" \n- \"/var/log/elasticsearch/__index_indexing_slowlog.json\" \n- \"/var/log/elasticsearch/*_audit.json\" | File paths for the JSON formatted logs. |
| gc_log_paths | strings | - \"/var/log/elasticsearch/gc.log*\" | File paths for the garbage collection logs. |
| start_at | enum | end | Start reading the file from the 'beginning' or 'end'. |