You need to enable JavaScript to run this app.
导航
添加仪表盘过滤器和变量
最近更新时间:2025.03.14 14:46:24首次发布时间:2023.04.24 11:20:10
我的收藏
有用
有用
无用
无用

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

Demo 中心

日志服务 Demo 中心提供了自定义变量 Demo,方便您快速体验功能。单击 可视化案例 立即体验。

注意

Demo 中心的数据为演示数据,请勿用于生产环境。

背景信息

仪表盘中默认展示各个统计图表在指定时间范围的统计数据,展示的图表数据取决于图表对应的时间范围和检索分析语句。日志服务支持通过过滤器或变量实现仪表盘中的图表联动。创建过滤器或自定义变量后,您可以通过指定字段的字段值对图表数据进行过滤,即查看关键字段的统计分析数据。例如,为访问日志相关的仪表盘设置多个过滤器,分别支持访问来源、客户端 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 的日志。

自定义变量

通过指定变量名与变量值进行过滤。添加变量后,图表对应的检索分析语句中的变量将被替换为您所选择的变量值,对仪表盘中已设置该变量的图表都生效。

说明

如果使用变量筛选图表数据,则添加图表时需在检索分析语句中添加变量占位符。变量语法为${{变量名|默认值}},例如id: ${{id|123}} | SELECT __time__ - __time__ %60 AS time, COUNT(*) AS PV GROUP BY time

数据源变量

通过指定变量名和日志主题范围,您可以灵活地切换统计图表的数据源。添加数据源变量后,只需切换变量值,指定的统计图表便会基于您所切换的日志主题自动更新检索分析结果。

预置变量

日志服务提供 __from__to 等预置变量,无需创建即可在仪表盘的检索分析语句、统计图表标题和文本图等文本框中直接使用。

注意事项

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

前提条件

添加过滤器

添加过滤器的操作步骤与示例如下:

操作步骤

添加过滤器步骤如下:

  1. 登录日志服务控制台
  2. 在顶部导航栏中,选择日志服务所在的地域。
  3. 在左侧导航栏中,选择常用功能 > 仪表盘
  4. 在仪表盘列表中,单击目标日志项目下的仪表盘。
  5. 在页面右上角单击设置图标。
    Image
  6. 过滤器和变量页签中,单击添加过滤器
  7. 新建过滤器面板中,参考参数说明,完成相关配置,然后单击新建过滤器

参数说明

添加过滤器的相关参数说明如下表所示。

参数

说明

过滤器名称

过滤器名称。创建过滤器后不支持修改名称。
该名称仅用于过滤器管理,并显示在过滤器列表页面,不显示在仪表盘中。

过滤器别名(显示名)

在仪表盘中显示的过滤器别名。例如为字段 clientIP 设置别名客户端 IP,以便获得更好的仪表盘使用体验。

字段名

用于过滤的字段。
日志服务把该字段作为过滤条件的 Key,对整个仪表盘进行过滤操作。
您可以通过静态值动态值参数配置该字段的值。

过滤方式

过滤的方式。支持设置为以下方式。

  • AND:取多个搜索结果的交集,即在图表的检索语句中增加指定过滤条件。实际生效的检索分析语句为[Value] AND [search query] | [sql query]
  • NOT:搜索结果不包含原图表指定的检索语句。实际生效的检索分析语句为[Value] NOT [search query] | [sql query]
    其中,Value 为您在静态值动态值参数中配置的字段值。

支持多选

使用过滤器时,Value 是否支持多选。默认为关闭状态,即不支持多选。开启时,可以选择多个 Value 作为过滤条件。多选时,过滤条件之间为或(or)关系。

其中,Value 为您在静态值动态值参数中配置的字段值。

静态值

为过滤器字段设置静态值(Value)。日志服务会将该静态值添加到指定字段的值列表项中。支持添加多个静态值,且各静态值顺序可通过拖动自由调整。每个静态值可添加以下配置:

  • 字段值:用于过滤的字段值。支持设置为星号(*),表示匹配所有的字段值。
  • 字段值别名:字段值在过滤器中显示的别名。可选。例如为字段值 zhangsan 设置别名张三
  • 默认选中:过滤器中是否默认选中此字段。默认为关闭状态,即不选中。未开启支持多选时,只能为某一个值开启默认选中

