添加仪表盘过滤器和变量

仪表盘过滤器和变量都支持对各个图表数据进行附加的过滤筛选操作，便于您快速查看关键字段的统计分析数据。本文档介绍如何在仪表盘中添加过滤器或变量。

背景信息

仪表盘中默认展示各个分析图表在指定时间范围的统计数据，展示的图表数据取决于图表对应的时间范围和检索分析语句。日志服务支持通过过滤器或变量实现仪表盘中的图表联动。创建过滤器或变量后，您可以通过指定字段的字段值对图表数据进行过滤，即查看关键字段的统计分析数据。例如，为访问日志相关的仪表盘设置多个过滤器，分别支持访问来源、客户端 IP、HTTP code 等字段的过滤和筛选，以便快速查看不同访问来源、客户端 IP 的相关数据分析结果。
日志服务支持通过过滤器、变量添加筛选条件。

• 过滤器：通过日志的字段名与字段值进行过滤。在仪表盘中添加过滤器并选择字段值后，日志服务会将指定的键值对作为附加的检索条件添加到检索分析语句之前，附加的检索条件和原查询语句之间为 AND 或 NOT 逻辑关系。即最终的检索分析语句为 [Key:Value] AND/NOT [search query] | [sql query]，例如 code:500 AND ip:192.168.1.2，表示在包含键值对 code: 500 的日志中检索 ip 字段为 192.168.1.2 的日志。
• 变量：通过指定变量名与变量值进行过滤。添加变量后，图表对应的检索分析语句中的变量将被替换为您所选择的变量值，对仪表盘中已设置该变量的图表都生效。

注意事项

每个仪表盘中，过滤器、变量和图表的数量之和不可超过 50。

前提条件

• 已采集到日志数据，并配置了索引。详细说明请参考快速入门。
• 已创建仪表盘，并在仪表盘中添加了统计图表。详细说明请参考创建仪表盘和添加图表到仪表盘。
• 如果使用变量筛选图表数据，那么在添加图表时需在检索分析语句中添加变量占位符。
  变量语法为${{变量名|默认值}}，例如id: ${{id|123}} | SELECT __time__ - __time__ %60 AS time, COUNT(*) AS PV GROUP BY time。

创建过滤器

1. 登录日志服务控制台。

2. 在左侧导航栏中选择日志服务 > 日志项目管理。

3. 找到指定的日志项目，单击项目名称。

4. 在左侧导航栏中，单击仪表盘，并在仪表盘列表中单击仪表盘名称。

5. 在页面右上角单击过滤与变量图标。
   

6. 在管理过滤器和变量面板中，单击新建过滤器与变量。

7. 在新建过滤器面板中，完成如下配置。

   配置	说明
   基本配置
   类型	过滤器类型。此处选择过滤器。
   名称	过滤器名称。创建过滤器后不支持修改名称。 该名称仅用于过滤器管理，并显示在过滤器列表页面，不显示在仪表盘中。
   过滤方式	过滤的方式。支持设置为以下方式。 AND：取多个搜索结果的交集，即在图表的检索语句中增加指定过滤条件。实际生效的检索分析语句为[Value] AND [search query] | [sql query]。 NOT：搜索结果不包含原图表指定的检索语句。实际生效的检索分析语句为[Value] NOT [search query] | [sql query]。 其中 Value 在过滤器选项中设置。
   支持多选	使用过滤器时，Value 是否支持多选。默认为关闭状态，即不支持多选。开启时，可以选择多个 Value 作为过滤条件。多选时，过滤条件之间为或（or）关系。 其中 Value 在过滤器选项中设置。
   过滤器字段
   字段名	用于过滤的字段名。 日志服务将此处配置的字段作为过滤条件的 Key，对整个仪表盘进行过滤操作。
   字段别名	用于过滤的字段在过滤器中显示的别名。例如为字段 clientIP 设置别名为客户端 IP，以便获得更好的仪表盘使用体验。
   过滤器选项 说明 如果用于过滤的字段值是固定的，则配置静态值。反之则配置动态值。
   静态值	为过滤器字段设置静态值（Value）。日志服务会将此静态值添加到指定字段的字段值列表项中。支持添加多个静态值。每个静态值可添加以下配置： 字段值：用于过滤的字段值，必选。 字段值别名：字段值在过滤器中显示的别名。可选。例如为 Name 字段的字段值 zhangsan 设置别名张三。 默认选中：过滤器中是否默认选中此字段。默认为关闭状态，即不选中。未开启支持多选时，只能为某一个值开启默认选中。
   动态值	为过滤器字段设置动态的值。日志服务将以所选日志主题的日志分析结果作为字段值的可选项。动态值可能是动态变化的，其实际值取决于设置的时间范围和检索分析语句等因素。

