云搜索服务提供的 Kibana 版本兼容原生 Elasticsearch 提供的 Kibana，两者在操作上存在一定的区别。本文介绍云搜索服务版 Kibana 的高频操作。 ## 前提条件您已登录 Kibana。具体操作，请参见[登录 Kibana/Dashboards](https://www.volcengine.com/docs/6465/1117828)。 ## 语句执行类 ### 执行 DSL 语句 Dev Tools 是 Kibana 中常用的工具，您可在 Dev Tools 中执行 DSL 语句来实现各种功能。 1. 在左侧导航栏选择 **Management \> Dev Tools**。 2. 在 **Console** 面板的文本框中输入待执行的 DSL 语句。 3. 在文本框右上角单击执行图标。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_dc911ef54444c7c8bd8ec8701b6eb891.png) 此外，您还可以单击配置图标，然后选择 Auto intent 对 DSL 语句进行格式化，如下图所示。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_3ec721e5ce892cd3ae8a66138a35c9a7.png) ### 执行 SQL 语句您可以通过 Query Workbench 工具来执行 SQL 语句。 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Query Workbench**。 2. 在 **Query editor** 面板的文本框中输入待执行的 SQL 语句。 3. 单击 **Run** 按钮。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_4c217a47226bb56dea9b7504c3105479.png) ## 索引类 ### 创建索引模式 1. 在左侧导航栏选择 **Management \> Stack Management**。 2. 选择 **Index Patterns**，然后单击 **Create index pattern**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_361140c8de55ba4ddedc1ffb4c2ecb4a.png) 3. 在 **Index pattern name** 文本框中输入索引模式名称，然后单击 **Next step**。

说明

索引模式名称支持通配符 * 来匹配多个索引。不支持特殊字符 \/?"<>| 和空格。

![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_81807b68682289da7a33c0aa9f84e00c.png) 4. 在 **Time field** 下拉列表中选择 **I don't want to use the time filter**，然后单击 **Create index pattern**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_a36d18b265d9e23cfa7bb265fe6d86f7.png) ### 查看索引列表 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Index Management**。 2. 选择 **Indices**，然后在 **Indices** 区域查看索引列表。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_fbbb0d3d7ddd8206c5b1e07e1fdc778e.png) ### 查看索引 settings 在 Dev Tools 中执行如下命令。具体操作，请参见本文**执行 DSL 语句**章节。 ```HTTP GET {index_name}/_settings ``` ### 查看索引 mapping 在 Dev Tools 中执行如下命令。具体操作，请参见本文**执行 DSL 语句**章节。 ```HTTP GET {index_name}/_mapping ``` ### 开启索引在Dev Tools 中执行如下命令。具体操作，请参见本文**执行 DSL 语句**章节。 ```HTTP POST {index_name}/_open ``` ### 关闭索引

说明

关闭索引后，数据将继续保留，但不再提供读写服务。需要时可重新开启索引。

在 Dev Tools 中执行如下命令。具体操作，请参见**执行 DSL 语句**章节。 ```HTTP POST {index_name}/_close ``` ### 删除索引

注意

索引删除后不可恢复，请谨慎操作。

