将数据提供给 GitHub Support
由于 GitHub 支持 无法访问您的环境,因此我们需要您提供一些附加信息。
本文内容
创建和共享诊断文件
诊断是 GitHub Enterprise Server 实例的设置和环境的概览,其中包含:
- 客户端许可信息,包括公司名称、到期日期和席位数
- 版本号和 SHA
- VM 架构
- 主机名、私有模式、SSL 设置
- 加载和处理列表
- 网络设置
- 身份验证方法和详情
- 仓库、用户和其他安装数据的数量
您可以从 管理控制台 或通过运行 ghe-diagnostics
命令行实用程序下载实例的诊断。
从 管理控制台 创建诊断文件
如果您没有随时可用的 SSH 密钥,则可以使用此方法。
-
在任何页面的右上角,单击 。
-
在左侧边栏中,单击 管理控制台。
-
如有提示,请输入您的 管理控制台 密码。
-
在 管理控制台 右上侧,单击 Support(支持)。
-
单击 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 电子邮件交付日志hookshot-logs/exceptions.log
:Web 挂钩交付错误
更多信息请参阅“审核日志”。
支持包包含过去两天的日志。 要获取过去七天的日志,您可以下载扩展支持包。 更多信息请参阅“创建和共享扩展支持包”。
提示:当您联系 GitHub 支持 时,您将收到一封确认电子邮件,其中包含事件单参考链接。 如果 GitHub 支持 要求您上传支持包,则可以使用事件单参考链接来上传支持包。
从 管理控制台 创建支持包
如果您可以访问基于 web 的 管理控制台 并具有出站互联网访问权限,则可以使用下列步骤来创建和共享支持包。
-
在任何页面的右上角,单击 。
-
在左侧边栏中,单击 管理控制台。
-
如有提示,请输入您的 管理控制台 密码。
-
在 管理控制台 右上侧,单击 Support(支持)。
-
单击 Download support bundle。
-
访问 https://enterprise.github.com/support 并登录(如果提示)。
-
访问 https://enterprise.github.com/support/bundles/new 并上传您的支持包。
使用 SSH 创建支持包
如果您可以通过 SSH 访问 GitHub Enterprise Server 设备并具有出站互联网访问权限,则可以使用下列步骤来创建和共享支持包。
注:如果您使用的是 Geo-replication 配置或 GitHub Enterprise 集群,则应使用 ghe-cluster-support-bundle
命令检索支持包。 更多信息请参阅“命令行实用程序”。
-
通过 SSH 下载支持包:
$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz
有关
ghe-support-bundle
命令的更多信息,请参阅“命令行实用程序”。 -
访问 https://enterprise.github.com/support 并登录(如果提示)。
-
访问 https://enterprise.github.com/support/bundles/new 并上传您的支持包。
使用 SSH 直接上传支持包
在以下情况下您可以直接将支持包上传到我们的服务器:
- 您可以通过 SSH 访问 GitHub Enterprise Server 设备。
- 允许从 GitHub Enterprise Server 设备通过 TCP 端口 443 建立出站 HTTPS 连接。
-
将包上传到我们的支持包服务器:
$ ssh -p122 admin@hostname -- 'ghe-support-bundle -u'
创建和共享扩展支持包
支持包包括过去两天的日志,而扩展支持包包括过去七天的日志。 如果 GitHub 支持 调查的事件发生在两天之前,我们可能会要求您分享扩展支持包。 需要 SSH 权限才能下载扩展包 - 不能从 管理控制台 下载扩展包。
为避免体积变得太大,支持包只包含尚未轮换和压缩的日志。 关于 GitHub Enterprise Server 上的日志轮换,可针对不同的日志文件设置不同的频率(每日或每周),具体取决于我们期望的日志大小。
使用 SSH 创建扩展支持包
如果您可以通过 SSH 访问 GitHub Enterprise Server 设备并具有出站互联网访问权限,则可以使用下列步骤来创建和共享扩展支持包。
-
要通过 SSH 下载扩展支持包,可将
-x
标记添加到ghe-support-bundle
命令中:$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o -x' > support-bundle.tgz
-
访问 https://enterprise.github.com/support 并登录(如果提示)。
-
访问 https://enterprise.github.com/support/bundles/new 并上传您的支持包。
使用 SSH 直接上传扩展支持包
在以下情况下您可以直接将支持包上传到我们的服务器:
- 您可以通过 SSH 访问 GitHub Enterprise Server 设备。
- 允许从 GitHub Enterprise Server 设备通过 TCP 端口 443 建立出站 HTTPS 连接。
-
将包上传到我们的支持包服务器:
$ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x'