OpenSearch Index Binding¶
Select OpenSearch, and fill in the required information. After completion, you can click Test to verify the correctness of the username and password.
Note: Only OpenSearch 1.0.x and above versions are supported for binding.
Account Authorization
- Domain Name: The access address for OpenSearch. Ensure it is accessible over the public network.
- Username: The username used to access OpenSearch.
- Password: The password required to access OpenSearch.
Resource Authorization
- OpenSearch Index: The index name in OpenSearch that needs to be bound and viewed.
- Guance Index: The index name uniquely identifying the Guance workspace, defined by the user and must not be duplicated. After configuration, it can be used to filter index names.
- Note: This index name is unrelated to OpenSearch and is only used for data filtering within Guance.
Click Confirm to complete the index binding. You can switch indices in the Explorer to view them.
Configuration Instructions for Binding External Indices in Elasticsearch/OpenSearch¶
Due to the rolling policy in Elasticsearch/OpenSearch, a single index
may result in multiple index rules or names. This section mainly describes how to query all data under the current index
or specific data from a particular index when configuring in Guance.
Indices, Aliases, and Shards¶
- An index alias is an auxiliary name used to reference one or more existing indices.
- One alias can bind multiple indices, and one index can also bind multiple aliases.
As shown in the figure above, index 1 has 2 shards. If a user needs to query logs within index 1, they only need to bind the index with the index name "index 1" in Guance, without any awareness of the number or size of shards.
Index Rolling¶
As shown in the figure above, using ES's daily rolling index rule as an example, Log-1
is the alias for these indices, and Log-1 - 2022/10/01, etc., are the index names.
- If you need to bind all indices in Guance, bind this index alias. Refer to the following example:
- If you need to bind a specific index or if there is no rolling policy in the configuration, bind the specific index name. Refer to the following example: