Linuxチートシート

これはGitLabサポートチームがLinuxに関する情報を集めたもので、トラブルシューティングの際に使用することがあります。透明性を保つため、またLinuxの経験があるユーザーのためにここに掲載しています。もし現在GitLabでイシューを抱えているのであれば、この情報を利用する前にまずサポートオプションを確認したほうがよいでしょう。

caution
GitLabサポートがシステム管理を支援する範囲を超えています。GitLab管理者は、選択したディストリビューションのこれらのコマンドを知っていることが期待されます。GitLabサポートエンジニアの方は、yum ->apt-get などを翻訳するためのクロスリファレンスとお考えください。

以下のコマンドのほとんどは、どのディストリビューションで動作するかラベル付けされていません。追加するための貢献を歓迎します。

システムコマンド

ディストリビューション情報 

# Debian/Ubuntu
uname -a
lsb_release -a

# CentOS/RedHat
cat /etc/centos-release
cat /etc/redhat-release

# This will provide a lot more information
cat /etc/os-release

シャットダウンまたは再起動 

shutdown -h now
reboot

権限 

# change the user:group ownership of a file/dir
chown root:git <file_or_dir>

# make a file executable
chmod u+x <file>

ファイルとディレクトリ 

# create a new directory and all subdirectories
mkdir -p dir/dir2/dir3

# Send a command's output to file.txt, no STDOUT
ls > file.txt

# Send a command's output to file.txt AND see it in STDOUT
ls | tee /tmp/file.txt

# Search and Replace within a file
sed -i 's/original-text/new-text/g' <filename>

設定されているすべての環境変数を見る 

env

検索

ファイル名 

# search for a file in a filesystem
find . -name 'filename.rb' -print

# locate a file
locate <filename>

# see command history
history

# search CLI history
<ctrl>-R

ファイル内容 

# -B/A = show 2 lines before/after search_term
grep -B 2 -A 2 search_term <filename>

# -<number> shows both before and after
grep -2 search_term <filename>

# Search on all files in directory (recursively)
grep -r search_term <directory>

# Grep namespace/project/name of a GitLab repository
grep 'fullpath' /var/opt/gitlab/git-data/repositories/@hashed/<repo hash>/.git/config

# search through *.gz files is the same except with zgrep
zgrep search_term <filename>

# Fast grep printing lines containing a string pattern
fgrep -R string_pattern <filename or directory>

CLI 

# View command history
history

# Run last command that started with 'his' (3 letters min)
!his

# Search through command history
<ctrl>-R


# Execute last command with sudo
sudo !!

リソースの管理

メモリ、ディスク、CPU使用率 

# disk space info. The '-h' gives the data in human-readable values
df -h

# size of each file/dir and its contents in the current dir
du -hd 1

# or alternative
du -h --max-depth=1

# find files greater than certain size(k, M, G) and list them in order
# get rid of the + for exact, - for less than
find / -type f -size +100M -print0 | xargs -0 du -hs | sort -h

# Find free memory on a system
free -m

# Find what processes are using memory/CPU and organize by it
# Load average is 1/CPU for 1, 5, and 15 minutes
top -o %MEM
top -o %CPU

追跡 

# strace a process
strace -tt -T -f -y -yy -s 1024 -p <pid>

# -tt   print timestamps with microsecond accuracy

# -T    print the time spent in each syscall

# -f    also trace any child processes that forked

# -y    print the path associated with file handles

# -yy    print socket and device file handle details

# -s    max string length to print for an event

# -o    output file

# run strace on all puma processes
ps auwx | grep puma | awk '{ print " -p " $2}' | xargs strace -tt -T -f -y -yy -s 1024 -o /tmp/puma.txt

straceを実行すると、システムのパフォーマンスに大きな影響を与える可能性があることに注意してください。

straceリソース

Strace Parser ツール

私たちのstrace-parserツールは、strace 出力の高レベルの要約を提供するために使用することができます。これはstrace -C に似ていますが、より詳細な統計情報を提供します。

MacOSとLinuxのバイナリが利用可能で、Rustコンパイラがあればソースからビルドすることもできます。

ツールの使い方

まずsummary フラグを付けてツールを実行すると、 タスクの実行に費やされた時間でソートされた上位プロセスの概要が表示されます。-s または--sort フラグを使うと、 総時間、システムコールの回数、PID #、子プロセスの数でソートすることもできます。結果の数のデフォルトは 25 プロセスですが、-c/--count オプションで変更できます。詳細は--help を参照。

$ ./strace-parser sidekiq_trace.txt summary -c15 -s=pid

