Grafana Polystat 面板

此面板插件为基于 D3 的多指标面板，适用于Grafana 8.4+。

为接收到的每个指标创建一个六边形，并能够将指标分组为复合指标，并显示复合指标的触发状态。

截图

此插件支持自动缩放，以便每个多边形最佳适应面板大小。当无法显示完整文本时，只有工具提示处于活动状态。

全部可见

缩小显示

缩小显示并带工具提示

选项

此面板提供大量自定义选项，并可从菜单中搜索。

布局

默认情况下，插件会根据面板大小使用“最佳适应”计算来自动调整要显示的多边形大小。

或者，您可以手动指定列数和行数，或仅自动指定其中一个。

列

最大创建列数

行

最大创建行数 注意：如果同时设置了列和行，则只会显示 行数*列数 个，通常应该只设置其中一个或都不设置。

如果列数和行数不足以显示所有数据，将显示警告。

显示限制

设置要显示的多边形数量限制。设置为 0 表示无限制（默认值为 100）。

大小

多边形的大小默认按最佳适应计算，但需要时可以手动设置。

本节还提供了为每个多边形设置边框的选项（默认值为 2 像素）。

取消选择自动大小选项可手动设置大小。

每个多边形的边框大小可在本节设置。使用的颜色可在“全局”部分找到。

文本

插件将尝试使用所有多边形中可能的最大字体显示尽可能多的文本。颜色、字体大小和字体系列可以手动设置。

字体系列

您还可以设置用于渲染文本的字体系列。目前默认字体是 Inter，迁移将从 Roboto 转换为 Inter

自动缩放字体

取消选中“自动缩放字体”可手动输入字体大小。

自动化字体颜色

取消选中“自动化字体颜色”可手动设置字体颜色。自动化选项使用当前主题选择颜色，这可能不适用于所有情况。

使用颜色选择器手动设置字体颜色

排序

可以使用排序选项设置显示多边形的顺序（从左到右）。

支持以下方向

以及以下字段

工具提示

启用/禁用工具提示

切换面板工具提示的显示

工具提示字体系列

设置工具提示中使用的字体系列。

显示时间戳

切换工具提示底部时间戳的显示

显示模式

您可以选择仅在工具提示中显示已触发阈值的指标，或显示所有指标。当许多指标汇总到一个复合指标时，这很有用。

工具提示 - 未触发状态文本

当没有触发阈值时，此文本将代替指标值显示在工具提示中。如果想显示值，请留空。

工具提示排序

当有多个指标需要显示时，以下设置适用于复合指标。

工具提示有更广泛的排序选项，有助于在工具提示“顶部”显示重要数据。您可以指定一个字段和方向作为主排序依据，还可以指定一个次要字段和方向。如果需要，您也可以禁用排序。

主排序

主排序方向（参见上表）

应用于工具提示指标的排序类型。

主排序字段

按哪个字段排序

次要排序

次要排序的工作方式与主排序相同，但可以使用不同的字段/阈值/值以不同方向排序。这将在执行主排序之后应用。

次要排序方向（参见上表）

次要排序字段

全局

以下设置在“全局”部分可用，并在下方详细说明。

显示模式

您可以选择仅显示已触发阈值的指标，或显示所有指标。

全局 - 未触发状态文本

当没有触发阈值且全局显示模式设置为“已触发”时，在多边形中显示的文本。

显示值（全局）

显示指标的值和名称。

显示时间戳（全局）

此选项将在多边形中显示指标的时间。

时间戳格式

为时间戳提供了预设格式，该字段也接受自定义格式。

时间戳位置

时间戳可以显示在值的上方或下方。如果值未显示，它将显示在值通常渲染的位置。

时间戳 Y 偏移

这允许上下调整时间戳以微调位置。正值向下移动时间戳，负值向上移动。

形状

目前有三种形状可供选择，每种都使用最佳适应方法来最大化面板大小。

顶部尖角六边形

圆形

方形

使用颜色渐变

此选项将应用阴影颜色而非纯色。

全局填充颜色