在 Dev Tools 中执行如下命令。具体操作，请参见**执行 DSL 语句**章节。 ```HTTP POST {index_name}/_close ``` ## 查询参数设置 ### 设置 `max_concurrent_shard_requests` 参数 1. 在左侧导航栏选择 **Management \> Stack Management**。 2. 选择 **Advanced Settings**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_0c37d2f698f1faf34561c960f6aae5ac.png) 3. 在 **Settings** 页面中，通过配置 **Max Concurrent Shard Requests** 来设置 `max_concurrent_shard_requests` 参数。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_9cd256f9d3732289114e7417e8ec1c9f.png) ## 用户和角色此功能仅向管理员开放，且 Kibana 7.10.2 与 Kibana 6.7.1 操作略有差异。 Kibana 7.10.2 ### 创建角色您可以基于角色（Role）定义具体可以执行的 API 权限，具体的权限信息可以参考[社区官方文档](https://opendistro.github.io/for-elasticsearch-docs/docs/security/access-control/permissions/)。 #### 操作步骤 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Security**。 2. 选择 **Roles**，然后单击 **Create role**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b1a7947fc086984799a1210198ca81b9.png) 3. 在 **Create Role** 页面，根据需要配置各参数，然后单击 **Create**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_a696b61e55f40481e76fd6598b9d6096.png) ### 创建用户 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Security**。 2. 选择 **Internal users**，然后单击 **Create internal user**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_ca501b64395893299b58bbaadc0f4a5e.png) 3. 在 **Create internal user** 页面，根据需要配置各参数，然后单击 **Create**。 ### 将角色关联至用户 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Security**。 2. 选择 **Roles**，然后单击目标角色名称。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_94051ec5f9c5934c2483b0cd1ec4e49b.png) 3. 在目标角色的详情页，单击 **Mapped users** 页签，然后单击 **Manage mapping**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bf4af43738324c597409b8ea3f9c6cfd.png) 4. 在 **Map user** 页面，从 **Users ** 下拉列表中选择要关联的用户，然后单击 **Map**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_7e6cf6161450d31359db00d739ba0c3b.png) Kibana 6.7.1 ### 创建角色您可以基于角色（Role）定义具体可以执行的 API 权限，具体的权限名称可以参考[社区官方文档](https://opendistro.github.io/for-elasticsearch-docs/docs/security/access-control/permissions/)。 #### 操作步骤 1. 在左侧导航栏选择 **Security**，然后单击 **Roles**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_7a1f5cd0e5f1ff43b3c55cb8283b27cb.png) 2. 在 **Roles** 页面，单击 **+** 。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_197d1d87f90eda6b2a7a74e7157f45dc.png) 3. 在 **New Role ** 页面，根据需求在各页签中配置角色参数，然后单击 **Save Role Definition**。具体的权限信息可以参考[社区官方文档](https://opendistro.github.io/for-elasticsearch-docs/docs/security/access-control/permissions/)。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f028549e5db3fb0f5796db0c7a55ee7c.png) ### 创建用户 1. 在左侧导航栏选择 **Security**，然后单击 **Internal User Database**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_cd19d38f9fc9a57b298034a6b24782df.png) 2. 在 **Manage Internal User** 页面，单击 **+** 。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_a14f1e2a214d56e4c1caa4265469b163.png) 3. 根据需要配置各参数，然后单击 **Submit**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_6ce213bae0eafa79ab23767669576213.png) ### 将角色关联至用户 1. 在左侧导航栏选择 **Security**，然后单击 **Role Mappings**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b83f2ac96c2b5b1357fbf8ebc59dbfd1.png) 2. 在 **Manage Role Mappings** 页面中，单击目标角色名称。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b4eb4bcf1a17225e6666f4342f673c64.png) 3. 在 **Edit Role Mapping** 页面，单击 Add User，输入要关联的用户名称，然后单击 **Submit**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b55ce3e07a06978f28af965ca86d6b98.png) ## Dev Tools 自动提示索引 Dev Tools 支持自动提示索引，如下图所示。Kibana 7.10.2 与 Kibana 6.7.1 操作略有差异。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_15de8b3312322866fcfff11ec23c4dee.png) Kibana 7.10.2 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Security**。 2. 选择 **Roles**，然后单击 **Create role**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b1a7947fc086984799a1210198ca81b9.png) 3. 在 **Create Role** 页面，输入角色名称，在 **Cluster permissions** 下添加 **indices:admin/template/get** 权限，在 **Index** 下输入 **\*** ，在 **Index permissions** 下添加 `indices:admin/get`、`indices:admin/aliases/get` 权限，然后单击 **Create**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_3d4628cdfa0b73d3e15f01a0b49c6cca.png) Kibana 6.7.1 1. 创建 action group。 1. 在左侧导航栏选择 **Security**，然后单击 **Action Groups**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_478ca5eeadfffd5f221d9551327cec6a.png) 2. 在 **Manage Action Groups** 页面，单击 **+** 。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_61856ca1071d8e600b62d9d0cdb50e7e.png) 3. 在 **New Action Groups** 页面，输入 action group 名称，勾选 **Show Advanced**，单击 **Add Single Permission**，在下拉列表中选择 **indices:admin/template/get**，然后单击 **Submit**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_38329b57c71968e4a9050da73c671b43.png) 2. 创建角色。 1. 在左侧导航栏选择 **Security**，然后单击 **Roles**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_576ed021550a7ce4b58d06fc9087adfc.png) 2. 在 **Roles** 页面，单击 **+** 。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_197d1d87f90eda6b2a7a74e7157f45dc.png) 3. 在 **New Role ** 页面的 **Overview** 页签中，输入角色名称。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_fb8c538b08cc1b4e697d5bd2d462197d.png) 4. 选择 **Cluster Permissions** 页签，单击 **Add Action Group**，然后在下拉列表中选择创建的 action group。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_62c4c04ebef61a7604cdbb713637ae31.png) 5. 选择 **Index Permissions** 页签，单击 **Add new index and document Type。** ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_999b978c13ed9591d2d00986669c1ba6.png) 6. 在 **Index** 文本框中输入 **\*** ，然后单击 **Save**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_96fda6b40a650f04b2f4c69a3997bf0b.png) 7. 勾选 **Show Advanced**，单击 **Add Single Permission**，依次添加 `indices:admin/template/get`、`indices:admin/get`、`admin/mappings/get` 权限，然后单击 **Save Role Definition**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_bb24cb0a8afe16ce346dc5659916df18.png) 3. 将角色关联至用户。 1. 在左侧导航栏选择 **Security**，然后单击 **Role Mappings**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_b83f2ac96c2b5b1357fbf8ebc59dbfd1.png) 2. 在 **Manage Role Mappings** 页面中，单击 **+** 。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_ffb53c38cd4ddfc924f2c5affe323d79.png) 3. 在 **Role** 下拉列表中选择创建的角色名称，单击 **Add User**，输入创建的用户名称，然后单击 **Submit**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_69032be8057c80fb7b0c0345bd211051.png) ## 索引生命周期管理 ### **创建 policy** 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Index Management**。 2. 选择 **Index Policies**，然后单击 **Create policy**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_83d151d64a43f566f1683c2ac907b84a.png) 3. 在 **Create policy** 页面，设置 **Policy ID**，定义 policy 内容，然后单击 **Create**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_a6259aa8b4e5ef32881a9219dacb2ea4.png) 创建的 policy 将对新增的索引自动生效。以下为 7 天自动删除索引的示例 policy。 ```JSON { "policy": { "description": "Retain indices for 7 days", "default_state": "hot", "states": [ { "name": "hot", "actions": [ ], "transitions": [ { "state_name": "delete", "conditions": { "min_index_age": "7d" //保留天数 } } ] }, { "name": "delete", "actions": [ {"delete":{}} ], "transitions": [ ] } ], "ism_template": { "index_patterns": [ "index-*" //匹配的索引规则 ] } } } ``` ### **将 policy 关联至存量索引** 1. 在左侧导航栏选择 **Open Distro for Elasticsearch \> Index Management**。 2. 选择 Indices，勾选要关联的索引，然后单击 **Apply policy**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_f6498c2d77cfbe327d4c0d92212ff841.png) 3. 在 **Apply policy** 对话框中，选择要关联的 policy，然后单击 **Apply**。 ![图片](https://portal.volccdn.com/obj/volcfe/cloud-universal-doc/upload_20090274a5bc54c9401f5608537b72df.png) ## 更多操作火山引擎云搜索服务提供的 Kibana 中部分功能需要通过 Dev Tools 来实现。如需帮助，请[提交工单](https://console.volcengine.com/workorder/create/?step=2&SubProductID=P00000255)联系火山引擎云搜索服务团队。