Skip to content

Diagnostics tools

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab Self-Managed

The GitLab Support team uses these diagnostics tools during troubleshooting. They are listed here for transparency, and for users with GitLab troubleshooting experience.

If you have an issue with GitLab, you might want to check your support options before attempting to use these tools.

SOS scripts

Version history

  • Bundling of gitlabsos with the Linux package and Docker image introduced in GitLab 18.3.

  • gitlabsos gathers information and recent logs from a Linux package or Docker-based GitLab instance and its operating system.

    sudo gitlabsos

  • kubesos gathers Kubernetes cluster configuration and recent logs from a GitLab Helm chart deployment.

  • gitlab:db:sos gathers detailed diagnostic data about your database.

strace-parser

strace-parser analyzes and summarizes raw strace data. The strace zine is recommended for context.

gitlabrb_sanitizer

gitlabrb_sanitizer outputs a copy of /etc/gitlab/gitlab.rb content with sensitive values redacted.

gitlabsos automatically uses gitlabrb_sanitizer to sanitize the configuration.

fast-stats

Version history

  • Bundling of fast-stats with the Linux package and Docker image introduced in GitLab 18.3.

To help debug performance and configuration problems, fast-stats summarizes errors and resource-intensive usage statistics quickly.

Use fast-stats to parse and compare large volumes of logs, or to start troubleshooting unknown problems.

/opt/gitlab/embedded/bin/fast-stats

greenhat

greenhat provides an interactive shell to analyze, filter, and summarize SOS logs.

GitLab Detective

GitLab Detective runs automated checks on a GitLab instance to identify and resolve common issues.