插件〉VictoriaMetrics

数据源

商业版

VictoriaMetrics

概览
安装
更新日志
相关内容

用于 Grafana 的 VictoriaMetrics 数据源

VictoriaMetrics Grafana 插件允许 Grafana 查询、可视化和与 VictoriaMetrics 交互，VictoriaMetrics 是一个高性能的指标存储和处理系统。

能力

使用 MetricsQL 在 Grafana 中查询指标。
在 Grafana 中使用探索模式。
构建仪表盘并设置告警。
使用即时过滤器。
模板化查询和表达式。
通过追踪获取关于查询执行瓶颈的洞察。
通过“美化”按钮自动格式化查询。

在VictoriaMetrics playground 试用！

安装

有关如何在 Grafana Cloud 或本地安装插件的详细说明，请查阅插件安装文档。

通过 UI 手动配置

在您的 Grafana 实例上安装插件后，请按照这些说明添加一个新的 VictoriaMetrics 数据源，并输入配置选项。

通过文件配置

配置 Grafana 插件需要创建一个数据源配置文件

apiVersion: 1
datasources:
  - name: VictoriaMetrics
    type: victoriametrics-metrics-datasource
    access: proxy
    url: http://victoriametrics:8428
    isDefault: true

name: VictoriaMetrics - cluster
type: victoriametrics-metrics-datasource
access: proxy
url: http://vmselect:8481/select/0/prometheus
isDefault: false

构建查询

VictoriaMetrics 的查询语言是 MetricsQL - 受 PromQL 启发的查询语言。MetricsQL 向后兼容 PromQL，因此将数据源从 Prometheus 切换到 VictoriaMetrics 后，由 Prometheus 数据源支持的 Grafana 仪表盘应该也能正常工作。然而，这两种语言之间存在一些有意为之的差异。

可以使用原始 MetricsQL 或通过查询构建器构建查询。总的来说，仪表盘体验与 Prometheus 数据源相同。

在VictoriaMetrics playground 查看面板示例。

如何使用 WITH 模板

WITH 模板功能简化了复杂查询的构建和管理。您可以在WITH 模板 playground 中试用此功能。

“WITH 模板”部分允许您创建带有模板的表达式，这些表达式可以在仪表盘中使用。

WITH 表达式存储在数据源对象中。如果导出仪表盘，相关的 WITH 模板不会包含在生成的 JSON 中（由于技术限制），需要单独迁移。

定义 WITH 表达式

导航到您要添加模板的仪表盘。
注意：模板在仪表盘范围内可用。
点击“WITH 模板”按钮。
在输入字段中输入表达式。完成后，按“保存”按钮应用更改。例如

commonFilters = {instance=~"$node:$port",job=~"$job"},
# cpuCount is the number of CPUs on the node
cpuCount = count(count(node_cpu_seconds_total{commonFilters}) by (cpu)),
# cpuIdle is the sum of idle CPU cores
cpuIdle = sum(rate(node_cpu_seconds_total{mode=‘idle’,commonFilters}[5m]))

您可以在变量之前指定注释并在其中使用 markdown。注释将在自动补全时显示为提示。注释可以跨多行。

使用 WITH 表达式

保存模板后，您可以将其输入到查询编辑器字段中

((cpuCount - cpuIdle) * 100) / cpuCount

因此，整个查询将如下所示

WITH (
 commonFilters = {instance=~"$node:$port",job=~"$job"},
 cpuCount = count(count(node_cpu_seconds_total{commonFilters}) by (cpu)),
 cpuIdle = sum(rate(node_cpu_seconds_total{mode='idle',commonFilters}[5m]))
)
((cpuCount - cpuIdle) * 100) / cpuCount

要在界面中查看原始查询，请启用“Raw”开关。

常见问题

如何将仪表盘从 Prometheus 数据源转换为 VictoriaMetrics 数据源？

确保 VictoriaMetrics 数据源插件已安装，并且已通过该插件创建了一个新的数据源。

在编辑模式下，Grafana 仪表盘的每个面板都有一个数据源下拉菜单。只需在下拉菜单中选择 VictoriaMetrics 数据源而不是 Prometheus 数据源即可。

如果数据源通过 Grafana 变量配置，则将变量类型更改为 VictoriaMetrics 数据源。

