OpenSearch Index Binding¶

Select OpenSearch and fill in the required information. After filling in, you can click Test to verify the correctness of the username and password.

Account Authorization¶

1. Domain: The user access address of OpenSearch, please ensure it is accessible on the public network.
2. Username: The username for accessing OpenSearch.
3. Password: The password required for accessing OpenSearch.

Resource Authorization¶

1. OpenSearch Index: The index name in OpenSearch that needs to be bound for viewing.

2. Guance Index: The unique identifier index name for the Guance workspace, customized by the user, and duplicate names are not supported. Once configured, it can be used to filter index names.

   Note

   This index name is unrelated to OpenSearch and is only used for filtering data in Guance later.

3. Optionally, enter an index description.

Field Mapping¶

Configure Field Mapping.

After configuration, click Confirm to complete the index binding. You can view it in the Explorer by switching the index.

Special Notes¶

Due to the rolling strategy of Elasticsearch/OpenSearch, an index may generate multiple index rules or names. If you need to query all data under the current index or query data corresponding to a specific index under the current index, you can configure it according to the following example.

Index, Alias, and Shards¶

• An index alias is an auxiliary name used to reference one or more existing indexes.
• An alias can be bound to multiple indexes, and an index can also be bound to multiple aliases.

As shown in the figure above, there are 2 shards in index 1. If you need to query the log content in index 1, you only need to bind the index with the index name as index 1, without any awareness of the number and size of shards.

Index Rolling¶

As shown in the figure above, taking ES as an example with a rolling index rule of one per day, Log-1 is the alias for these indexes, and Log-1 - 2022/10/01, etc., are the index names.

• If you need to bind all indexes in Guance, you need to bind this index alias, refer to the following example:

• If you need to bind a specific index in Guance, or there is no rolling strategy in the configuration, you only need to bind the specific index name, refer to the following example: