添加和管理变量

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

下表列出了 Grafana 附带的变量类型。

输入常规选项

您必须为创建的任何类型的变量输入常规选项。

添加查询变量

通过查询变量，您可以编写数据来源查询，该查询可返回指标名称、标签值或键的列表。例如，查询变量可能返回服务器名称 IDs、传感器或数据中心的列表。变量值在使用数据来源查询动态获取选项时会发生变化。

查询变量通常仅支持字符串。如果您的查询返回数字或任何其他数据类型，则可能需要将其转换为字符串，才能将其用作变量。例如，对于 Azure 数据来源，您可以使用 tostring 函数来实现此目的。

查询表达式可以包含对其他变量的引用，实际上就是创建链接变量。Grafana 会检测到这一点，并在其中一个链接变量发生变化时自动刷新变量。

添加自定义变量

对不变的值（如数字或字符串）使用自定义变量。

例如，如果您的服务器名称或区域名称从未更改，则可能需要将其创建为自定义变量，而不是查询变量。因为其不会更改，所以可以在链式变量中，而不是其他查询变量中使用。这将减少链式变量更新时 Grafana 必须发送的查询次数。

添加文本框变量

文本框变量显示带有可选默认值的自由文本输入字段。这是最灵活的变量，因为您可以输入任何值。如果您的指标具有高基数，或者您希望同时更新控制面板中的多个面板，请使用此类型的变量。

添加常量变量

常量变量允许定义隐藏的常量。这对于要共享的控制面板的指标路径前缀很有用。导出控制面板时，常量变量会转换为导入选项。

常量变量不灵活。每个常量变量仅包含一个值，除非更新变量设置，否则无法更新。

如果需要在查询中包含复杂的值，但又不想在每次查询中都重新输入，常量变量就非常有用。例如，如果有一个名为 i-0b6a61efe2ab843gg 的服务器路径，则可以将其替换为一个名为 $path_gg 的变量。

添加数据来源变量

数据来源变量让您可以快速更改整个控制面板的数据来源。如果您有多个数据来源实例（可能位于不同的环境中），则会很有用。

添加间隔变量

使用间隔变量来表示时间跨度，例如 1m、1h 或 1d。您可以将其视为控制面板范围内的按时间分组命令。间隔变量会更改数据在可视化中的分组方式。您也可以使用“自动选项”在每个时间跨度返回一定数量的数据点。

您可以使用间隔变量作为按时间分组参数（对于 InfluxDB）、日期直方图间隔（对于 Elasticsearch）或作为 summarize 函数参数（对于 Graphite）。

间隔变量示例

以下示例显示了 Graphite 函数中的模板变量 myinterval：

summarize($myinterval, sum, false)

添加临时筛选条件

临时筛选条件允许您添加键值筛选条件，这些筛选条件会自动添加到使用指定数据来源的所有指标查询中。与其他变量不同的是，不在查询中使用临时筛选条件。而是使用临时筛选条件为现有查询编写筛选条件。

创建临时筛选条件

临时筛选条件是可用的最复杂、最灵活的变量选项之一。此变量让您可以构建控制面板范围的临时查询，而不是常规的变量选项列表。以这种方式应用的筛选条件将应用于控制面板上的所有面板。

配置变量选择选项

选择选项是一项用于管理变量选项选择的功能。所有选择选项都是可选的，默认处于关闭状态。

多值变量

对选择了多个值的变量进行插值会比较麻烦，因为如何将多个值格式化为字符串，而且该字符串在使用该变量的给定上下文中有效，这不是个简单明了的过程。Grafana 试图通过允许每个数据来源插件通知模板插值引擎对多个值使用的格式来解决这个问题。

具有 Graphite 数据来源的多值变量

Graphite 使用 glob 表达式。在这种情况下，如果当前变量值为 host1、host2 和 host3，则具有多个值的变量将插值为 {host1,host2,host3}。

具有 Prometheus 或 InfluxDB 数据来源的多值变量

InfluxDB 和 Prometheus 使用正则表达式，因此相同的变量将插值为 (host1|host2|host3)。每个值也将进行正则表达式转义。否则，带有正则表达式控制字符的值将中断正则表达式。

具有 Elastic 数据来源的多值变量