这是当没有适用于指标或复合指标的阈值时使用的颜色。

全局边框颜色

可以设置每个多边形的边框颜色，并与上面大小设置一起使用。

单位

所有单位类型在此选择器中均可用，并将应用于显示的值。

统计

选择要显示的值的统计量。Grafana 提供的所有统计量均可用。

小数位数

这限制了显示的小数位数。

全局阈值

这组阈值适用于所有没有匹配覆盖项的指标。

参阅下方章节，了解阈值如何评估的详细信息。

全局点击跳转

此点击跳转 URL 将应用于所有未指定覆盖项或复合项点击跳转的多边形。

点击跳转 - 清理 URL

通常此选项是启用的，旨在防止恶意数据输入。

点击跳转 - 在新标签页中打开 URL

选中此选项后，点击多边形时将在新标签页中打开。对于下钻仪表板，建议禁用此选项。

点击跳转 - 启用自定义 URL 目标

选中此选项后，您可以为点击跳转的 target 属性设置自定义值。注意：此选项仅在禁用“在新标签页中打开”时可见。

点击跳转 - 自定义 URL 目标

指定点击跳转 URL 的 target 属性内容。

典型值包括：_blank|_self|_parent|_top|

全局别名

此字段允许您指定一个正则表达式，以选取匹配指标名称的一部分进行渲染，而不是完整名称。

如果您有以下 3 个查询，返回系列：Foo-A，值 1,2,3 Bar-B，值 4,5,6 Misc，值 7,8,9

添加正则表达式：/(Foo|Bar)/，将显示

指定一个正则表达式来选取匹配指标名称的一部分。

覆盖项

覆盖项用于为指标应用额外的渲染选项，包括自定义阈值和点击跳转。

这是一个覆盖项示例，用于设置匹配正则表达式的指标的单位

添加阈值后的相同覆盖项

应用阈值后的上述覆盖项的最终结果

标签

V2 的新功能是能够命名覆盖项，以便在创建大量覆盖项时更容易找到。标签不会在多边形上渲染。

指标

面板将提供指标名称的“提示”，并允许您输入正则表达式来匹配多个指标。

小数位数（限制）

设置要显示的最大小数位数。留空以显示所有小数。

要显示的统计量（统计）

这允许您为匹配的指标指定一个不同的统计量，并将替换全局统计量。与全局设置一样，Grafana 提供的所有统计量均可用。

单位格式

所有单位类型在此选择器中均可用，并将应用于显示的值。格式化器通常会添加后缀以指示单位，例如“B/sec”或温度、百分比等符号。

阈值

覆盖项可以指定应用于匹配指标的一组阈值，并将替换任何全局阈值设置。

参阅下方章节，了解阈值如何评估的详细信息。

前缀

此字段中的文本将前置到渲染的指标。

后缀

此字段中的文本将在应用任何单位文本后追加到渲染的指标。

点击跳转 URL

使用此选项指定点击多边形时跳转到的 URL。可以使用正则表达式捕获组和模板变量来构建 URL。

使用捕获组的示例

例如，如果我们有多个指标，如下所示

hera_memutil
plex_memutil

以及用于覆盖项的正则表达式

/(.*)_mem/

捕获组 $1 可用于 URL 中

/dashboard/detail-dash?var-HOSTNAME=$1

URL 最终将是

https://myserver/dashboard/detail-dash?var-HOSTNAME=hera

有关使用模板变量和正则表达式捕获组的更多示例，请参阅此模板化部分。

清理 URL

通常此选项是启用的，旨在防止恶意数据输入。

在新标签页中打开 URL

选中此选项后，点击多边形时将在新标签页中打开。对于下钻仪表板，建议禁用此选项。

启用自定义 URL 目标

选中此选项后，您可以为点击跳转的 target 属性设置自定义值。注意：此选项仅在禁用“在新标签页中打开 URL”时可见。这将覆盖等效的全局设置。

自定义 URL 目标

指定点击跳转 URL 的 target 属性内容。这将覆盖等效的全局设置。

典型值包括：_blank|_self|_parent|_top|

