文档

Grafana 文档

可观测性即代码

JSON schema v2

变量 schema

Grafana Cloud Enterprise 开源

`变量`

以下部分描述了可用的变量类型

QueryVariableKind
TextVariableKind
ConstantVariableKind
DatasourceVariableKind
IntervalVariableKind
CustomVariableKind
GroupByVariableKind
AdhocVariableKind

`QueryVariableKind`

以下是默认查询变量的 JSON

  "variables": [
    {
      "kind": "QueryVariable",
      "spec": {
        "current": {
          "text": "",
          "value": ""
        },
        "hide": "dontHide",
        "includeAll": false,
        "multi": false,
        "name": "",
        "options": [],
        "query": defaultDataQueryKind(),
        "refresh": "never",
        "regex": "",
        "skipUrlSync": false,
        "sort": "disabled"
      }
    }
  ]

QueryVariableKind 包括

kind: “QueryVariable”
spec: QueryVariableSpec

`QueryVariableSpec`

下表解释了查询变量 JSON 字段的用法

名称	用法
name	string。变量的名称。
current	“Text” 和一个 “value” 或 `VariableOption`
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
refresh	`VariableRefresh`。选项包括 `never`、`onDashboardLoad` 和 `onTimeChanged`。
skipUrlSync	bool。默认为 `false`。
description?	string
datasource?	`DataSourceRef`
query	`DataQueryKind`。包括 kind: string spec: string
regex	string
sort	`VariableSort`。选项包括禁用字母升序字母降序数字升序数字降序字母（不区分大小写）升序字母（不区分大小写）降序自然升序自然降序
definition?	string
options	`VariableOption`
multi	bool。默认为 `false`。
includeAll	bool。默认为 `false`。
allValue?	string
placeholder?	string

`VariableOption`

名称	用法
selected	bool。选项是否被选中。
text	string。要为选项显示的文本。
value	string。选项的值。

`DataSourceRef`

名称	用法
type?	string。插件的 type-id。
uid?	特定的数据源实例。

`TextVariableKind`

以下是默认文本变量的 JSON

  "variables": [
    {
      "kind": "TextVariable",
      "spec": {
        "current": {
          "text": "",
          "value": ""
        },
        "hide": "dontHide",
        "name": "",
        "query": "",
        "skipUrlSync": false
      }
    }
  ]

TextVariableKind 包括

kind: TextVariableKind
spec: TextVariableSpec

`TextVariableSpec`

下表解释了查询变量 JSON 字段的用法

名称	用法
name	string。变量的名称。
current	“Text” 和一个 “value” 或 `VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
query	string
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
skipUrlSync	bool。默认为 `false`。
description?	string

`ConstantVariableKind`

以下是默认常量变量的 JSON

  "variables": [
    {
      "kind": "ConstantVariable",
      "spec": {
        "current": {
          "text": "",
          "value": ""
        },
        "hide": "hideVariable",
        "name": "",
        "query": "",
        "skipUrlSync": true
      }
    }
  ]

ConstantVariableKind 包括

kind: “ConstantVariable”
spec: ConstantVariableSpec

`ConstantVariableSpec`

下表解释了常量变量 JSON 字段的用法

名称	用法
name	string。变量的名称。
query	string
current	“Text” 和一个 “value” 或 `VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
skipUrlSync	bool。默认为 `false`。
description?	string

`DatasourceVariableKind`

以下是默认数据源变量的 JSON

  "variables": [
    {
      "kind": "DatasourceVariable",
      "spec": {
        "current": {
          "text": "",
          "value": ""
        },
        "hide": "dontHide",
        "includeAll": false,
        "multi": false,
        "name": "",
        "options": [],
        "pluginId": "",
        "refresh": "never",
        "regex": "",
        "skipUrlSync": false
      }
    }
  ]

DatasourceVariableKind 包括

kind: “DatasourceVariable”
spec: DatasourceVariableSpec

`DatasourceVariableSpec`

下表解释了数据源变量 JSON 字段的用法

