将数据提供给 GitHub Support

About diagnostic files and support bundles

GitHub 支持 may ask you to provide additional data in the form of sanitized log files. There are three types of log file you may be asked to provide.

Diagnostic files contain information about a GitHub Enterprise Server instance's settings and environment, support bundles contain diagnostics and logs from the past two days, and extended support bundles also contain diagnostics and logs but from the past seven days.

About log file sanitization

Authentication tokens, keys, and secrets are removed from log files in the following log directories contained within a support bundle or diagnostics file:

• 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

创建和共享诊断文件

Diagnostic files are an overview of a GitHub Enterprise Server instance's settings and environment that contains:

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

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

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

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

1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

3. 在左侧边� �中，单击 管理控制台。

4. 如有提示，请输入您的 管理控制台 密� �。

5. 在 管理控制台 右上侧，单击 Support（支持）。

6. 单击 Download diagnostics info。

使用 SSH 创建诊断文件

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

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

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

创建和共享支持包

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

• 在对身份验证错误进行故障排查或者配置 LDAP、CAS 或 SAML 时，与身份验证相关的日志可能会十分有用
• 管理控制台 日志
• github-logs/exceptions.log：关于站点上遇到的 500 个错误的信息
• github-logs/audit.log：GitHub 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：Collectd 日志
• mail-logs/mail.log：SMTP 电子邮件交付日志

更多信息请参阅“审� �日志”。

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

从 管理控制台 创建支持包

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

1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

3. 在左侧边� �中，单击 管理控制台。

4. 如有提示，请输入您的 管理控制台 密� �。

5. 在 管理控制台 右上侧，单击 Support（支持）。

6. 单击 Download support bundle。

7. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support.

8. 访问 https://support.github.com/uploads 并上� 您的支持包。

使用 SSH 创建支持包

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

1. 通过 SSH 下载支持包：

   $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz

   有关 ghe-support-bundle 命令的更多信息，请参阅“命令行实用程序”。
2. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support.
3. 访问 https://support.github.com/uploads 并上� 您的支持包。

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

1. 导航至 GitHub.com。

2. 在 GitHub.com 的右上角，单击您的个人资料照片，然后单击 Your enterprises（您的企业）。

3. 在企业列表中，单击您想要查看的企业。

4. 在企业帐户侧边� �中，单击 Settings（设置）。

5. 在左侧边� �中，单击 Enterprise licensing（企业许可）。

6. 在“GitHub Enterprise 帮助”下，单击 Upload a support bundle（上� 支持包）。

7. 在“Select an enterprise account（选择企业帐户）”下，从下拉菜单选择支持包的相关帐户。

8. 在“为 GitHub Enterprise 支持 上� 支持包”下，选择您的支持包，单击 Choose file（选择文件），或将您的支持包文件拖到 Choose file（选择文件）上。

9. 单击 Upload（上� ）。

使用 SSH 直接上� 支持包

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

• 您可以通过 SSH 访问 your GitHub Enterprise Server instance。
• 通过 TCP 端口 443 的出站 HTTPS 连接允许从 your GitHub Enterprise Server instance 到 enterprise-bundles.github.com 和 esbtoolsproduction.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. 要通过 SSH 下载扩展支持包，可将 -x � �记添� 到 ghe-support-bundle 命令中：

   $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o -x' > support-bundle.tgz

2. If a support engineer has given you an upload link for your support bundle, use this link. Otherwise, visit https://support.github.com/ and sign in (if prompted) to an enterprise account that is entitled to support.
3. 访问 https://support.github.com/uploads 并上� 您的支持包。

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

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

• 您可以通过 SSH 访问 your GitHub Enterprise Server instance。
• 通过 TCP 端口 443 的出站 HTTPS 连接允许从 your GitHub Enterprise Server instance 到 enterprise-bundles.github.com 和 esbtoolsproduction.blob.core.windows.net。

1. 将包上� 到我们的支持包服务器：

   $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x'

延伸阅读

• "About GitHub Support"
• "Generating a Health Check for your enterprise"