Skip to main content

此版本的 GitHub Enterprise Server 将于以下日期停止服务 2023-12-20. 即使针对重大安全问题,也不会发布补丁。 为了获得更好的性能、更高的安全性和新功能,请升级到最新版本的 GitHub Enterprise。 如需升级帮助,请联系 GitHub Enterprise 支持

站点管理员仪表板

You can use the site admin dashboard to manage users, organizations, and repositories on your GitHub Enterprise Server instance.

要访问仪表板,请在任意页面的右上角中单击

探究

将按每天、每周和每月的时间跨度为存储库和开发者计算 GitHub 趋势页中的数据。 在“浏览”部分中,可以看到此数据的最后缓存时间,并将新的趋势计算作业加入队列。

审核日志

GitHub Enterprise Server 会实时记录你可以查询的审核操作。

默认情况下,审核日志会按时间倒序显示所有已审核操作的列表。 要对此列表进行筛选,可以在“查询”文本框中输入键值对,然后单击“搜索”,如“搜索企业的审核日志”所述 。

有关审核日志记录的一般信息,请参阅“关于企业的审核日志”。 有关已审核操作的完整列表,请参阅“企业的审核日志事件”。

报表

如果需要获取关于 你的 GitHub Enterprise Server 实例 中用户、组织和存储库的信息,正常情况下,可通过 GitHub API 提取 JSON 数据。 但遗憾的是,此 API 可能无法提供您需要的所有数据,并且需要一定的专业技术知识才能使用。 站点管理员仪表板提供“报表”部分来代替,使你可以轻松下载 CSV 报告,其中包含大部分你可能需要的用于用户、组织和存储库的信息。

具体来讲,您可以下载列出以下信息的 CSV 报告:

  • 所有用户
  • 所有活跃用户
  • 所有休眠用户
  • 曾被挂起的所有用户
  • 所有组织
  • 所有仓库

您还可以通过向站点管理员帐户进行标准 HTTP 身份验证,以编程方式访问这些报告。 必须使用具有 site_admin 范围的 personal access token。 有关详细信息,请参阅“管理个人访问令牌”。

下面是如何使在 curl 命令中下载“所有用户”报告的示例:

curl --remote-name \
     --location \
     --user 'USERNAME:TOKEN' \
     http(s)://HOSTNAME/stafftools/reports/all_users.csv

若要以编程方式访问其他报告,请将 all_users 替换为 active_usersdormant_userssuspended_usersall_organizationsall_repositories

注意:如果没有可用的缓存报告,最初的 curl 请求会返回 202 HTTP 响应;将在后台生成报告。 您可以发送另一个请求来下载报告。 可以使用作用域为 site_admin 的密码或 OAuth 令牌代替密码。

用户报告

密钥说明
created_at用户帐户的创建时间(ISO 8601 时间戳形式)
id用户或组织的帐户 ID
login帐户的登录名称
email帐户的主电子邮件地址
role帐户属于管理员还是普通用户
suspended?帐户是否已挂起
last_logged_ip最近登录帐户的 IP 地址
repos帐户拥有的仓库数量
ssh_keys注册到帐户的 SSH 密钥数量
org_memberships帐户所属的组织数量
dormant?帐户是否休眠
last_active帐户上次活动时间(ISO 8601 时间戳形式)
raw_login原始登录信息(JSON 格式)
2fa_enabled?用户是否已启用双重身份验证

组织报告

密钥说明
id组织 ID
created_at组织创建时间
login组织的登录名称
email组织的主电子邮件地址
owners组织所有者数量
members组织成员数量
teams组织团队数量
repos组织仓库数量
2fa_required?组织是否需要双重身份验证

仓库报告

密钥说明
created_at仓库创建时间
owner_id仓库所有者的 ID
owner_type仓库由用户所有还是由组织所有
owner_name仓库所有者的名称
id仓库 ID
name存储库名称
visibility仓库是公共还是私有
readable_size以人类可读格式表示的仓库大小
raw_size以数字形式表示的仓库大小
collaborators仓库协作者数量
fork?仓库是否为分叉
deleted?仓库是否已删除

索引

GitHub 的搜索功能由 Elasticsearch 提供支持。 站点管理员仪表板的这一部分会显示 Elasticsearch 群集的当前状态,并提供多种工具来控制搜索和索引行为。

有关代码搜索的详细信息,请参阅“在 GitHub 上搜索文档”。 有关 Elasticsearch 的详细信息,请参阅 Elasticsearch 网站

注意:正常使用时,站点管理员无需创建新索引或计划修复作业。 出于故障排除或其他支持用途,GitHub 支持 可能会指示你运行修复作业。

索引管理

GitHub Enterprise Server 会定期自动与实例上的数据协调搜索索引的状态。

  • 数据库中的问题、拉取请求、存储库和用户
  • 磁盘上的 Git 存储库(源代码)

实例使用修复作业协调数据,并计划在发生以下事件时在后台执行修复作业。

  • 创建新的搜索索引。
  • 需要回填缺失的数据。
  • 需要更新旧的搜索数据。

可以创建新索引,也可以单击列表中的现有索引以管理索引。 可以对索引执行下列操作。

  • 使索引可搜索。
  • 使索引可写。
  • 更新索引。
  • 删除索引
  • 重置索引修复状态。
  • 开始新的索引修复作业。
  • 启用或禁用索引修复作业。

进度栏会显示后台工作进程中修复作业的当前状态。 该栏是修复偏移与数据中最高记录 ID 的百分比差异。 可以在修复作业完成后忽略进度栏中显示的值。 进度栏显示修复偏移与数据库中最高记录 ID 之差,并且会随着更多存储库添加到 你的 GitHub Enterprise Server 实例 中而减小,即使这些存储库实际上已编制索引。

若要最大限度地减小对 I/O 性能的影响并减小操作超时的几率,请在非高峰时段运行修复作业。 当作业将搜索索引与数据库和 Git 存储库数据协调时,会使用一个 CPU。 使用类似于 top 的实用工具监视系统的负载平均值和 CPU 使用率。 如果未发现任何显著的资源消耗变化,那么在高峰时段运行索引修复作业也应当是安全的。

修复作业使用“修复偏移”实现并行化。 偏移是指协调的记录在数据库表中的偏移。 多个后台作业可以基于此偏移同步工作。

此类允许您启用或禁用对源代码进行的搜索和索引操作。

保留的登录名

某些词是保留给内部使用的 你的 GitHub Enterprise Server 实例,这意味着这些词不能用作用户名。

例如,保留以下词语,包括:

  • admin
  • enterprise
  • login
  • staff
  • support

对于完整列表或保留词,导航到站点管理面板中的“保留的登录名”。

休眠用户

在这里,你可以看到并取消 你的 GitHub Enterprise Server 实例 上的非活动用户。 有关详细信息,请参阅“挂起和取消挂起用户”。

以下情况下,会认定用户帐户处于非活动状态(“休眠”):

  • 存在时间长于为 你的 GitHub Enterprise Server 实例 设置的休眠阈值。
  • 在该时间段内没有发生任何活动。
  • 不是站点管理员。

休眠阈值是指用户必须多久不活动才被视为休眠。 默认休眠阈值是 90 天,但可以自定义 你的 GitHub Enterprise Server 实例 的休眠阈值。 有关详细信息,请参阅“管理休眠用户”。

已挂起的用户

可以在此查看 你的 GitHub Enterprise Server 实例 上被取消访问权限的所有用户,并发起 SSH 密钥审核