将 Hubot 集成到 Grafana

Grafana Labs Team
Grafana Labs 团队

上次更新于 2023 年 11 月 2 日

高级

简介

Grafana 2.0 推出了一个很棒的功能，它可以让 Grafana 将任何图表或面板渲染成 PNG 图像。

无论您使用什么数据源，图表的 PNG 图像看起来都与浏览器中的一样。

本指南将向您展示如何安装和配置 Hubot-Grafana 插件。此插件允许您告诉 Hubot 直接从 Slack、Basecamp 或任何其他受支持的 Hubot 适配器中的频道渲染任何仪表盘或图表。机器人将以图表的图像和一个指向该图表的链接作为响应。

什么是 Hubot？

Hubot 是一款通用且可扩展的聊天机器人，可用于许多聊天服务，并拥有大量的第三方插件库，允许您自动化聊天室中的任何操作。

安装 Hubot

Hubot 非常易于安装和托管。如果您还没有运行机器人，请阅读官方的 Hubot 入门指南。

安装 Hubot-Grafana 脚本

在您的 Hubot 项目存储库中，使用 npm 安装 Grafana 插件

bash 
npm install hubot-grafana --save

编辑文件 external-scripts.json，并将 hubot-grafana 添加到插件列表中。

json 
["hubot-pugme", "hubot-shipit", "hubot-grafana"]

配置

Hubot-Grafana 插件需要设置两个环境变量才能正常工作。

bash 
export HUBOT_GRAFANA_HOST=https://play.grafana.org
export HUBOT_GRAFANA_API_KEY=abcd01234deadbeef01234

您可以设置 其他环境变量 来控制图表的显示。

Grafana 服务器端渲染

hubot 插件将利用 Grafana 服务器端渲染功能，该功能可以使用 phantomjs 在服务器上渲染任何面板。Grafana 附带 phantomjs 二进制文件（仅限 Linux）。

要验证此功能是否有效，请尝试面板共享对话框中的“渲染图像的直接链接”链接。如果打开此链接时未获得图像，请验证是否已安装 phantomjs 工作所需的字体包。

Grafana API 密钥

您需要将环境变量 HUBOT_GRAFANA_API_KEY 设置为 Grafana API 密钥。您可以从“组织”下拉菜单中找到的“API 密钥”页面添加这些密钥。

图像上传

有几种上传渲染图的方法。如果您使用的是 Slack、Rocket.Chat 或 Telegram，适配器的本机上传器将负责通过其各自的 API 发送它。如果您的 Hubot 托管在不支持上传的平台（例如 IRC）上，则可以使用 内置的 S3 上传器。请注意，如果您配置了 S3，它将不会使用适配器的上传功能。

Hubot 命令

  • hubot graf list
    • 列出可用的仪表盘
  • hubot graf db graphite-carbon-metrics
    • 绘制仪表盘中的所有面板
  • hubot graf db graphite-carbon-metrics:3
    • 仅绘制特定仪表盘中 ID 为 3 的面板
  • hubot graf db graphite-carbon-metrics:cpu
    • 仅绘制标题中包含“cpu”（不区分大小写）的面板
  • hubot graf db graphite-carbon-metrics now-12hr
    • 获取一个时间窗口为 12 小时前的仪表盘
  • hubot graf db graphite-carbon-metrics now-24hr now-12hr
    • 获取一个时间窗口为 24 小时前到 12 小时前的仪表盘
  • hubot graf db graphite-carbon-metrics:3 now-8d now-1d
    • 仅获取特定仪表盘的第三个面板，时间窗口为 8 天前到昨天
  • hubot graf db graphite-carbon-metrics host=carbon-a
    • 获取一个带模板的仪表盘，其中 $host 参数设置为 carbon-a

别名

上面的一些 hubot 命令可能很长，您可能需要记住仪表盘的 slug（URL ID）。如果您有一些想经常查看的最喜欢的图表（例如，从您的手机上查看），您可以使用 hubot 脚本 hubot-alias 创建 hubot 命令别名。

安装它

bash 
npm i --save hubot-alias

现在将 hubot-alias 添加到 external-scripts.json 中的插件列表中，并重新启动 hubot。

现在您可以添加如下别名

  • hubot alias graf-lb=graf db loadbalancers:2 now-20m

总结

Grafana 将来会自带集成的 Slack 和 Hipchat 功能，但您不必等待。Grafana 2 推出了一个非常巧妙的服务器端渲染功能，可以使用 phantomjs 将任何面板渲染成 png。Grafana 的 hubot 插件是您可以立即安装和使用的！