Skip to main content

向 GitHub 支持提供数据

由于 GitHub 支持 无法访问环境,因此有时需要你提供一些额外的信息。

关于诊断文件和支持包

GitHub 支持 可能会要求以清理日志文件的形式提供其他数据。 可能需要提供三种类型的日志文件。

诊断文件包含有关 GitHub Enterprise Server 实例的设置和环境的信息,支持包包含过去两天的诊断和日志,而扩展支持包还包含诊断和日志,但仅限于过去七天。

关于日志文件清理

身份验证令牌、密钥和机密将从支持包或诊断文件中包含的以下日志目录中的日志文件中删除:

  • alambic-logs
  • babeld-logs
  • codeload-logs
  • enterprise-manage-logs
  • github-logs
  • hookshot-logs
  • lfs-server-logs
  • semiotic-logs
  • task-dispatcher-logs
  • pages-logs
  • registry-logs
  • render-logs
  • svn-bridge-logs

创建和共享诊断文件

诊断文件是 GitHub Enterprise Server 实例的设置和环境的概述,其中包含:

  • 客户端许可信息,包括公司名称、到期日期和用户许可数量
  • 版本号和 SHA
  • VM 架构
  • 主机名、私有模式、SSL 设置
  • 加载和处理列表
  • 网络设置
  • 身份验证方法和详情
  • 仓库、用户和其他安装数据的数量

可以从 管理控制台 或通过运行 ghe-diagnostics 命令行实用程序下载实例的诊断。

从 管理控制台 创建诊断文件

如果您没有随时可用的 SSH 密钥,则可以使用此方法。

  1. 从 GitHub Enterprise Server 上的管理帐户任意页面的右上角,单击

    用于访问站点管理员设置的火箭图标的屏幕截图

  2. 如果你尚未在“站点管理员”页上,请在左上角单击“站点管理员”。

    “站点管理员”链接的屏幕截图 1. 在左侧边栏中,单击“管理控制台”。 左侧边栏中的 管理控制台 选项卡 1. 如有提示,请输入您的 管理控制台 密码。 管理控制台 解锁屏幕 4. 在 管理控制台 的右上角,单击“支持”。 用于访问支持区域的按钮

  3. 单击“下载诊断信息”。

使用 SSH 创建诊断文件

您无需登录 管理控制台 即可使用此方法。

使用 ghe-diagnostics 命令行实用程序检索实例的诊断。

$ ssh -p122 admin@hostname -- 'ghe-diagnostics' > diagnostics.txt

创建和共享支持包

您提交支持请求后,我们可能会要求您与我们团队共享支持包。 支持包是一个 gzip 压缩的 tar 存档,其中包含来自您的实例的诊断和重要日志,例如:

  • 在对身份验证错误进行故障排查或者配置 LDAP、CAS 或 SAML 时,与身份验证相关的日志可能会十分有用
  • 管理控制台 日志
  • github-logs/exceptions.log:关于站点上遇到的 500 个错误的信息
  • github-logs/audit.logGitHub Enterprise Server 审核日志
  • babeld-logs/babeld.log:Git 代理日志
  • system-logs/haproxy.log:HAProxy 日志
  • elasticsearch-logs/github-enterprise.log:Elasticsearch 日志
  • configuration-logs/ghe-config.log:GitHub Enterprise Server 配置日志
  • collectd/logs/collectd.log:收集的日志
  • mail-logs/mail.log:SMTP 电子邮件传递日志

有关详细信息,请参阅“关于你企业的审核日志”。

支持包包含过去两天的日志。 要获取过去七天的日志,您可以下载扩展支持包。 有关详细信息,请参阅“创建和共享扩展支持包”。

提示: 联系 GitHub 支持 时,你将收到一封确认电子邮件,其中包含票证参考链接。 如果 GitHub 支持 要求您上传支持包,则可以使用事件单参考链接来上传支持包。

从 管理控制台 创建支持包

如果您可以访问基于 web 的 管理控制台 并具有出站互联网访问权限,则可以使用下列步骤来创建和共享支持包。

  1. 从 GitHub Enterprise Server 上的管理帐户任意页面的右上角,单击

    用于访问站点管理员设置的火箭图标的屏幕截图

  2. 如果你尚未在“站点管理员”页上,请在左上角单击“站点管理员”。

    “站点管理员”链接的屏幕截图 1. 在左侧边栏中,单击“管理控制台”。 左侧边栏中的 管理控制台 选项卡 1. 如有提示,请输入您的 管理控制台 密码。 管理控制台 解锁屏幕 4. 在 管理控制台 的右上角,单击“支持”。 用于访问支持区域的按钮

  3. 单击“下载支持包”。

  4. 如果支持工程师为你提供了支持包的上传链接,请使用此链接。 否则,请访问 https://support.github.com/ 并登录有权获得支持的企业帐户(如果出现提示)。 1. 访问 https://support.github.com/uploads 并上传支持捆绑包。

