> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeycomb.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Elasticsearch

<Badge className="hny-badge-enterprise-addon" stroke>Ent+</Badge>

<Note>
  This feature is available as an add-on for the [Honeycomb Enterprise plan](https://www.honeycomb.io/pricing/).
  Please contact your Honeycomb account team for details.
</Note>

## 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](https://www.elastic.co/guide/en/elasticsearch/reference/current/authorization.html) for more information on authorization and [Security privileges](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-privileges.html).

## 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'. |