菜单
文档breadcrumb arrow Grafana 文档breadcrumb arrow 故障排除breadcrumb arrow 将支持包发送给支持
Grafana Cloud Enterprise 开源

将支持包发送给 Grafana Labs 支持

当您的 Grafana 实例遇到问题时，您可以向我们发送一个支持包，其中包含有关您的 Grafana 实例的信息，包括：

  • Grafana 版本
  • 已安装插件
  • Grafana 配置
  • 已部署的数据库信息和迁移记录

注意：支持包适用于运行 Grafana 9.5 及更高版本的实例。

可用的支持包组件

支持包可以包含以下任何组件：

  • 使用统计信息：Grafana 实例的使用统计信息
  • 用户信息：Grafana 实例的用户列表
  • 数据库和迁移信息：数据库信息和迁移日志
  • 插件信息：Grafana 实例的插件信息
  • 基本信息：关于 Grafana 实例的基本信息（版本、内存使用等）
  • 设置：Grafana 实例的设置
  • SAML：SAML 的健康检查连接和元数据（仅在启用 SAML 时显示）
  • LDAP：LDAP 的健康检查连接和元数据（仅在启用 LDAP 时显示）
  • OAuth2：每个 OAuth2 提供商支持者的健康检查连接和元数据（仅在启用 OAuth 提供商时显示）

开始之前

要按照这些说明操作，您需要以下权限：

  • 在 Grafana Cloud 中，您需要组织管理员角色。

  • 在本地部署的 Grafana 中，您需要 Grafana 服务器管理员角色。

    请注意，您可以将 server_admin_only 配置选项设置为 false，以允许组织管理员在本地部署的 Grafana 中访问支持包。

步骤

要生成支持包并通过支持工单将其发送给 Grafana Labs：

  1. 点击帮助图标。

  2. 点击支持包。

    Support bundle panel

  3. 点击新建支持包。

  4. 选择您想要包含在支持包中的组件。

  5. 点击创建。

  6. 支持包准备就绪后，点击下载。

    Grafana 会将支持包下载为归档（tar.gz）文件。

  7. 将该归档（tar.gz）文件附加到您发送给 Grafana Labs 技术支持的工单中。

支持包配置

您可以在 Grafana 配置文件中配置支持包的以下设置：

ini 
[support_bundles]
# Enable support bundle creation (default: true)
enabled = true
# Only server admins can generate and view support bundles. When set to false, organization admins can generate and view support bundles (default: true)
server_admin_only = true
# If set, bundles will be encrypted with the provided public keys separated by whitespace
public_keys = ""

加密支持包

支持包可以在发送给接收方之前使用 age 进行加密。当您想通过非私密通道向 Grafana 发送支持包时，这会很有用。

生成密钥对

确保您的系统上已安装 age。

bash 
$ age-keygen -o key.txt
Public key: age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p

支持包加密

确保您的系统上已安装 age。

将公钥添加到 Grafana 配置文件的 support_bundle 部分的 public_keys 设置中。

ini 
[support_bundles]
public_keys = "age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p"

可以通过用空格分隔来定义多个公钥。所有包含的公钥都将能够解密支持包。

示例

ini 
[support_bundles]
public_keys = "age1ql3z7hjy54pw3hyww5ayyfg7zqgvc7w3j2elw8zmrj2kg5sfn9aqmcac8p age1yu8vzu554pv3klw46yhdv4raz36k5w3vy30lpxn46923lqngudyqvxacer"

当您重启 Grafana 后，新的支持包将使用提供的公钥进行加密。支持包的文件扩展名为 tar.gz.age。

解密支持包

确保您的系统上已安装 age。

执行以下命令解密支持包：

bash 
age --decrypt -i keyfile -o output.tar.gz downloaded.tar.gz.age

示例

bash 
age --decrypt -i key.txt -o data.tar.gz af6684b4-d613-4b31-9fc3-7cb579199bea.tar.gz.age