名称	用法
name	string。变量的名称。
pluginId	string
refresh	`VariableRefresh`。选项包括 `never`、`onDashboardLoad` 和 `onTimeChanged`。
regex	string
current	`Text` 和一个 `value` 或 `VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
options	`VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
multi	bool。默认为 `false`。
includeAll	bool。默认为 `false`。
allValue?	string
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
skipUrlSync	bool。默认为 `false`。
description?	string

`IntervalVariableKind`

以下是默认时间间隔变量的 JSON

  "variables": [
    {
      "kind": "IntervalVariable",
      "spec": {
        "auto": false,
        "auto_count": 0,
        "auto_min": "",
        "current": {
          "text": "",
          "value": ""
        },
        "hide": "dontHide",
        "name": "",
        "options": [],
        "query": "",
        "refresh": "never",
        "skipUrlSync": false
      }
    }
  ]

IntervalVariableKind 包括

kind: “IntervalVariable”
spec: IntervalVariableSpec

`IntervalVariableSpec`

下表解释了时间间隔变量 JSON 字段的用法

名称	用法
name	string。变量的名称。
query	string
current	`Text` 和一个 `value` 或 `VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
options	`VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
auto	bool。默认为 `false`。
auto_count	integer。默认为 `0`。
refresh	`VariableRefresh`。选项包括 `never`、`onDashboardLoad` 和 `onTimeChanged`。
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
skipUrlSync	bool。默认为 `false`
description?	string

`CustomVariableKind`

以下是默认自定义变量的 JSON

  "variables": [
    {
      "kind": "CustomVariable",
      "spec": {
        "current": defaultVariableOption(),
        "hide": "dontHide",
        "includeAll": false,
        "multi": false,
        "name": "",
        "options": [],
        "query": "",
        "skipUrlSync": false
      }
    }
  ]

CustomVariableKind 包括

kind: “CustomVariable”
spec: CustomVariableSpec

`CustomVariableSpec`

下表解释了自定义变量 JSON 字段的用法

名称	用法
name	string。变量的名称。
query	string
current	`Text` 和一个 `value` 或 `VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
options	`VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
multi	bool。默认为 `false`。
includeAll	bool。默认为 `false`。
allValue?	string
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
skipUrlSync	bool。默认为 `false`。
description?	string

`GroupByVariableKind`

以下是默认分组变量的 JSON

  "variables": [
    {
      "kind": "GroupByVariable",
      "spec": {
        "current": {
          "text": [
            ""
          ],
          "value": [
            ""
          ]
        },
        "datasource": {},
        "hide": "dontHide",
        "multi": false,
        "name": "",
        "options": [],
        "skipUrlSync": false
      }
    }
  ]

GroupByVariableKind 包括

kind: “GroupByVariable”
spec: GroupByVariableSpec

`GroupByVariableSpec`

下表解释了分组变量 JSON 字段的用法

名称	用法
name	string。变量的名称
datasource?	`DataSourceRef`。参考 `QueryVariableKind` 下的`DataSourceRef` 定义。
current	`Text` 和一个 `value` 或 `VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
options	`VariableOption`。参考 `QueryVariableKind` 下的`VariableOption` 定义。
multi	bool。默认为 `false`。
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
skipUrlSync	bool。默认为 `false`。
description?	string。

`AdhocVariableKind`

以下是默认即时变量的 JSON

  "variables": [
    {
      "kind": "AdhocVariable",
      "spec": {
        "baseFilters": [],
        "defaultKeys": [],
        "filters": [],
        "hide": "dontHide",
        "name": "",
        "skipUrlSync": false
      }
    }
  ]

AdhocVariableKind 包括

kind: “AdhocVariable”
spec: AdhocVariableSpec

`AdhocVariableSpec`

下表解释了即时变量 JSON 字段的用法

名称	用法
name	string。变量的名称。
datasource?	`DataSourceRef`。包括 type? - string。插件的 type-id。 uid? - string。特定的数据源实例。
baseFilters	AdHocFilterWithLabels
filters	AdHocFilterWithLabels
defaultKeys	MetricFindValue
label?	string
hide	`VariableHide`。选项包括：`dontHide`、`hideLabel` 和 `hideVariable`。
skipUrlSync	bool。默认为 `false`。
description?	string