Integrations
Elasticsearch
Connect Castrel to Elasticsearch for log analysis and search.
Overview
- Connector Name:
elasticsearch - Supported API Version: Elasticsearch / OpenSearch REST APIs
- Supported Server Versions: Elasticsearch v7.x (>= v7.10.0) and OpenSearch v2.x (>= v2.0.0)
- Official Documentation: Elasticsearch Guide
Configuration
To use the Elasticsearch tools, you need to configure a Connector with the following fields:
| Field | Required | Description |
|---|---|---|
instance_name | Yes | Instance name to identify this connector instance. |
base_url | Yes | The base URL of your Elasticsearch server (e.g., http://elasticsearch:9200). |
auth_type | Yes | Set to none, basic or api_key. |
username | No | Basic Auth username. |
password | No | Basic Auth password. |
api_key | No | API Key for authentication. |
verify_ssl | No | SSL certificate verification (default: true). |
Available Tools
The connector provides a set of tools for data retrieval and cluster exploration.
- Index Management: List indices and get index mappings.
- Search & Query: Perform standard Elasticsearch searches.
- SQL & PPL: Execute OpenSearch SQL and PPL queries.
- Cluster Info: Get shard information.