作业日志

作业日志由 runner 在处理作业时发送。您可以在作业页面、流水线、电子邮件通知等中查看日志。

数据流

一般来说，作业日志有两种状态：log 和 archived log。 在下表中，您可以看到日志经历的阶段：

阶段 状态 环境 数据流 存储路径
1: patching log 作业运行时 Runner => Puma => 文件存储 #{ROOT_PATH}/gitlab-ci/builds/#{YYYY_mm}/#{project_id}/#{job_id}.log
2: archiving archived log 作业已完成 Sidekiq 将日志移动到产物文件夹 #{ROOT_PATH}/gitlab-rails/shared/artifacts/#{disk_hash}/#{YYYY_mm_dd}/#{job_id}/#{job_artifact_id}/job.log
3: uploading archived log 日志已归档 Sidekiq 将归档日志移动到对象存储（如果已配置） #{bucket_name}/#{disk_hash}/#{YYYY_mm_dd}/#{job_id}/#{job_artifact_id}/job.log

每个环境的 ROOT_PATH 变量为：

  • 对 Linux 软件包安装的实例，值为 /var/opt/gitlab。
  • 对源代码编译安装的实例，值为 /home/git/gitlab。

更改作业日志本地位置

note 对于 Docker 安装实例，您可以更改装载数据的路径。对于 Helm 安装实例，使用对象存储。

要更改作业日志的存储位置：

