菜单
文档breadcrumb arrow Grafana 文档breadcrumb arrow 仪表板breadcrumb arrow 变量breadcrumb arrow 变量语法
Grafana Cloud Enterprise 开源

变量语法

面板标题和指标查询可以使用两种不同的语法引用变量

  • $varname 此语法易于阅读，但不允许您在单词中间使用变量。 示例： apps.frontend.$server.requests.count
  • ${var_name} 当您想在表达式中间插入变量时，请使用此语法。
  • ${var_name:<format>} 此格式使您可以更好地控制 Grafana 如何插入值。有关所有格式类型的更多详细信息，请参阅高级变量格式选项。
  • [[varname]] 请勿使用。已弃用的旧语法，将在未来版本中删除。

在将查询发送到数据源之前，查询会经过插值，这意味着变量将被其当前值替换。在插值期间，变量值可能会被转义，以符合查询语言的语法及其使用位置。例如，在 InfluxDB 或 Prometheus 查询中的正则表达式中使用的变量将被正则表达式转义。请阅读特定于数据源的文档主题，以了解有关插值期间值转义的详细信息。

有关覆盖数据源默认格式设置的高级语法，请参阅高级变量格式选项。

高级变量格式选项

变量插值的格式取决于数据源，但在某些情况下，您可能希望更改默认格式设置。

例如，MySql 数据源的默认设置是将多个值连接为逗号分隔的带引号字符串：'server01','server02'。在某些情况下，您可能希望使用不带引号的逗号分隔字符串：server01,server02。您可以使用下面列出的高级变量格式选项来实现这一点。

通用语法

语法：${var_name:option}

在 Grafana Play 站点上测试格式设置选项。

如果指定了任何无效的格式设置选项，则 glob 是默认/回退选项。

另一种语法（将来可能会弃用）是 [[var_name:option]]。

CSV

将具有多个值的变量格式化为逗号分隔的字符串。

bash 
servers = ['test1', 'test2']
String to interpolate: '${servers:csv}'
Interpolation result: 'test1,test2'

Distributed - OpenTSDB

以 OpenTSDB 的自定义格式格式化具有多个值的变量。

bash 
servers = ['test1', 'test2']
String to interpolate: '${servers:distributed}'
Interpolation result: 'test1,servers=test2'

Doublequote

将单值和多值变量格式化为逗号分隔的字符串，通过 \" 转义每个值中的 "，并使用 " 引用每个值。

bash 
servers = ['test1', 'test2']
String to interpolate: '${servers:doublequote}'
Interpolation result: '"test1","test2"'

Glob - Graphite

将具有多个值的变量格式化为 glob（用于 Graphite 查询）。

bash 
servers = ['test1', 'test2']
String to interpolate: '${servers:glob}'
Interpolation result: '{test1,test2}'

JSON

将具有多个值的变量格式化为逗号分隔的字符串。

bash 
servers = ['test1', 'test2']
String to interpolate: '${servers:json}'
Interpolation result: '["test1", "test2"]'

Lucene - Elasticsearch

以 Elasticsearch 的 Lucene 格式格式化具有多个值的变量。

bash 
servers = ['test1', 'test2']
String to interpolate: '${servers:lucene}'
Interpolation result: '("test1" OR "test2")'

Percentencode

格式化单值和多值变量，以便在 URL 参数中使用。

bash 
servers = ['foo()bar BAZ', 'test2']
String to interpolate: '${servers:percentencode}'
Interpolation result: 'foo%28%29bar%20BAZ%2Ctest2'

Pipe

将具有多个值的变量格式化为管道分隔的字符串。

bash 
servers = ['test1.', 'test2']
String to interpolate: '${servers:pipe}'
Interpolation result: 'test1.|test2'

Raw

数据源变量的原始格式返回数据源的 UID（唯一标识符），而不是其名称。

bash 
datasourceVariable = 'd7bbe725-9e48-4af8-a0cb-6cb255d873a3'
String to interpolate: '${datasourceVariable:raw}'
Interpolation result: 'd7bbe725-9e48-4af8-a0cb-6cb255d873a3'

Regex

将具有多个值的变量格式化为正则表达式字符串。

bash 
servers = ['test1.', 'test2']
String to interpolate: '${servers:regex}'
Interpolation result: '(test1\.|test2)'

Singlequote

将单值和多值变量格式化为逗号分隔的字符串，通过 \' 转义每个值中的 '，并使用 ' 引用每个值。

bash 
servers = ['test1', 'test2']
String to interpolate: '${servers:singlequote}'
Interpolation result: "'test1','test2'"

Sqlstring

将单值和多值变量格式化为逗号分隔的字符串，通过 '' 转义每个值中的 '，并使用 ' 引用每个值。

bash 
servers = ["test'1", "test2"]
String to interpolate: '${servers:sqlstring}'
Interpolation result: "'test''1','test2'"

文本

文本

bash 
servers = ["test1", "test2"]
String to interpolate: '${servers:text}'
Interpolation result: "test1 + test2"

将单值和多值变量格式化为其文本表示形式。对于单值变量，它将仅返回文本表示形式。对于多值变量，它将返回与 + 组合的文本表示形式。

Query parameters

bash 
servers = ["test1", "test2"]
String to interpolate: '${servers:queryparam}'
Interpolation result: "var-servers=test1&var-servers=test2"