Bind OpenSearch Index¶
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 versions 1.0.x and above are supported.
Account Authorization
- Domain Name: The user access address for OpenSearch, ensure it is accessible over the public network.
- Username: The user name for accessing OpenSearch.
- Password: The password required for accessing OpenSearch.
Resource Authorization
- OpenSearch Index: The name of the index in OpenSearch that you wish to bind for viewing.
- Guance Index: The unique index name identified by the Guance workspace, to be filled in by the user, with no repetition allowed. After configuration, it can be used for filtering index names.
- Note: This index name is unrelated to OpenSearch and is only used for your subsequent data filtering in Guance.
Click Confirm to complete the index binding, and you can view it by switching indexes in the Viewer.
Elasticsearch/OpenSearch Binding Guide¶
Due to the index in Elasticsearch/OpenSearch being subject to rolling policies that result in multiple index rules or names for a single index, this configuration guide mainly introduces how to configure in Guance when you need to query all data under the current index or query data corresponding to a specific index under the current index.
Index, Aliases and Shards¶
- An index alias is an auxiliary name used to reference one or more existing indexes;
- An alias can bind multiple indexes, and an index can also bind multiple aliases.
As shown in the figure above, there are 2 shards in this index named index 1. If the user needs to query the log content in index 1, they only need to bind the index with the index name index 1 in Guance, with no perception of the number or 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, as shown in the following example:
- If you need to bind a specific index in Guance, or if there is no rolling policy in the configuration, you only need to bind the specific index name, as shown in the following example:
