Grafana 多状态统计面板

此面板插件为 Grafana 8.4+ 提供了一个基于 D3 的多状态统计面板。

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

屏幕截图

此插件支持自动缩放，以便将每个多边形的最佳大小调整到面板大小。当无法显示完整文本时，只有工具提示是活动的。

全部显示

缩小显示

缩小显示并带工具提示

选项

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

布局

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

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

列

创建的最大列数

行

创建的最大行数 注意：如果同时设置了列和行，则仅显示 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/秒”或表示温度、百分比等的符号。

阈值

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

有关阈值评估的详细信息，请参阅下文阈值部分。

前缀

此字段中的文本将被添加到渲染的指标之前。

后缀

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

点击通过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目标

当选中时，这将允许您为点击通过的目标属性设置自定义值。注意：仅在禁用“在新标签页中打开URL”时可见。这将覆盖等效的全局设置。

自定义URL目标

指定点击通过URL的目标属性的内容。这将覆盖等效的全局设置。

典型值包括：_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

初始状态设置为“正常”

使用“大于等于”与值进行比较，格式为 如果值 >= 阈值值，状态 = 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 测试数据

Grafana 测试数据 默认情况下未启用。要启用它，首先转到 Grafana 主菜单中的插件部分。在插件部分中单击 Apps 标签并选择 Grafana 测试数据应用。 (或导航到 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)

以及许多人！