Files
Olares/docs/developer/develop/mw-view-es-data.md
Meow33 839133fc27 docs: add middleware data access and integration guides (#2444)
* docs: add guides to view middleware data

* docs: add guide for grafana

* docs: add guide for otel and integration guides for other middleware

* docs: add guide for elasticsearch

* docs: update based on suggestions

* Update zh.ts

* docs: update content

* docs: resolve conflict
2026-02-05 23:34:59 +08:00

69 lines
2.7 KiB
Markdown

---
outline: [2, 3]
description: Learn how to connect to and manage Elasticsearch data in Olares using Bytebase.
---
# View Elasticsearch data
To use Elasticsearch in Olares, install it from Market first. This guide explains how to access and manage Elasticsearch data using Bytebase.
## Install Elasticsearch service
Before connecting, install the Elasticsearch service from Market.
1. Open Market from Launchpad and search for "Elasticsearch".
2. Click **Get**, then **Install**, and wait for the installation to complete.
Once installed, the service and its connection details will appear in the Middleware list in Control Hub.
## Get connection information
Before connecting, obtain Elasticsearch connection details from Control Hub.
1. Open Control Hub from Launchpad.
2. In the left navigation pane, go to Middleware and select **Elasticsearch**.
3. On the Details panel, record the following information:
- **Host**: Used for Bytebase connection.
- **User**: Used for Bytebase connection.
- **Password**: Used for Bytebase connection.
![Elasticsearch details](/images/developer/develop/middleware/mw-es-details.png#bordered){width=60% style="margin-left:0"}
## Manage via Bytebase
Bytebase provides a graphical interface for database management and schema changes.
### Prerequisites
:::info MongoDB app required
Bytebase uses MongoDB to store its metadata. Install MongoDB before installing Bytebase.
:::
1. Open Market and search for "MongoDB".
2. Click **Get**, then **Install**, and wait until the service is running.
3. After MongoDB is installed, search for "Bytebase" in Market.
4. Click **Get**, then **Install**.
### First-time setup
When launching Bytebase for the first time, you must configure an administrator account.
:::tip
Remember these credentials. Only the admin account can create new database instances.
:::
1. Open Bytebase from Launchpad.
2. Follow the on-screen prompts to set up your admin account with email and password.
### Create an Elasticsearch instance
1. Log in to Bytebase with your admin account.
2. In the left navigation pane, select **Instances**, then click **+ Add Instance**.
3. Choose **Elasticsearch** as the database type.
4. Fill in the connection fields using values from Control Hub:
- **Host or Socket**: Enter the **Host** address and do not include the port.
- **Port**: Keep the default, usually `9200`.
- **Username**: Enter the **User** value from Control Hub.
- **Password**: Enter the **Password** value from Control Hub.
5. Click **Test Connection** to verify connectivity, then click **Create**.
Creating an instance in Bytebase does not create a new database. Once the instance is created, you can use the corresponding client tools to inspect and manage data.