为什么 VictoriaMetrics 数据源不支持告警？

对于非 Prometheus 或 Loki 类型的插件，Grafana 不允许将告警请求转发到告警 API /api/v1/rules。在此处查看更多详情。

许可证

本项目根据 AGPL-3.0-only 许可协议获得授权。

在 Grafana Cloud 上安装 VictoriaMetrics

欲了解更多信息，请访问关于插件安装的文档。

更新日志

提示

v0.14.0

功能：在查询构建器中自动转义指标和标签名称。请参阅此 issue。
错误修复：修复了 vmui 链接地址不正确（类型为 about:blank）的问题。请参阅此 issue。
错误修复：修复了对齐查询间隔时，选定时间范围发生变化的问题。请参阅#275。

v0.13.4

错误修复：修复了响应被检测为非宽系列时出现的错误。请参阅此 issue。
错误修复：修复了点击刷新按钮时检查器查询的问题。感谢 @yincongcyincong 提交的pull request。

v0.13.3

错误修复：正确计算即时查询的步长，如果用户未明确设置间隔，则对告警查询使用 5 分钟步长。此更改减少了 Grafana 托管告警的抖动。请参阅此 issue。

v0.13.2

错误修复：如果用户未明确设置间隔，则对告警查询使用 5 分钟步长。此更改减少了 Grafana 托管告警的抖动。请参阅此 issue。

v0.13.1

错误修复：清理插件的 README.md 文件。阐明如何发布。请参阅此 PR。

v0.13.0

功能：为新版本启用插件签名流程。请参阅此 PR 和此 PR。

v0.12.2

功能：更改本地存储键名，以避免与其他系统冲突。请参阅此 PR。
错误修复：在插件验证过程后清理插件代码库。请参阅此 PR 和此 PR。

v0.12.1

错误修复：修复了构建中包含 lezer-metricsql 包和修复公共文件夹的问题。请参阅此 PR。
错误修复：修复了编辑器中查询格式化时插件加载的问题。请参阅此 issue。
错误修复：修复了“美化查询”功能损坏仪表盘 JSON 模型的问题。请参阅此 issue。

v0.12.0

⚠️ 破坏性变更：插件 ID 已更新
更新说明 1
在新版本的插件中，插件 ID 已更新。新的插件 ID 为 victoriametrics-metrics-datasource。这是一个破坏性变更：Grafana 将其视为一个新插件。

您必须更新 grafana.ini 或 defaults.ini 配置文件中的 allow_loading_unsigned_plugins 字段。
示例
```
allow_loading_unsigned_plugins = victoriametrics-metrics-datasource  
```
如果您正在使用 Provisioning，请将 Provisioning 配置中的 type 字段更新为 victoriametrics-metrics-datasource。
进行这些更改后，您必须重启 Grafana 服务器以使更新生效。

功能：在签名过程审查后，将插件 ID 名称更新为 victoriametrics-metrics-datasource。请参阅此 issue。

v0.11.1

错误修复：修复了发布文件的校验和计算问题。

v0.11.0

功能：在“收到意外的响应状态码”错误消息中包含请求 URL，以便进行故障排除。感谢 @chenlujjj 提交的pull request。
错误修复：修复了变量在即时过滤器中不起作用的问题。请参阅此 issue。
错误修复：修复了在 Grafana 中创建告警时查询类型切换的问题。请参阅此 issue

v0.10.3

错误修复：修复了在面板中使用多个可见查询时查询加载的问题。请参阅此 issue。
错误修复：修复了在指标浏览器中选择指标时转义的问题。请参阅此 issue。
错误修复：修复了注解查询中步长计算不正确的问题。请参阅此 issue。

v0.10.2

错误修复：修复了点击刷新按钮时检查器查询的问题。请参阅此 issue。感谢 @yincongcyincong 提交的pull request。
错误修复：修复了在表格视图中显示美化请求后的值的问题。请参阅此 issue。感谢 @yincongcyincong 提交的pull request。

v0.10.1

错误修复：修复了健康检查

v0.10.0

功能：创建告警规则时，将默认查询类型设置为 instant。请参阅此 issue。
错误修复：移除了 /health 端点请求路径中的 /select/ 前缀部分。请参阅此 issue。

v0.9.1