Omnibus

  1. 可选。如果您有现有的作业日志，请通过暂时停止 Sidekiq 来暂停持续集成数据处理：

    sudo gitlab-ctl stop sidekiq

  2. 在 /etc/gitlab/gitlab.rb 中设置新的存储位置：

    gitlab_ci['builds_directory'] = '/mnt/gitlab-ci/builds'

  3. 保存文件并重新配置极狐GitLab。

    sudo gitlab-ctl reconfigure

  4. 使用 rsync 将作业日志从当前位置移动到新位置：

    sudo rsync -avzh --remove-source-files --ignore-existing --progress /var/opt/gitlab/gitlab-ci/builds/ /mnt/gitlab-ci/builds/

    使用 --ignore-existing 这样就不会用旧版本的相同日志覆盖新的作业日志。

  5. 如果您选择了暂停持续集成数据处理，您可以重新启动 Sidekiq：

    sudo gitlab-ctl start sidekiq

  6. 删除旧的作业日志存储位置：

    sudo rm -rf /var/opt/gitlab/gitlab-ci/builds`

源安装

  1. 可选。如果您有现有的作业日志，请通过暂时停止 Sidekiq 来暂停持续集成数据处理：

    # For systems running systemd
sudo systemctl stop gitlab-sidekiq

# For systems running SysV init
sudo service gitlab stop

  2. 编辑 /home/git/gitlab/config/gitlab.yml，设置新的存储位置。

    production: &base
  gitlab_ci:
    builds_path: /mnt/gitlab-ci/builds

  3. 保存文件并重启极狐GitLab：

    # For systems running systemd
sudo systemctl restart gitlab.target

# For systems running SysV init
sudo service gitlab restart

  4. 使用 rsync 将作业日志从当前位置移动到新位置：

    sudo rsync -avzh --remove-source-files --ignore-existing --progress /home/git/gitlab/builds/ /mnt/gitlab-ci/builds/

    使用 --ignore-existing 这样您就不会用同一日志的旧版本覆盖新的作业日志。

  5. 如果您选择了暂停持续集成数据处理，您可以重新启动 Sidekiq：

    # For systems running systemd
sudo systemctl start gitlab-sidekiq

# For systems running SysV init
sudo service gitlab start

  6. 删除旧的作业日志存储位置：

    sudo rm -rf /home/git/gitlab/builds

将日志上传到对象存储

归档日志被视为作业产物。 因此，当您设置对象存储集成时，作业日志会与其他作业产物一起自动迁移到其上。

查看数据流中的 “Phase 3: uploading” 了解流程。

Maximum log file size

极狐GitLab 中，作业日志文件的默认大小为 100MB。任何超过此限制的作业都会被标记为失败，并被 Runner 丢弃。更多详情，可以查看作业日志的最大文件大小。

防止使用本地磁盘

如果要避免作业日志使用任何本地磁盘，可以使用以下选项之一：

如何删除作业日志

没有办法让旧的作业日志自动过期，但如果它们占用太多空间，可以安全地删除它们。如果手动删除日志，则 UI 中的作业输出为空。

例如，要删除超过 60 天的所有作业日志，请从极狐GitLab 实例中的 shell 运行以下命令：

note 对于 Helm chart，请使用对象存储随附的存储管理工具。
caution 以下命令将永久删除日志文件且不可逆。

Omnibus

find /var/opt/gitlab/gitlab-rails/shared/artifacts -name "job.log" -mtime +60 -delete

Docker

假设您将 /var/opt/gitlab 挂载到 /srv/gitlab：

find /srv/gitlab/gitlab-rails/shared/artifacts -name "job.log" -mtime +60 -delete

源安装

find /home/git/gitlab/shared/artifacts -name "job.log" -mtime +60 -delete

删除日志后，您可以通过运行检查上传文件的完整性的 Rake 任务，找到任何损坏的文件引用。 有关详细信息，请参阅如何删除对缺失产物的引用。

增量日志架构

  • 要在私有化部署实例中使用此功能，寻求管理员的帮助，让其启用此功能。

默认情况下，作业日志以块的形式从极狐GitLab Runner 发送，临时缓存在磁盘上。作业完成后，后台作业会归档作业日志。日志默认移动到产物目录，或者已配置的对象存储上。

在一个横向扩展架构中，Rails 和 Sidekiq 运行在多个服务器上，文件系统上的这两个位置必须使用 NFS 共享，只不是推荐用法，替代方法为：

  1. 配置对象存储用于存储归档作业日志。
  2. 启用增量日志功能，它使用 Redis 代替磁盘空间来临时缓存作业日志。

启用或禁用增量日志

在启用功能标志之前：

要启用增量日志记录：

  1. 打开 Rails 控制台。

  2. 启用功能标志：

    Feature.enable(:ci_enable_live_trace)

    运行作业的日志会继续写入磁盘，但新作业使用增量日志记录。

要禁用增量日志记录：

  1. 打开 Rails 控制台。

  2. 禁用功能标志：

    Feature.disable(:ci_enable_live_trace)

    正在运行的作业继续使用增量日志记录，但新作业会写入磁盘。

技术细节

数据流与数据流部分中描述的相同，有一个变化：前两个阶段的存储路径不同。这种增量日志架构将日志块存储在 Redis 和持久存储（对象存储或数据库）中，而不是文件存储中。Redis 用作一流的存储，它可以存储高达 128KB 的数据。发送完整块后，将其刷新到持久存储，对象存储（临时目录）或数据库。 过了一会儿，Redis 中的数据和一个持久化存储被归档到对象存储。

数据存储在以下 Redis 命名空间中：Gitlab::Redis::TraceChunks。

下面是详细的数据流：

  1. Runner 从极狐GitLab 中挑选一个作业
  2. Runner 向极狐GitLab 发送一条日志
  3. 极狐GitLab 将数据追加到 Redis
  4. Redis 中的数据达到128KB 后，将数据刷新到持久化存储（对象存储或数据库）中。
  5. 重复以上步骤，直到作业完成。
  6. 作业完成后，极狐GitLab 会安排一个 Sidekiq worker 来归档日志。
  7. Sidekiq worker 将日志归档到对象存储并清理 Redis 和持久存储（对象存储或数据库）中的日志。

限制

  • 不支持 Redis 集群
  • 在启用功能标志之前，您必须配置 CI/CD 产物、日志和构建的对象存储。启用该标志后，将无法将文件写入磁盘，并且无法防止配置错误。
  • 有一个史诗跟踪其他潜在的限制和改进