Elasticsearch
Connecting NeuBird to your Elasticsearch instance enables collection of telemetry data related to search queries, index performance, and cluster health. To integrate, you authenticate using an Elasticsearch API key with read-only privileges.
Step 1: Generate an Elasticsearch API Key
Section titled “Step 1: Generate an Elasticsearch API Key”-
Access Elasticsearch Security Settings: Log in to your Elasticsearch instance, navigate to your deployment, and click on Open Kibana.
On Kibana, navigate to the Management section.
-
Navigate to API Keys: Under the Security settings, click on API Keys > Create API key.
-
Create a New API Key:
-
Provide a name for the API key.
-
Select the type of API key and choose read-only as the security privilege level.
-
-
Copy the API Key: Once generated, copy the API key. You will not be able to view it again after navigating away, so store it securely.
Connection Fields
Section titled “Connection Fields”| Field | Required | Description |
|---|---|---|
| Name | Yes | A descriptive name for the connection |
| Description | No | A brief description of this integration |
| API Key | Yes | The read-only API key generated in Step 1 |
| Unique ID Key | No | Organization-specific ID key for tracking and audits |
| Elasticsearch URL | Yes | Your Elasticsearch instance URL (format: https://<your-elasticsearch-domain>/_api/<endpoint>) |
| Cloud ID | No | The Cloud ID if using Elastic Cloud |
For general instructions on creating and managing connections, see the Connections Overview.