错误修复：修复了查询构建器中 label_values 函数解析点的问题。请参阅此 issue。感谢 @yincongcyincong 提交的pull request。

v0.9.0

功能：如果返回错误是临时网络错误，则对数据源请求进行重试。请参阅此 issue

v0.8.5

错误修复：恢复对低于 10.0.0 的 Grafana 版本的支持。请参阅此 issue。
错误修复：修复了将请求头从数据源转发到后端或代理时的问题。如果用户想使用某种认证方式，这可能会有所帮助。请参阅此 issue。

v0.8.4

错误修复：修复了构建器模式下的标签连接功能问题。请参阅此 issue。感谢 @yincongcyincong 提交的pull request。
错误修复：将缺失的聚合函数添加到构建器建议列表中。请参阅此 issue。感谢 @yincongcyincong 提交的pull request。
错误修复：正确应用即时过滤器到某些聚合函数。请参阅此 issue。感谢 @yincongcyincong 提交的pull request。

v0.8.3

错误修复：修复了如果查询在后向窗口中包含 Grafana 变量时，美化查询的问题。请参阅此 issue。
错误修复：修复了即时过滤器应用于查询变量时的问题。请参阅此 issue。感谢 @yincongcyincong 提交的pull request。

v0.8.2

错误修复：修复了查询构建器解析带有特殊字符的标签名称的问题。请参阅此 issue。

v0.8.1

错误修复：修复了模板变量服务中访问 undefined 的 datasource 属性导致失败的问题。请参阅此 issue。

v0.8.0

功能：添加变量类型选择器以优化 API 使用，优先使用 /api/v1/labels 和 /api/v1/label/.../values 而非 /api/v1/series。请参阅此 issue
错误修复：在使用模板变量时正确解析注解查询。请参阅此 issue

v0.7.0

功能：视觉上高亮显示部分响应。请参阅此 issue
错误修复：修正带有特殊字符的指标的标签过滤器和指标浏览器查询。请参阅此 issue

v0.6.0

功能：在查询构建器中添加对带有特殊字符的指标的支持。请参阅此 issue
错误修复：修复了 vmui 的默认链接。请参阅此 issue
错误修复：修复了 renderLegendFormat 中的解析逻辑，以正确替换图例标签名称。请参阅此 issue
错误修复：修复了查询编辑器在评估告警规则时产生大量请求的问题。请参阅此 issue

v0.5.1

错误修复：修复了查询构建器解析带有点的指标名称的逻辑。请参阅此 issue

v0.5.0

功能：添加对后端插件的 Windows 支持。在此处查看如何在各种平台构建后端插件。请参阅此 issue。
功能：迁移到 React，以避免关于停止支持 Angular 的警告。请参阅此 issue。
功能：为后端数据源二进制文件添加 --version 标志。请参阅此 issue。
功能：添加关于为尚未创建的仪表盘使用 WITH 模板的警告窗口。请参阅此 issue。
功能：为 Explore 标签页添加一个单独的范围来存储 WITH 模板。
错误修复：修复了在查询编辑器中切换代码/构建器模式时解析不正确的问题。请参阅此 issue

v0.4.0

功能：添加数据源设置，用于限制发现过程中的指标数量。适当的限制应该能保护用户在数据源返回大量发现指标时浏览器不会变慢。请参阅此 issue。
功能：添加一个“美化查询”图标，点击该图标即可格式化查询。请参阅此 issue。
功能：将“WITH 模板”和“在 vmui 中运行”按钮的样式更改为图标。
错误修复：正确处理注解查询中的自定义查询参数。请参阅此 issue
错误修复：修复了使用表达式时图例中标签重复的问题。请参阅此 issue
错误修复：修复了指标浏览器中加载指标的问题。请参阅此 issue
错误修复：修复了 metricsql 函数未正确处理的问题。请参阅此 issue

v0.3.0

功能：WITH 模板改进 (请参阅此评论)
- WITH 模板的管理已从数据源设置迁移到面板编辑页面；
- 改进了自动补全提示中模板的显示；
- 启用了模板中定义的过滤器的花括号内自动补全功能；
- 在 WITH 表达式验证中添加了对 Grafana 变量（例如 $__interval、$__rate_interval 等）的支持；
- 修复了使用 WITH 模板时 vmui 的链接问题。