创建变量

1. 登录日志服务控制台。

2. 在左侧导航栏中选择日志服务 > 日志项目管理。

3. 找到指定的日志项目，单击项目名称。

4. 在左侧导航栏中，单击仪表盘，并在仪表盘列表中单击仪表盘名称。

5. 在页面右上角单击过滤与变量图标。
   

6. 在管理过滤器和变量面板中，单击新建过滤器与变量。

7. 在新建过滤器面板中，完成如下配置。

   配置	说明
   基本配置
   类型	过滤器类型。此处选择变量。
   名称	变量名称。创建变量后不支持修改名称。 该名称仅用于变量管理，并显示在变量列表页面，不显示在仪表盘中。
   变量字段
   字段名	用于过滤的变量名。 日志服务将此处配置的变量名作为过滤条件的 Key，对仪表盘中已设置该变量的图表生效。
   字段别名	用于过滤的变量名的别名。例如为变量 clientIP 设置别名为客户端 IP，以便获得更好的仪表盘使用体验。
   变量选项 说明 如果用于过滤的变量值是固定的，则配置静态值。反之则配置动态值。
   静态值	为变量设置静态值。日志服务会将此静态值添加到指定变量的值列表项中。支持添加多个静态值。每个静态值可添加以下配置： 字段值：用于过滤的变量值，必选。 字段值别名：变量值的别名。可选。例如为变量 Name 的值 zhangsan 设置别名张三。 默认选中：变量中是否默认选中此字段。默认为关闭状态，即不选中。未开启支持多选时，只能为某一个值开启默认选中。
   动态值	为变量设置动态的值。日志服务将以所选日志主题的日志分析结果作为变量值的可选项。动态值可能是动态变化的，其实际值取决于设置的时间范围和检索分析语句等因素。

配置示例

变量

例如您需要通过图表 A 查看不同时间间隔（例如每秒、每小时等）的网站访问量时，可添加一个时间间隔变量，无需手动修改检索分析语句。
在创建变量前，需先添加图表 A 。图表 A 对应的检索分析语句如下所示：

* | SELECT DATE_FORMAT(__time__ - __time__ % 60000, 'HH:mm:ss') AS time, count(*) AS PV GROUP BY time ORDER BY time

创建变量的示例步骤如下：

1. 在图表 A 的检索分析语句中，添加变量占位符${{interval|60000}}。

   * | SELECT DATE_FORMAT(__time__ - __time__ % ${{interval|60000}}, 'HH:mm:ss') AS time, count(*) AS PV GROUP BY time ORDER BY time
   

2. 创建变量。
   重要配置项示例如下：

   • 选择类型为变量。
   • 设置名称为时间间隔变量。
   • 设置字段名为interval，字段别名为时间间隔。
   • 设置字段值为3600000、60000、1000，分别表示时间间隔为每小时、每分钟、每秒。
     

3. 使用变量。
   创建变量后，仪表盘中将展示变量选项框，您可以通过变量选项框过滤图表数据。例如选择时间间隔为每小时，则图表 A 将展示每小时的网址访问数量。
   

过滤器

例如图表 A 展示了每分钟的请求数量，当您需要查看请求方法维度的请求数量时，可添加一个请求方法过滤器，无需手动修改检索分析语句。
在创建过滤器前，需先添加图表 A 且图表 A 对应的检索分析语句如下：

* | SELECT DATE_FORMAT(__time__ - __time__ % 60000, 'HH:mm:ss') AS time, count(*) AS PV GROUP BY time ORDER BY time

创建过滤器的示例步骤如下：

1. 创建过滤器。
   重要配置项示例如下：
   • 选择类型为过滤器。
   • 设置名称为请求方法过滤器。
   • 设置过滤方式为AND。
   • 打开支持多选开关**。**
   • 设置字段名为Method，字段别名为请求方法。
   • 勾选动态值，即从检索分析语句中提取字段值，对应的检索分析语句为*| SELECT DISTINCT Method。
     
2. 使用过滤器。
   创建过滤器后，仪表盘中将展示过滤器，您可以使用过滤器筛选图表数据。例如选择请求方法为PutLogs，则图表 A 将展示每分钟PutLogs方法对应的请求数量。
   

相关操作

添加过滤器和变量后，您可以在仪表盘中便捷使用过滤器和变量，也可以按需修改或删除过滤器和变量，详细说明请参考仪表盘常见操作。