Grafana Cloud Enterprise 开源 PanelKind
面板元素包含关于面板的所有信息，包括可视化类型、面板和可视化配置、查询以及转换。仪表盘中包含的每个面板都有一个对应的面板元素。
以下是默认的面板元素 JSON
"kind": "Panel",
"spec": {
"data": {
"kind": "QueryGroup",
"spec": {...},
"description": "",
"id": 0,
"links": [],
"title": "",
"vizConfig": {
"kind": "",
"spec": {...},
}
}
PanelKind 包括
PanelSpec
下表解释了面板元素 JSON 字段的用法
| 名称 | 用法 |
|---|
| data | QueryGroupKind，包含查询和转换。包括 |
| description | 面板描述。 |
| id | 面板 ID。 |
| links | 指向其他仪表盘或外部网站的链接。 |
| title | 面板标题。 |
| vizConfig | VizConfigKind。包含可视化类型、字段配置选项以及所有其他可视化选项。包括 |
| transparent？ | 布尔值。控制面板背景是否透明。 |
QueryGroupSpec
| 名称 | 用法 |
|---|
| queries | PanelQueryKind。包括 |
| transformations | TransformationKind。包括 |
| queryOptions | QueryOptionsSpec |
PanelQuerySpec
DataQueryKind
DataSourceRef
| 名称 | 用法 |
|---|
| type？ | string。插件类型 ID。 |
| uid？ | 特定的数据源实例。 |
转换允许您在系统应用可视化之前操作查询返回的数据。使用转换可以：重命名字段、连接时序数据、跨查询执行数学运算，或将一个转换的输出用作另一个转换的输入。
| 名称 | 用法 |
|---|
| id | string。转换器的唯一标识符。 |
| disabled？ | 布尔值。禁用的转换将被跳过。 |
| filter？ | MatcherConfig。可选的 frame matcher。如果缺失，将应用于所有结果。 |
| topic？ | DataTopic。从中提取 DataFrames 作为转换输入的位置。选项有：series、annotations 和 alertStates。 |
| options | 传递给转换器的选项。有效选项取决于转换器 ID。 |
MatcherConfig
Matcher 是一个谓词配置。根据字段或值集合的配置，它被过滤以应用覆盖或转换。它带有一个 ID（用于从注册表中解析实现）以及特定于特定 matcher 类型的配置。
| 名称 | 用法 |
|---|
| id | string。Matcher ID。用于从注册表中查找 matcher 实现。 |
| options？ | Matcher 选项。特定于 matcher 实现。 |
QueryOptionsSpec
| 名称 | 类型 |
|---|
| timeFrom？ | string |
| maxDataPoints？ | 整数 |
| timeShift？ | string |
| queryCachingTTL？ | 整数 |
| interval？ | string |
| cacheTimeout？ | string |
| hideTimeOverride？ | 布尔值 |
VizConfigSpec
FieldConfigSource
Grafana 中使用的数据模型，即 data frame，是一种面向列的表格结构，它统一了时序数据和表格查询结果。此结构中的每一列称为一个字段。字段可以代表单个时序或表格列。字段选项允许您更改数据在可视化中的显示方式。
| 名称 | 类型/定义 |
|---|
| defaults | FieldConfig。Defaults 是应用于所有字段的选项。 |
| overrides | 应用于特定字段的选项，会覆盖 defaults。 |
| matcher | MatcherConfig。可选的 frame matcher。如果缺失，将应用于所有结果。 |
| properties | DynamicConfigValue。包括 |
FieldConfig
| 名称 | 类型/定义 |
|---|
| displayName？ | string。此字段的显示值。支持模板变量，为空时为自动。 |
| displayNameFromDS？ | string。可由返回明确的值和标签命名结构的数据源使用。配置此属性后，将使用此值而非默认命名策略。 |
| description？ | string。人类可读的字段元数据。 |
| path？ | string。数据源中字段的显式路径。当 frame meta 包含路径时，默认为 ${frame.meta.path}/${field.name}。定义后，此值可用作数据源范围内的标识符，并可用于更新结果。 |
| writeable？ | 布尔值。如果数据源可以将值写入路径，则为 true。认证/授权分开支持。 |
| filterable？ | 布尔值。如果数据源字段支持即时过滤器，则为 true。 |
| unit？ | string。字段应使用的单位。选择的单位应用于除时间外的所有字段。您可以使用 Grafana 中可用的单位 ID 或自定义单位。Grafana 中可用单位。作为自定义单位，您可以使用以下格式suffix:<suffix> 用于应放在值后面的自定义单位。prefix:<prefix> 用于应放在值前面的自定义单位。time:<format> 用于自定义日期时间格式，例如time:YYYY-MM-DDsi:<base scale><unit characters> 用于自定义 SI 单位。例如：si: mF。您可以同时指定单位和源数据刻度，因此如果您的源数据表示为 milli（千分之一）的某个值，请在该 SI 刻度字符前加上单位。count:<unit> 用于自定义计数单位。currency:<unit> 用于自定义货币单位。
|
| decimals？ | number。指定 Grafana 在渲染值中包含的小数位数。如果此字段留空，Grafana 将根据值自动截断小数位数。例如，1.1234 将显示为 1.12，100.456 将显示为 100。要显示所有小数，请将单位设置为 string。 |
| min？ | number。百分比阈值计算中使用的最小值。留空以基于所有系列和字段进行自动计算。 |
| max？ | number。百分比阈值计算中使用的最大值。留空以基于所有系列和字段进行自动计算。 |
| mappings？ | [...ValueMapping]。将输入值转换为显示字符串。选项有：ValueMap、RangeMap、RegexMap、SpecialValueMap。 |
| thresholds？ | ThresholdsConfig。将数值映射到状态。包括mode - ThresholdsMode。选项有：absolute 和 percentage。steps - [...Threshold]
|
| color？ | FieldColor。面板颜色配置。 |
| links？ | [...]。点击结果时的行为。 |
| noValue？ | string。空字符串的替代值。 |
| custom？ | {...}。由面板插件 schema 中的 FieldConfig 字段指定。 |
ValueMap
将文本值映射到颜色或不同的显示文本和颜色。例如，您可以配置值映射，使值 10 的所有实例显示为 Perfection! 而不是数字本身。
| 名称 | 用法 |
|---|
| type | MappingType 和 “value”。MappingType 选项有：value、range、regex 和 special。 |
| options | string。ValueMappingResult。映射为 <待匹配值>: ValueMappingResult。例如：{ "10": { text: "完美！", color: "绿色" } }。 |
RangeMap
将数值范围映射到显示文本和颜色。例如，如果一个值在某个范围内，您可以配置范围值映射以显示 Low 或 High 而不是数字本身。
| 名称 | 用法 |
|---|
| type | MappingType 和 “range”。MappingType 选项有：value、range、regex 和 special。 |
| options | 要匹配的范围以及当值在该范围内时要应用的结果。Specfrom - float64 或 null。范围的最小值。可以为 null，表示 -Infinity。to - float64 或 null。范围的最大值。可以为 null，表示 +Infinity。result - ValueMappingResult
|
RegexMap
将正则表达式映射到替换文本和颜色。例如，如果值为 www.example.com，您可以配置 regex 值映射，使 Grafana 显示 www 并截断域名。
| 名称 | 用法 |
|---|
| type | MappingType 和 “regex”。MappingType 选项有：value、range、regex 和 special。 |
| options | 用于匹配的正则表达式以及当值与 regex 匹配时要应用的结果。Spec |
SpecialValueMap
将 Null、NaN（非数字）等特殊值以及 true 和 false 等布尔值映射到显示文本和颜色。请参阅下表中的 SpecialValueMatch，查看特殊值列表。例如，您可以配置特殊值映射，使 null 值显示为 N/A。
| 名称 | 用法 |
|---|
| type | MappingType 和 “special”。MappingType 选项有：value、range、regex 和 special。 |
| options | Spec |
ValueMappingResult
当值匹配时用作替换结果（带有文本和颜色）。
| 名称 | 用法 |
|---|
| text | string。当值匹配时显示的文本。 |
| color | string。当值匹配时使用的颜色。 |
| icon | string。当值匹配时显示的图标。仅特定可视化支持。 |
| index | int32。在映射数组中的位置。仅内部使用。 |
FieldColor
将字段映射到颜色。
| 名称 | 用法 |
|---|
| mode | FieldColorModeId。主要的颜色方案模式。 |
| FixedColor？ | string。fixed 或 shades 颜色模式的固定颜色值。 |
| seriesBy？ | FieldColorSeriesByMode。某些可视化需要知道如何从按值颜色方案中分配系列颜色。定义如何从“按值”颜色方案中分配系列颜色。例如，对于像时序图这样的聚合数据点，可以根据最小值、最大值或最后一个值来分配颜色。选项有：min、max 和 last。 |
FieldColorModeId
字段的颜色模式。您可以指定单一颜色，或根据值选择连续（渐变）颜色方案。连续颜色使用值相对于最小值和最大值的百分比进行插值。接受的值包括
| 名称 | 描述 |
|---|
| thresholds | 根据阈值。通知 Grafana 从匹配的阈值获取颜色。 |
| palette-classic | 经典调色板。Grafana 会根据系列索引在调色板中查找颜色并分配。适用于折线图、饼图以及其他分类数据可视化。 |
| palette-classic-by-name | 经典调色板（按名称）。Grafana 会根据系列名称在调色板中查找颜色并分配。适用于折线图、饼图以及其他分类数据可视化。 |
| continuous-GrYlRd | 连续绿-黄-红调色板模式 |
| continuous-RdYlGr | 连续红-黄-绿调色板模式 |
| continuous-BlYlRd | 连续蓝-黄-红调色板模式 |
| continuous-YlRd | 连续黄-红调色板模式 |
| continuous-BlPu | 连续蓝-紫调色板模式 |
| continuous-YlBl | 连续黄-蓝调色板模式 |
| continuous-blues | 连续蓝调色板模式 |
| continuous-reds | 连续红调色板模式 |
| continuous-greens | 连续绿调色板模式 |
| continuous-purples | 连续紫调色板模式 |
| shades | 单一颜色的阴影。指定单一颜色，在覆盖规则中很有用。 |
| fixed | 固定颜色模式。指定单一颜色，在覆盖规则中很有用。 |
