Grafana 配置

Grafana 是一种工具，可让您通过图表和仪表盘可视化时间序列指标。极狐GitLab 将性能数据写入 Prometheus，Grafana 允许您查询数据，来显示有用的图表。

安装

Omnibus GitLab 可以帮助您安装 Grafana（推荐），或使用 Grafana 提供的便于安装的包仓库（Yum/Apt）。 有关详细步骤，请参阅 Grafana 安装文档。

在第一次启动 Grafana 之前，在 /etc/grafana/grafana.ini 中设置管理员用户和密码。如果没有，默认密码是admin。

配置

  1. 以管理用户身份登录 Grafana。
  2. 从 Configuration 菜单中选择 Data Sources。
  3. 选择 Add data source 按钮。
  4. 选择所需的数据源类型。例如，Prometheus。
  5. 填写数据源的详细信息，然后选择 Save & Test 按钮。

Grafana 应指示数据源正在工作。

导入仪表盘

您现在可以导入一组默认 Grafana 仪表盘来开始显示有用的信息：

  1. 克隆仓库，或下载 ZIP 文件，或 tarball。

  2. 按照以下步骤分别导入每个 JSON 文件：

    1. 以管理员用户身份登录 Grafana。
    2. 从 Dashboards 菜单中选择 Manage。
    3. 选择 Import 按钮，然后选择 Upload JSON file 按钮。
    4. 找到要导入的 JSON 文件并选择 Choose for Upload。 选择 Import 按钮。
    5. 仪表盘导入后，选择顶部栏中的 Save dashboard 图标。

如果您在导入后不保存仪表盘，则当您离开页面时，仪表盘将被删除。对要导入的每个仪表盘重复此过程。

或者，您可以将所有仪表盘导入您的 Grafana 实例。有关此流水线的更多信息，请参阅 Grafana 仪表板的自述文件 仓库。

与 GitLab UI 集成

设置 Grafana 后，您可以启用链接，从极狐GitLab 侧边栏中轻松访问它：

  1. 在顶部栏上，选择 主菜单 > 管理员。
  2. 在左侧边栏中，选择 设置 > 指标与分析 并展开 指标 - Grafana。
  3. 选择 添加链接到 Grafana 复选框。
  4. 配置 Grafana URL：
    • 如果 Grafana 通过 Omnibus GitLab 在同一服务器上启用，保持 Grafana URL 不变，应该是/-/grafana。
    • 否则，输入 Grafana 实例的完整 URL。
  5. 选择 保存修改。

极狐GitLab 在 主菜单 > 管理员 > 监控 > 指标仪表盘 中显示您的链接。

所需范围

引入于 13.10 版本

通过上述流程设置 Grafana 时，在 主菜单 > 管理员 > 应用 > GitLab Grafana 的页面中不会显示任何范围。但是，read_user 范围是必需的，并且会自动提供给应用。当您尝试使用极狐GitLab 作为 OAuth provider 登录时，设置除 read_user 以外的任何范围而不包括 read_user 会导致此错误： 

The requested scope is invalid, unknown, or malformed.

如果您看到此错误，请确保在 GitLab Grafana 配置页面中满足以下条件之一：

  • 没有范围出现。
  • 包括 read_user 范围。

13.10 之前的版本使用 API 范围而不是 read_user。在 13.10 之前的 GitLab 版本中，API 范围：

  • 需要通过 GitLab OAuth provider 访问 Grafana。
  • 通过启用 Grafana 应用程序进行设置，如与 GitLab UI 集成文档中所示。