向 GitHub 支持提供数据

关于诊断文件和支持包

为帮助排查环境中 GitHub Enterprise Server 实例的问题，GitHub 支持可能会请求一种或多种类型的数据。

数据	文件格式	说明
诊断文件	纯文本	包含有关实例设置和环境的信息。
支持捆绑包	存档	包含过去两天（默认）的诊断文件和经过清理的日志文件。
外延支持捆绑包	存档	包含过去八天的诊断文件和经过清理的日志文件。

关于日志文件清理

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

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 访问权限，则可以从管理控制台创建诊断文件。

在 GitHub Enterprise Server 上的管理帐户中，在任一页面的右上角，单击。
如果你尚未在“站点管理员”页上，请在左上角单击“站点管理员”。
在“ 站点管理”边栏中，单击“管理控制台”。
如果你创建了多个管理控制台用户帐户，请选择“根站点管理员”或“管理控制台用户” 。有关管理控制台用户帐户的详细信息，请参阅“管理对管理控制台的访问”。
输入你的管理控制台凭据。然后单击“继续”。
在顶部导航栏中，单击“支持”。
单击“下载诊断信息”。

使用 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/：GitHub Enterprise Server 配置日志
collectd/logs/collectd.log：收集的日志
mail-logs/mail.log：SMTP 电子邮件传递日志

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

支持包默认包含过去两天的日志。可以以天为单位指定确切的时段。若要提供过去八天的日志，可以下载外延支持包。有关详细信息，请参阅“创建和共享扩展支持包”。

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

从管理控制台创建支持包

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

在 GitHub Enterprise Server 上的管理帐户中，在任一页面的右上角，单击。
如果你尚未在“站点管理员”页上，请在左上角单击“站点管理员”。
在“ 站点管理”边栏中，单击“管理控制台”。
如果你创建了多个管理控制台用户帐户，请选择“根站点管理员”或“管理控制台用户” 。有关管理控制台用户帐户的详细信息，请参阅“管理对管理控制台的访问”。
输入你的管理控制台凭据。然后单击“继续”。
在顶部导航栏中，单击“支持”。
单击“下载支持包”。
如果支持工程师为你提供了支持包的上传链接，请使用此链接。否则，请访问 https://support.github.com/ 并登录有权获得支持的企业帐户（如果出现提示）。
访问 https://support.github.com/uploads 并上传支持捆绑包。

使用 SSH 创建支持包

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

注意：如果你的 GitHub Enterprise Server 实例采用异地复制配置，或者实例是群集，则应使用 ghe-cluster-support-bundle 命令检索支持包。有关详细信息，请参阅“命令行实用程序”。

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

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

导航至 GitHub Enterprise Cloud。
在 GitHub 的右上角，单击你的个人资料照片，然后单击“你的企业”****。
在企业列表中，单击您想要查看的企业。
在页面左侧的企业帐户边栏中，单击 “设置”。
在 “设置”下，单击“许可证”。
在“GitHub Enterprise 帮助”下，单击“上传支持包”。
在“选择企业帐户”下，使用下拉菜单选择支持包的关联帐户。
在“为 GitHub Enterprise 支持上传支持包”下，选择你的支持包，单击“选择文件”，或将你的支持包文件拖到“选择文件” 。
单击“上载” 。

使用 SSH 直接上传支持包

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

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

将包上传到我们的支持包服务器：

ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u'

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

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

使用 SSH 创建扩展支持包

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

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

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