Grafana Polystat 面板

此面板插件为 基于 D3 的 Grafana 8.4+ 的多统计面板。

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

截图

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

全部可见

缩小

缩小并显示工具提示

选项

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

布局

默认情况下，插件将根据面板的大小自动调整多边形的大小以进行“最佳拟合”计算。

或者，你可以手动指定列数和行数，或只自动设置其中一个。

列

要创建的最大列数

行

要创建的最大行数 注意：如果同时设置了列和行，则只显示 rows*columns，通常应设置一个或不设置任何一个。

如果没有足够的列和行来显示所有数据，则会显示警告。

显示限制

设置要显示的多边形的数量限制。将此值设置为 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”。

使用“大于或等于”对值进行比较，如果值 >= 阈值，则状态 = 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} 指定。它们也可以通过将 var-VARNAME=value 附加到 url 来传递到另一个仪表板。

/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 编码。使用此语法来禁用编码。

构建

此插件依赖于插件工具，典型的构建序列

yarn install
yarn build

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

对于开发，您可以运行

yarn dev

Docker 支持

docker-compose.yml 文件包含在内，以便于开发和测试，只需运行

docker-compose up

然后浏览到https://127.0.0.1:3000

外部依赖项

• Grafana 8.4+

启用 Grafana TestData

Grafana TestData 默认情况下未启用。要启用它，首先导航到“插件”部分，该部分位于您的 Grafana 主菜单中。单击“插件”部分中的“应用程序”选项卡，然后选择“Grafana TestData”应用程序。（或导航到http://your_grafana_instance/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)

以及许多其他人！