使用 SSH 创建支持包

如果您可以通过 SSH 访问 your GitHub Enterprise Server instance 并且拥有出站互联网访问权限,则可以使用下列步骤来创建和共享支持包。

注意:如果使用的是异地复制配置,或 GitHub Enterprise 群集,则应使用 ghe-cluster-support-bundle 命令检索支持包。 有关详细信息,请参阅“命令行实用工具”。

  1. 通过 SSH 下载支持包:
    $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz
    有关 ghe-support-bundle 命令的详细信息,请参阅“命令行实用工具”。
  2. 如果支持工程师为你提供了支持包的上传链接,请使用此链接。 否则,请访问 https://support.github.com/ 并登录有权获得支持的企业帐户(如果出现提示)。 1. 访问 https://support.github.com/uploads 并上传支持捆绑包。

使用您的企业帐户上传支持包

  1. 导航到 GitHub.com。

  2. 在 GitHub.com 的右上角,单击你的个人资料照片,然后单击“你的企业”。 GitHub Enterprise Server 上个人资料照片下拉菜单中的“你的企业”

  3. 在企业列表中,单击您想要查看的企业。 企业列表中的企业名称 1. 在企业帐户侧边栏中,单击 “设置”。 企业帐户侧边栏中的“设置”选项卡

  4. 在左侧边栏中,单击“企业许可”。 显示企业帐户设置侧边栏中的“企业许可”链接的屏幕截图。

  5. 在“GitHub Enterprise 帮助”下,单击“上传支持包”。 显示“上传支持包链接”的屏幕截图。

  6. 在“Select an enterprise account(选择企业帐户)”下,从下拉菜单选择支持包的相关帐户。 显示下拉菜单的屏幕截图,用于选择支持包的企业帐户。

  7. 在“为 GitHub Enterprise 支持 上传支持包”下,选择你的支持包,单击“选择文件”,或将你的支持包文件拖到“选择文件” 。 显示“选择文件”按钮的屏幕截,用于上传支持包文件。

  8. 单击“上载” 。

使用 SSH 直接上传支持包

在以下情况下您可以直接将支持包上传到我们的服务器:

  • 您可以通过 SSH 访问 your GitHub Enterprise Server instance。
  • 通过 TCP 端口 443 的出站 HTTPS 连接允许从 your GitHub Enterprise Server instance 连接到 enterprise-bundles.github.comesbtoolsproduction.blob.core.windows.net
  1. 将包上传到我们的支持包服务器:
    $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u'

创建和共享扩展支持包

支持包包括过去两天的日志,而扩展支持包包括过去七天的日志。 如果 GitHub 支持 调查的事件发生在两天之前,我们可能会要求您分享扩展支持包。 需要 SSH 权限才能下载扩展包 - 不能从 管理控制台 下载扩展包。

为避免体积变得太大,支持包只包含尚未轮换和压缩的日志。 关于 GitHub Enterprise Server 上的日志轮换,可针对不同的日志文件设置不同的频率(每日或每周),具体取决于我们期望的日志大小。

使用 SSH 创建扩展支持包

如果您可以通过 SSH 访问 your GitHub Enterprise Server instance 并有拥有出站互联网访问权限,则可以使用下列步骤来创建和共享扩展支持包。

  1. -x 标记添加到 ghe-support-bundle 命令,通过 SSH 下载扩展支持包:
    $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o -x' > support-bundle.tgz
  2. 如果支持工程师为你提供了支持包的上传链接,请使用此链接。 否则,请访问 https://support.github.com/ 并登录有权获得支持的企业帐户(如果出现提示)。 1. 访问 https://support.github.com/uploads 并上传支持捆绑包。

使用 SSH 直接上传扩展支持包

在以下情况下您可以直接将支持包上传到我们的服务器:

  • 您可以通过 SSH 访问 your GitHub Enterprise Server instance。
  • 通过 TCP 端口 443 的出站 HTTPS 连接允许从 your GitHub Enterprise Server instance 连接到 enterprise-bundles.github.comesbtoolsproduction.blob.core.windows.net
  1. 将包上传到我们的支持包服务器:
    $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x'

延伸阅读