底部菜单

覆盖项右下角有一个菜单，提供额外的控件。

排序

向上和向下箭头允许您移动覆盖项，以便强制使用不同的评估优先级或仅将相似的覆盖项分组。

隐藏/显示

使用“眼睛”图标启用/禁用覆盖项。

复制

此按钮将复制当前覆盖项并将其附加到列表末尾。它将拥有一个新名称，末尾带有“复制”。

删除

此按钮将完全删除覆盖项。

复合指标

复合指标允许您将多个指标组合成一个表示，该表示反映了组合指标的“最差”状态。这对于监控更复杂系统的汇总视图非常有用。

当一个复合指标需要显示多个指标时，多边形将根据复合指标配置循环显示每个指标。

这是两个复合指标渲染后的样子

这是将鼠标悬停在复合指标上时显示的工具提示

动画示例

当有多个指标时，渲染的多边形将根据复合指标设置循环显示每个指标。

这是两个复合指标及其动画序列的示例

复合指标的全局设置

有两个适用于所有复合指标的全局设置。

启用复合指标

提供一个切换开关，可以快速禁用所有复合指标的渲染。此外，每个复合指标都有一个隐藏图标来切换其可见性。

动画速度 (毫秒)

此设置控制动画循环发生的速度（以毫秒为单位）。

复合指标设置

复合指标名称

设置要渲染的复合指标的名称。这接受正则表达式和模板变量。

捕获组也受支持，允许您使用别名选项简化显示的名称。

显示名称（复合指标）

此设置将隐藏/显示显示的多边形上的名称。

显示值（复合指标）

此设置将隐藏/显示显示的多边形上的值。

显示成员

启用此选项后，复合指标将与所有指标一起显示。通常此选项是禁用的，只显示复合指标。

显示模式（复合指标）

这将仅覆盖此复合指标的全局显示模式。与全局设置一样，您可以选择仅显示已触发阈值的指标或显示所有指标。

点击跳转 URL（复合指标）

使用此选项指定点击多边形时跳转到的 URL。可以使用正则表达式捕获组和模板变量来构建 URL。有关高级用法的详细信息，请参阅覆盖项部分。

清理 URL（复合指标）

通常此选项是启用的，旨在防止恶意数据输入。

在新标签页中打开 URL（复合指标）

选中此选项后，点击多边形时将在新标签页中打开。对于下钻仪表板，建议禁用此选项。

启用自定义 URL 目标（复合指标）

选中此选项后，您可以为点击跳转的 target 属性设置自定义值。注意：此选项仅在禁用“在新标签页中打开 URL”时可见。

自定义 URL 目标（复合指标）

指定点击跳转 URL 的 target 属性内容。

典型值包括：_blank|_self|_parent|_top|

底部菜单（复合指标）

复合指标右下角有一个菜单，提供额外的控件。

排序（复合指标）

向上和向下箭头允许您移动复合指标，以便更容易分组。

隐藏/显示（复合指标）

使用“眼睛”图标启用/禁用复合指标。

复制（复合指标）

此按钮将复制当前复合指标并将其附加到列表末尾。它将拥有一个新名称，末尾带有“复制”。

删除（复合指标）

此按钮将完全删除复合指标。

向复合指标添加指标

“添加指标”按钮用于向要包含在复合指标中的指标列表追加指标。

指标/正则表达式（复合指标）

编辑器提供了查询返回的指标列表，也接受可能包含模板变量的正则表达式。

注意：模板变量会先展开，然后应用正则表达式进一步过滤复合指标中包含的指标。

别名（复合指标）

如果此字段有内容，将用作指标名称的替代。

指标名称中的捕获组和模板变量可用于构建要显示的新名称。

使用模板变量、捕获组和复合变量的详细信息，请参阅下方章节。

值映射

这是 Grafana 的内置选项，其行为方式与此处文档所述相同。

注意：颜色分配会被忽略，仅应用阈值颜色。

阈值详情

此插件支持“范围化”状态。

阈值应按升序排列，其中