动态值

为过滤器字段设置动态的值。日志服务将以所选日志主题的检索分析结果作为字段值的可选项。
动态值是动态变化的,其实际值取决于设置的时间范围和检索分析语句等因素。

添加自定义变量

添加自定义变量的操作步骤与示例如下:

操作步骤

添加自定义变量的步骤如下:

  1. 登录日志服务控制台
  2. 在顶部导航栏中,选择日志服务所在的地域。
  3. 在左侧导航栏中,选择常用功能 > 仪表盘
  4. 在仪表盘列表中,单击目标日志项目下的仪表盘。
  5. 在页面右上角单击设置图标。
    Image
  6. 过滤器和变量页签中,单击添加自定义变量
  7. 新建自定义变量面板中,参考参数说明,完成相关配置,然后单击新建变量
  8. 设置页面的右上角,单击保存

参数说明

添加自定义变量的相关参数说明如下表所示。

配置

说明

变量名

用于过滤的变量名。
日志服务把该变量作为过滤条件的 Key,对仪表盘中已设置该变量的统计图表生效。

变量别名(显示名)

变量名的别名。例如为变量 clientIP 设置别名客户端 IP,以便获得更好的仪表盘使用体验。

静态值

为变量设置静态值。日志服务会将此静态值添加到指定变量的值列表项中。支持添加多个静态值,且各静态值顺序可通过拖动自由调整。每个静态值可添加以下配置:

  • 字段值:用于过滤的变量值,必选。支持设置为星号(*),表示匹配所有的变量值。
  • 字段值别名:变量值的别名。可选。例如为变量值 zhangsan 设置别名张三
  • 默认选中:变量中是否默认选中此字段。默认为关闭状态,即不选中。未开启支持多选时,只能为某一个值开启默认选中

动态值

为变量设置动态的值。日志服务将以所选日志主题的检索分析结果作为变量值的可选项。
动态值是动态变化的,其实际值取决于设置的时间范围和检索分析语句等因素。

添加数据源变量

添加数据源变量的操作步骤与示例如下:

操作步骤

添加自定义变量的步骤如下:

  1. 登录日志服务控制台
  2. 在顶部导航栏中,选择日志服务所在的地域。
  3. 在左侧导航栏中,选择常用功能 > 仪表盘
  4. 在仪表盘列表中,单击目标日志项目下的仪表盘。
  5. 在页面右上角单击设置图标。
    Image
  6. 过滤器和变量页签中,单击添加数据源变量
  7. 新建数据源变量面板中,参考参数说明,完成相关配置,然后单击新建数据源变量
  8. 设置页面的右上角,单击保存

参数说明

添加数据源变量的相关参数说明如下表所示。

配置

说明

数据源变量名

数据源变量名。
日志服务把该变量作为过滤条件的 Key,对仪表盘中已设置该变量的统计图表生效。

别名(显示名)

变量名的别名。例如为变量 clientIP 设置别名客户端 IP,以便获得更好的仪表盘使用体验。

选项来源

用于指定数据源范围,支持选择全部日志主题、自定义日志主题。

  • 全部日志主题:包括当前仪表盘所在日志项目中的所有日志主题。
  • 自定义日志主题:支持在当前仪表盘所在的日志项目中,选择您所需要的日志主题。
    支持通过正则表达式匹配目标日志主题。

默认日志主题

指定默认使用的日志主题。

使用系统预置变量

日志服务提供 __from__to 等预置变量,无需创建即可在仪表盘的检索分析语句、统计图表标题和文本图等文本框中直接使用。

时间范围变量

添加时间范围变量后,系统将根据所选时间范围展示起始时间。

变量

说明

${{__from}}

检索分析的开始时间。联合
time_format 格式时,支持将时间戳格式化,详细说明,请参考Format 用法

${{__to}}

检索分析的结果时间。联合
time_format 格式时,支持将时间戳格式化,详细说明,请参考Format 用法

例如,在文本图中使用 ${{__from}}${{__to}} 变量。

  • 文本图配置
    Image
  • 文本图结果
    Image

时间长度变量