Elasticsearch 使用 lucene 查询语法，因此相同的变量将格式化为 ("host1" OR "host2" OR "host3")。在这种情况下，必须对每个值进行转义，使该值仅包含 lucene 控制词和引号。

多值变量问题排查

自动转义和格式化可能会导致问题，其背后的逻辑也很难理解。特别是对于 InfluxDB 和 Prometheus 来说，使用正则表达式语法需要在正则表达式运算符上下文中使用变量。

如果您不希望 Grafana 自动执行正则表达式转义和格式化，则必须执行下列操作之一：

包含全部选项

Grafana 在变量下拉列表中添加了 All 选项。如果用户选择此选项，则会选择所有变量选项。

自定义所有值

仅当选择包含全部选项时，此选项才可见。

在自定义所有值字段中输入 regex、glob 或 lucene 语法来定义 All 选项的值。

默认情况下，All 值包含组合表达式中的所有选项。该值可能会变得很长，并且可能会出现性能问题。有时，最好指定自定义 all 值，例如通配符正则表达式。

要在自定义所有值选项中使用自定义 regex、glob 或 lucene 语法，使其永远不会转义，因此您必须考虑数据来源的有效值。

全局变量

Grafana 具有全局内置变量，可在查询编辑器的表达式中使用。本主题按字母顺序列出了这些变量，并对其进行了定义。这些变量在查询、控制面板链接、面板链接和数据链接中非常有用。

$__dashboard

此变量是当前控制面板的名称。

$__from 和 $__to

Grafana 有两个内置的时间范围变量：$__from 和 $__to。默认情况下，当前始终插值为纪元毫秒，但您可以控制日期格式。

上面的语法也适用于 ${__to}。

$__interval

您可以使用 $__interval 变量作为按时间分组参数（对于 InfluxDB、MySQL、Postgres、MSSQL）、日期直方图间隔（对于 Elasticsearch）或作为 summarize 函数参数（对于 Graphite）。

Grafana 会自动计算一个间隔，该间隔可用于在查询中按时间分组。当数据点多于图形上显示的数据点时，可通过按更大的间隔分组来提高查询的效率。例如，如果您正在查看包含 3 个月数据的图形，则可能无法看到分钟级别的详细信息。按小时或天分组可以提高查询效率，而不会影响图形显示的内容。$__interval 是使用时间范围和图形宽度（像素数）计算得出的。

近似计算：(to - from) / resolution

例如，当时间范围为 1 小时且图形为全屏时，则可以将间隔计算为 2m，点按 2 分钟间隔分组。如果时间范围为 6 个月且图形为全屏时，则间隔可能是 1d（1 天），点按天分组。

在 InfluxDB 数据来源中，传统变量 $interval 是同一个变量。应改为使用 $__interval。

InfluxDB 和 Elasticsearch 数据源具有 Group by time interval 字段，用于对间隔进行硬编码或设置 $__interval 变量的最小限制（使用 > 语法 -> >10m）。

$__interval_ms

此变量是以毫秒为单位的 $__interval 变量，而不是时间间隔格式的字符串。例如，如果 $__interval 为 20m，则 $__interval_ms 为 1200000。

$__org

此变量是当前组织的 ID。${__org.name} 是当前组织的名称。

$__user

${__user.id} 是当前用户的 ID。${__user.login} 是当前用户的登录句柄。${__user.email} 是当前用户的电子邮件。

$__range

目前仅支持 Prometheus 和 Loki 数据来源。此变量表示当前控制面板的范围。由 to - from 计算得出。此变量有毫秒和秒两种表示形式，分别称为 $__range_ms 和 $__range_s。

$__rate_interval

目前仅支持 Prometheus 数据来源。$__rate_interval 变量旨在用于 rate 函数。

$timeFilter 或 $__timeFilter

$timeFilter 变量以表达式形式返回当前选定的时间范围。例如，时间范围间隔 Last 7 days 表达式为 time > now() - 7d。

可在多个地方使用，包括：

链式变量

链式变量，也称为链接变量或嵌套变量，是变量查询中包含一个或多个其他变量的查询变量。本节说明了链式变量的工作原理，并提供了指向使用链式变量的示例控制面板的链接。