Top 15 PIDs by PID #
-----------

  pid         actv (ms)     wait (ms)     user (ms)    total (ms)    % of actv     syscalls     children
  -------    ----------    ----------    ----------    ----------    ---------    ---------    ---------
  16706           0.000         0.000         0.000         0.000        0.00%            0            0
  16708           0.000         0.000         0.000         0.000        0.00%            0            0
  16716           0.000         0.000         0.000         0.000        0.00%            0            0
  16717           0.000         0.000         0.000         0.000        0.00%            0            0
  16718           0.000         0.000         0.000         0.000        0.00%            0            0
  16719           0.000         0.000         0.000         0.000        0.00%            0            0
  16720           0.389      9796.434         1.090      9797.912        0.02%           16            0
  16721           0.000         0.000         0.000         0.000        0.00%            0            0
  16722           0.000         0.000         0.000         0.000        0.00%            0            0
  16723           0.000         0.000         0.000         0.000        0.00%            0            0
  16804           0.218     11099.535         1.881     11101.634        0.01%           36            0
  16813           0.000         0.000         0.000         0.000        0.00%            0            0
  16814           1.740     11825.640         4.616     11831.996        0.10%           57            0
  16815           2.364     12039.993         7.669     12050.026        0.14%           80            0
  16816           0.000         0.000         0.000         0.000        0.00%            0            0

PIDs   93
real   0m12.287s
user   0m1.474s
sys    0m1.686s

要約に基づき、特定のプロセスに対しては-p/--pid を、--stats ソートされたリストに対しては --stats -s/--stats フラグを --stats使用して、 1 つ以上のプロセスによって行われたシステムコールの詳細を見ることができます--stats 。 --stats

./strace-parser sidekiq_trace.txt p 16815

PID 16815

  80 syscalls, active time: 2.364ms, user time: 7.669ms, total time: 12050.026ms
  start time: 22:46:14.830267    end time: 22:46:26.880293

  syscall                 count    total (ms)      max (ms)      avg (ms)      min (ms)    errors
  -----------------    --------    ----------    ----------    ----------    ----------    --------
  futex                       5     10100.229      5400.106      2020.046         0.022    ETIMEDOUT: 2
  restart_syscall             1      1939.764      1939.764      1939.764      1939.764    ETIMEDOUT: 1
  getpid                     33         1.020         0.046         0.031         0.018
  clock_gettime              14         0.420         0.038         0.030         0.021
  stat                        6         0.277         0.072         0.046         0.031
  read                        6         0.170         0.036         0.028         0.020
  openat                      3         0.126         0.045         0.042         0.038
  close                       3         0.099         0.034         0.033         0.031
  lseek                       3         0.089         0.035         0.030         0.021
  ioctl                       3         0.082         0.033         0.027         0.023    ENOTTY: 3
  fstat                       3         0.081         0.034         0.027         0.022
  ---------------

  Slowest file open times for PID 16815:

    dur (ms)       timestamp            error         file name
  ----------    ---------------    ---------------    ---------
       0.045    22:46:16.771318           -           /opt/gitlab/embedded/service/gitlab-rails/config/database.yml
       0.043    22:46:26.877954           -           /opt/gitlab/embedded/service/gitlab-rails/config/database.yml
       0.038    22:46:22.174610           -           /opt/gitlab/embedded/service/gitlab-rails/config/database.yml

上の例では、どのファイルがPID 16815 で開くのに時間がかかったかを見ることができます。

結果に目立ったものがない場合、より多くのコンテキストを得るための良い方法は、顧客が実行したアクションを実行しながら自分の GitLab インスタンスでstrace を実行し、両方の結果のサマリーを比較して違いを調べることです。

オープン・システムコールの統計

様々な設定におけるopen とopenat (ファイルへのアクセスに使用) への呼び出しの大まかな数値です。遅いストレージはGitalyで恐ろしいDeadlineExceeded エラーの原因となります。

また、ファイルシステムのパフォーマンスをチェックするための簡単なテストについては、ハンドブックのこのエントリを参照してください。

strace からのタイミング情報は、やや不正確であることが多いので、わずかな違いは重要でないと考えてください。

セットアップアクセス時間
イーエフエス10 - 30 ms
ローカルストレージ0.01 - 1 ms

ネットワーキング

ポート 

# Find the programs that are listening on ports
netstat -plnt
ss -plnt
lsof -i -P | grep <port>

インターネット/DNS 

# Show domain IP address
dig +short example.com
nslookup example.com

# Check DNS using specific nameserver
# 8.8.8.8 = google, 1.1.1.1 = cloudflare, 208.67.222.222 = opendns
dig @8.8.8.8 example.com
nslookup example.com 1.1.1.1

# Find host provider
whois <ip_address> | grep -i "orgname\|netname"

# Curl headers with redirect
curl --head --location "https://example.com"

# Test if a host is reachable on the network. `ping6` works on IPv6 networks.
ping example.com

# Show the route taken to a host. `traceroute6` works on IPv6 networks.
traceroute example.com
mtr example.com

# List details of network interfaces
ip address

# Check local DNS settings
cat /etc/hosts
cat /etc/resolv.conf
systemd-resolve --status

# Capture traffic to/from a host
sudo tcpdump host www.example.com

パッケージ管理 

# Debian/Ubuntu

# List packages
dpkg -l
apt list --installed

# Find an installed package
dpkg -l | grep <package>
apt list --installed | grep <package>

# Install a package
dpkg -i <package_name>.deb
apt-get install <package>
apt install <package>

# CentOS/RedHat

# Install a package
yum install <package>
dnf install <package> # RHEL/CentOS 8+

rpm -ivh <package_name>.rpm

# Find an installed package
rpm -qa | grep <package>

ログ 

# Print last lines in log file where 'n'
# is the number of lines to print
tail -n /path/to/log/file