添加时间范围变量后,系统将根据所选时间范围计算时间长度。

变量

说明

${{__range}}

时间长度,单位为毫秒。等同于 ${{__range_ms}}

${{__range_s}}

时间长度,单位为秒。

${{__range_ms}}

时间长度,单位为毫秒。

例如,在统计图表标题中使用 ${{__range_s}} 变量。

  • 标题配置
    Image
  • 标题效果
    Image

时间颗粒度变量

添加颗粒度变量后,系统将根据所选的时间范围自动适配不同的时间颗粒度。

变量

说明

${{__interval}}

时间颗粒度变量,默认单位为毫秒。联合
duration_round_fomart 格式时支持格式化时间间隔并四舍五入取最大整数的时间单位。详细说明,请参考Format 用法

例如,在检索分析语句中使用 ${{__interval}} 变量。

  • 检索分析语句配置

    * | SELECT $__timeGroup(__time__, ${{__interval}}) AS time, count(*) AS PV GROUP BY time ORDER BY time
    

    Image

  • 检索分析结果
    Image

地域变量

添加地域变量后,系统将根据当前仪表盘所在地域展示地域信息。

变量

说明

${{__dashboard_region}}

地域变量,展示当前仪表盘所在地域。

${{__dashboard_host}}

域名变量,展示当前日志服务控制台的域名。

例如,在打开HTTP链接交互事件中,使用 ${{__dashboard_region}}${{__dashboard_host}} 变量拼接日志服务仪表盘页面地址。链接地址配置示例如下:

https://${{__dashboard_host}}/tls/region:tls+${{__dashboard_region}}/v2/dashboard

Image

创建变量级联关系

创建变量后,日志服务支持配置各个变量之间的级联关系,用于明确变量之间的依赖关系。本文以创建 name 变量和 email 变量之间的级联关系。

  1. 创建 name 变量。
  2. 创建 email 变量。
    创建 email 变量时,需在变量值中引用 name 变量。
    Image
  3. 使用变量。
    name 变量和 email 变量存在级联关系,当您选定 name 变量值后,email 变量值将自动完成筛选。
    Image
    您还可以在过滤器和变量页签中,单击查看变量级联关系,查看当前仪表盘中各个变量之间级联关系。
    Image

Format 用法

日志服务支持在变量中使用 Format。

Format

说明

time_format

格式化毫秒级时间戳,支持与 ${{__from}} ${{__to}} 变量搭配使用。支持的格式配置,请参考 format。例如:

  • ${{__to:time_format("YYYY-MM-DD HH:mm:ss.SSS")}}:将查询结束时间格式化为 YYYY-MM-DD HH:mm:ss.SSS 格式。
    Image
  • ${{__from:time_format("DD/MM/YYYY")}} :将查询开始时间格式化为 DD/MM/YYYY 格式。
    Image

duration_round_fomart

格式化时间间隔并四舍五入取最大整数的时间单位,支持与 ${{__interval}} 变量搭配使用,即${{__interval:duration_round_format }}。例如:

  • 系统根据所选时间范围自动适配的时间颗粒度为 2000 毫秒,经过格式化处理后,取最大整数的时间单位为秒,因此最终格式化结果为 2s。
    Image
  • 系统根据所选时间范围自动适配的时间颗粒度为 600000 毫秒,经过格式化处理后,取最大整数的时间单位为分钟,因此格式化结果为 10m。
    Image

tls_search_filter

将变量值转换为检索条件,格式为tls_search_filter("key", "AND")}}tls_search_filter("key", "NOT")}},其中 key 为字段名,AND、NOT 为逻辑连接符。需与自定义变量或系统预置变量联合使用。例如:

  • ${{method:tls_search_filter("method", "AND")}}:将 ${{method}} 变量值转换为检索条件。
    Image
  • ${{status:tls_search_filter("Status", "AND")}}:将 ${{status}} 变量值转换为检索条件,并在检索分析语句中使用。
    • 检索分析语句

      * ${{status:tls_search_filter("status", "AND")}}
      
    • 检索分析结果
      Image
      Image

encode_base64

对变量值进行 Base64 编码 。例如使用${{method:encode_base64}},对 ${{method}} 变量值进行编码。
Image

相关操作

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