每个数据来源的链式变量查询都不同，但前提都是一样的。您可以在任何允许的数据来源中使用链式变量查询。

可以使用极为复杂的链接模板控制面板，深度为 5 或 10 级。从技术上讲，深度和复杂程度没有限制，但链接越多，查询负荷就越大。

最佳实践和提示

以下做法可使您的控制面板和变量更易于使用。

创建新的链接变量

变量顺序

您可以通过单击每个条目右侧的向上和向下箭头，来更改控制面板变量列表中变量的顺序。Grafana 根据此列表从左到右列出变量下拉列表，变量位于最左侧的顶部。

复杂性考虑

变量中的依赖关系层越多，更改变量后更新控制面板所需的时间就越长。

例如，如果您有一系列四个链接变量（国家、地区、服务器、指标），并更改了根变量值（国家），Grafana 必须先对所有因变量运行查询，然后才能更新控制面板中的可视化。

管理变量

您可以在变量页面上添加变量和管理现有变量。还可以检查变量，并确定变量是否在其他变量或控制面板中被引用（或使用）。

移动：您可以使用拖放操作在列表中上下移动变量。

克隆：要克隆变量，请单击右侧图标集中的克隆图标。这将创建一个变量的副本，其原始变量的名称前缀为 copy_of_。

删除：要删除变量，请单击右侧图标集中的垃圾桶图标。

使用正则表达式筛选变量

通过 Regex Query 选项，您可以筛选变量查询返回的选项列表或修改返回的选项。

本页显示了如何使用正则表达式来筛选/修改变量下拉列表中的值。

通过 Regex Query 选项，您可以筛选变量查询返回的选项列表或修改返回的选项。有关更多信息，请参阅 Mozilla 正则表达式指南。

以下示例显示了对以下选项列表的筛选

backend_01
backend_02
backend_03
backend_04

筛选以仅返回以 01 或 02 结尾的选项

正则表达式：

/
(
01|02 
) 
$/

结果：

backend_01
backend_02

使用正则表达式捕获组筛选和修改选项以返回部分文本

正则表达式：

/.* 
(
01|02 
)
/

结果：

01
02

筛选和修改：Prometheus 示例

选项列表：

up{instance="demo.robustperception.io:9090",job="prometheus"} 1 1521630638000
up{instance="demo.robustperception.io:9093",job="alertmanager"} 1 1521630638000
up{instance="demo.robustperception.io:9100",job="node"} 1 1521630638000

正则表达式：

/. *instance="
(
[^"]*
)
.*/

结果：

demo.robustperception.io:9090
demo.robustperception.io:9093
demo.robustperception.io:9100

使用命名文本和值捕获组进行筛选和修改

使用命名捕获组，您可以从变量查询返回的选项中捕获单独的“文本”和“值”部分。这样，变量下拉列表中的每个可选值都会包含友好的名称。

例如，在查询 node_hwmon_chip_names Prometheus 指标时，chip_name 比 chip 值更友好。因此，以下变量查询结果：

node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_0",chip_name="enp216s0f0np0"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_1",chip_name="enp216s0f0np1"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_2",chip_name="enp216s0f0np2"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_3",chip_name="enp216s0f0np3"} 1

通过以下正则表达式传递：

/chip_name="(?<text>[ ^ " ] + ) |chip=" (?<value >[ ^ " ] + )/g

将生成以下下拉列表：

Display Name          Value
------------          -------------------------
enp216s0f0np0         0000:d7:00_0_0000:d8:00_0
enp216s0f0np1         0000:d7:00_0_0000:d8:00_1
enp216s0f0np2         0000:d7:00_0_0000:d8:00_2
enp216s0f0np3         0000:d7:00_0_0000:d8:00_3

仅支持 text 和 value 捕获组名称。

您可以在变量页面上轻松识别变量是否在其他变量或控制面板中被引用（或使用）。

任何被引用或使用的变量旁边都有一个绿色的复选标记，而未引用的变量旁边有一个橙色的警告图标。此外，所有引用的变量在绿色复选标记旁边都有一个依赖关系图标。您可以选择图标来查看依赖关系图。依赖关系图可以移动。您可以使用鼠标滚轮或等效工具来放大或缩小。