T0 = lowest decimal value, any state
TN = highest decimal value, any state

初始状态设置为“ok”

使用“大于或等于”与值进行比较 如果 值 >= thresholdValue 状态 = X

比较按倒序进行，使用第 N 个（包含）阈值和第 N+1 个（不包含）阈值之间的范围

  InclusiveValue = T(n).value
  ExclusiveValue = T(n+1).value

当没有第 n+1 个阈值时，对于最高值阈值 T(n)，进行一个简单的包含 >= 比较

示例 1：（典型线性）

    T0 - 5, ok
    T1 - 10, warning
    T2 - 20, critical

  Value >= 20 (Value >= T2)
  10 <= Value < 20  (T1 <= Value < T2)
  5 <= Value < 10   (T0 <= Value < T1)

示例 2：（反向线性）

    T0 - 50, critical
    T1 - 90, warning
    T2 - 100, ok

  Value >= 100
  90 <= value < 100
  50 <= value < 90

示例 3：（有界）

    T0 - 50, critical
    T1 - 60, warning
    T2 - 70, ok
    T3 - 80, warning
    T4 - 90, critical

    Value >= 90
    80 <= Value < 90
    70 <= Value < 80
    60 <= Value < 70
    50 <= Value < 60

检查每个阈值范围后返回“最差”状态

模板化

使用仪表板模板变量

模板变量在 clickThroughUrl 设置中可用，通过 ${varname} 指定。它们也可以通过在 URL 中附加 var-VARNAME=value 来传递到另一个仪表板。

/dashboard/xyz?var-VARNAME=${VARNAME}

使用带有捕获组的正则表达式覆盖项提供了额外的变量，可以在 clickThroughUrl 中引用。

示例

正则表达式：/TEMP_(?<A_HOST>.*)_/ 点击跳转 URL：/grafana/d/eCLHPr57k/drilldown?orgId=1&var-host=${A_HOST}

上述示例将展开名为 A_HOST 的捕获组，并替换指定 URL 中的值。

使用 Polystat 变量

每个多边形表示单个指标或复合指标

可以像这样指定一个下钻点击跳转 URL 示例

dashboard/db/drilldown?var-HOSTNAME=${__cell_name}

注意：指标使用全局选项中的“排序”设置进行排序。全局过滤器也在解引用之前应用。

单个指标变量

可以使用以下语法引用多边形的名称和值

• 指标名称：${__cell_name}
• 指标值：${__cell}
• 指标原始值：${__cell:raw} 语法。默认情况下，值经过 URI 编码。使用此语法可以禁用编码

复合指标变量

可以使用以下语法引用复合多边形的名称和值

• 复合指标名称：${__composite_name}
• 指标名称：${__cell_name_n}
• 指标值：${__cell_n}
• 指标原始值：${__cell_n:raw} 语法。默认情况下，值经过 URI 编码。使用此语法可以禁用编码

构建

此插件依赖于Plugin Tools，典型的构建顺序如下

yarn install
yarn build

如果“tslint”通过且无错误，代码将被解析然后复制到“dist”中。

对于开发，您可以运行

yarn dev

Docker 支持

包含一个 docker-compose.yml 文件，方便开发和测试，只需运行

docker-compose up

然后浏览至https://:3000

外部依赖项

• Grafana 8.4+

启用 Grafana TestData

Grafana TestData 默认未启用。要启用它，请首先导航到 Grafana 主菜单中的“插件”部分。点击“插件”部分中的“应用”选项卡，选择 Grafana TestData App。（或者直接导航到http://您的_grafana_实例/plugins/testdata/edit）。最后点击启用按钮进行启用。

致谢

此面板基于此 D3 示例

• https://www.visualcinnamon.com/2013/07/self-organizing-maps-creating-hexagonal.html

非常感谢贡献者

• Mathieu Rollet (matletix)
• Mattias Jiderhamn (mjiderhamn)
• AnushaBoggarapu
• KamalakarGoretta
• Rene Hennig (renehennig)
• Hamza Ziyani (HZiyani)

以及许多其他人！